linux-kernel - Re: [PATCH] docs: Activate xeCJK only in CJK chapters

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20210522201439.156bded8@coco.lan>
Date:   Sat, 22 May 2021 20:14:39 +0200
From:   Mauro Carvalho Chehab <mchehab@...nel.org>
To:     Akira Yokosawa <akiyks@...il.com>
Cc:     Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] docs: Activate xeCJK only in CJK chapters

Em Sat, 22 May 2021 16:28:55 +0900
Akira Yokosawa <akiyks@...il.com> escreveu:

> Activating xeCJK in English or 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 embedded in translations.tex after the fact.
>       By default, xeCJK is inactive.
> 
>     o Add a script retouch-translations.sh to embed the on/off
>       macros in translations.tex where necessary.
>       The patterns in the script are ad-hoc by nature, and will
>       need updates when the chapter organization changes.
> 
>     o Invoke the script at the final step of target "latexdocs".

Interesting solution, but there are probably an easy/better
way of doing something similar to it.

There is an extension called:

	Documentation/sphinx/load_config.py

Which allows using a per-document conf.py file. While it can also be
used to have a "nitpick" version where extra warnings are enabled,
the main usage were to have separated PDF documents. 

We ended finding a better solution, so most conf.py got removed
on this patch: 9fc3a18a942f ("docs: remove extra conf.py files").

Anyway, perhaps we could simply add a Documentation/translations/conf.py
that would add the CJK font only there.

Even better, we could even improve it in a way that each translation
would generate a separated book, and then use CJK only for the
non-Latin translations.

Regards,
Mauro