iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
1382999aa0
linux/Documentation/translations/index.rst

60 lines
2.1 KiB
ReStructuredText
Raw Normal View History

doc: move away translations from top-level index In translations/ we have now a dedicated index.rst where we add/remove references to translations. Translations are in English alphabetical order. Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2018-06-06 01:49:00 +03:00
.. _translations:
============
Translations
============
doc: minor fixes to translation's disclaimer - move TOC on top because that's the most interesting part - a couple of minor fixes Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-03-23 20:54:16 +03:00
.. toctree::
:maxdepth: 1
zh_CN/index
docs: add traditional Chinese translation for kernel Documentation Add traditional Chinese translation (zh_TW) for the Linux Kernel documentation with a series of translated files. Signed-off-by: Hu Haowen <src.res@email.cn> Reviewed-by: Pan Yunwang <panyunwang849@gmail.com> Link: https://lore.kernel.org/r/20210729155627.41744-1-src.res@email.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-07-29 18:56:25 +03:00
zh_TW/index
doc: minor fixes to translation's disclaimer - move TOC on top because that's the most interesting part - a couple of minor fixes Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-03-23 20:54:16 +03:00
it_IT/index
ko_KR/index
ja_JP/index
Documentation: Start translations to Spanish Start the process of translating kernel documentation to Spanish. Create directory sp_SP/ instead of es_ES/ (diverging from format of prior translated directories) since this directory should accept any dialects of Spanish. Include an index and a disclaimer, following the approach of prior translations. Add Carlos Bilbao as MAINTAINER of this effort. Reviewed-by: Miguel Ojeda <ojeda@kernel.org> Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com> Link: https://lore.kernel.org/r/20221024145521.69465-2-carlos.bilbao@amd.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-10-24 17:55:20 +03:00
sp_SP/index
doc: minor fixes to translation's disclaimer - move TOC on top because that's the most interesting part - a couple of minor fixes Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-03-23 20:54:16 +03:00
doc: add translation disclaimer Add the translation disclaimer in English as reference for other languages. Translations must include this disclaimer in their language so that readers are properly informed. This very same patch updates the Italian translation accordingly. Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it> Acked-by: Alex Shi <alex.shi@linux.alibaba.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-03-14 23:45:16 +03:00
.. _translations_disclaimer:
Disclaimer
----------
docs: Activate exCJK only in CJK chapters 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>
2021-05-25 18:25:39 +03:00
.. raw:: latex
\kerneldocCJKoff
doc: minor fixes to translation's disclaimer - move TOC on top because that's the most interesting part - a couple of minor fixes Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-03-23 20:54:16 +03:00
Translation's purpose is to ease reading and understanding in languages other
doc: add translation disclaimer Add the translation disclaimer in English as reference for other languages. Translations must include this disclaimer in their language so that readers are properly informed. This very same patch updates the Italian translation accordingly. Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it> Acked-by: Alex Shi <alex.shi@linux.alibaba.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-03-14 23:45:16 +03:00
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
doc: minor fixes to translation's disclaimer - move TOC on top because that's the most interesting part - a couple of minor fixes Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-03-23 20:54:16 +03:00
comfortable writing in English, you can ask the translation's maintainers
for help.
Reference in New Issue Copy Permalink