f7ebe6b769
Activating xeCJK in English and Italian-translation documents
results in sub-optimal typesetting with wide-looking apostrophes
and quotation marks.
The xeCJK package provides macros for enabling and disabling its
effect in the middle of a document, namely \makexeCJKactive and
\makexeCJKinactive.
So the goal of this change is to activate xeCJK in the relevant
chapters in translations.
To do this:
o Define custom macros in the preamble depending on the
availability of the "Noto Sans CJK" font so that those
macros can be used regardless of the use of xeCJK package.
o Patch \sphinxtableofcontents so that xeCJK is inactivated
after table of contents.
o Embed those custom macros in each language's index.rst file
as a ".. raw:: latex" construct.
Note: A CJK chapter needs \kerneldocCJKon in front of its chapter
heading, while a non-CJK chapter should have \kerneldocCJKoff
below its chapter heading.
This is to make sure the CJK font is available to CJK chapter's
heading and ending page's footer.
Tested against Sphinx versions 2.4.4 and 4.0.2.
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Tested-by: Wu XiangCheng <bobwxc@email.cn>
Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/lkml/2061da0a-6ab1-35f3-99c1-dbc415444f37@gmail.com
Link: https://lore.kernel.org/r/83208ddc-5de9-b283-3fd6-92c635348ca0@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
58 lines
2.1 KiB
ReStructuredText
58 lines
2.1 KiB
ReStructuredText
.. _translations:
|
|
|
|
============
|
|
Translations
|
|
============
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
zh_CN/index
|
|
it_IT/index
|
|
ko_KR/index
|
|
ja_JP/index
|
|
|
|
|
|
.. _translations_disclaimer:
|
|
|
|
Disclaimer
|
|
----------
|
|
|
|
.. raw:: latex
|
|
|
|
\kerneldocCJKoff
|
|
|
|
Translation's purpose is to ease reading and understanding in languages other
|
|
than English. Its aim is to help people who do not understand English or have
|
|
doubts about its interpretation. Additionally, some people prefer to read
|
|
documentation in their native language, but please bear in mind that the
|
|
*only* official documentation is the English one: :ref:`linux_doc`.
|
|
|
|
It is very unlikely that an update to :ref:`linux_doc` will be propagated
|
|
immediately to all translations. Translations' maintainers - and
|
|
contributors - follow the evolution of the official documentation and they
|
|
maintain translations aligned as much as they can. For this reason there is
|
|
no guarantee that a translation is up to date. If what you read in a
|
|
translation does not sound right compared to what you read in the code, please
|
|
inform the translation maintainer and - if you can - check also the English
|
|
documentation.
|
|
|
|
A translation is not a fork of the official documentation, therefore
|
|
translations' users should not find information that differs from the official
|
|
English documentation. Any content addition, removal or update, must be
|
|
applied to the English documents first. Afterwards and when possible, the
|
|
same change should be applied to translations. Translations' maintainers
|
|
accept only contributions that are merely translation related (e.g. new
|
|
translations, updates, fixes).
|
|
|
|
Translations try to be as accurate as possible but it is not possible to map
|
|
one language directly to all other languages. Each language has its own
|
|
grammar and culture, so the translation of an English statement may need to be
|
|
adapted to fit a different language. For this reason, when viewing
|
|
translations, you may find slight differences that carry the same message but
|
|
in a different form.
|
|
|
|
If you need to communicate with the Linux community but you do not feel
|
|
comfortable writing in English, you can ask the translation's maintainers
|
|
for help.
|