1 % -*- coding: utf-8 -*- 1 % -*- coding: utf-8 -*-
2 % SPDX-License-Identifier: GPL-2.0 2 % SPDX-License-Identifier: GPL-2.0
3 % 3 %
4 % LaTeX preamble for "make latexdocs" or "make 4 % LaTeX preamble for "make latexdocs" or "make pdfdocs" including:
5 % - TOC width settings 5 % - TOC width settings
6 % - Setting of tabulary (\tymin) 6 % - Setting of tabulary (\tymin)
7 % - Headheight setting for fancyhdr 7 % - Headheight setting for fancyhdr
8 % - Fontfamily settings for CJK (Chinese, Ja 8 % - Fontfamily settings for CJK (Chinese, Japanese, and Korean) translations
9 % 9 %
10 % Note on the suffix of .sty: 10 % Note on the suffix of .sty:
11 % This is not implemented as a LaTeX style f 11 % This is not implemented as a LaTeX style file, but as a file containing
12 % plain LaTeX code to be included into pream 12 % plain LaTeX code to be included into preamble.
13 % ".sty" is chosen because ".tex" would caus 13 % ".sty" is chosen because ".tex" would cause the build scripts to confuse
14 % this file with a LaTeX main file. 14 % this file with a LaTeX main file.
15 % 15 %
16 % Copyright (C) 2022 Akira Yokosawa 16 % Copyright (C) 2022 Akira Yokosawa
17 17
18 % Custom width parameters for TOC 18 % Custom width parameters for TOC
19 % - Redefine low-level commands defined in re 19 % - Redefine low-level commands defined in report.cls.
20 % - Indent of 2 chars is preserved for ease o 20 % - Indent of 2 chars is preserved for ease of comparison.
21 % Summary of changes from default params: 21 % Summary of changes from default params:
22 % Width of page number (\@pnumwidth): 1.55em 22 % Width of page number (\@pnumwidth): 1.55em -> 2.7em
23 % Width of chapter number: 1.5em !! 23 % Width of chapter number: 1.5em -> 1.8em
24 % Indent of section number: 1.5em !! 24 % Indent of section number: 1.5em -> 1.8em
25 % Width of section number: 2.6em 25 % Width of section number: 2.6em -> 3.2em
26 % Indent of subsection number: 4.1em !! 26 % Indent of sebsection number: 4.1em -> 5em
27 % Width of subsection number: 3.5em 27 % Width of subsection number: 3.5em -> 4.3em
28 % 28 %
29 % These params can have 4 digit page counts, 3 !! 29 % These params can have 4 digit page counts, 2 digit chapter counts,
30 % section counts of 4 digits + 1 period (e.g., 30 % section counts of 4 digits + 1 period (e.g., 18.10), and subsection counts
31 % of 5 digits + 2 periods (e.g., 18.7.13). 31 % of 5 digits + 2 periods (e.g., 18.7.13).
32 \makeatletter 32 \makeatletter
33 %% Redefine \@pnumwidth (page number width) 33 %% Redefine \@pnumwidth (page number width)
34 \renewcommand*\@pnumwidth{2.7em} 34 \renewcommand*\@pnumwidth{2.7em}
35 %% Redefine \l@chapter (chapter list entry) 35 %% Redefine \l@chapter (chapter list entry)
36 \renewcommand*\l@chapter[2]{% 36 \renewcommand*\l@chapter[2]{%
37 \ifnum \c@tocdepth >\m@ne 37 \ifnum \c@tocdepth >\m@ne
38 \addpenalty{-\@highpenalty}% 38 \addpenalty{-\@highpenalty}%
39 \vskip 1.0em \@plus\p@ 39 \vskip 1.0em \@plus\p@
40 \setlength\@tempdima{2.4em}% !! 40 \setlength\@tempdima{1.8em}%
41 \begingroup 41 \begingroup
42 \parindent \z@ \rightskip \@pnumwidth 42 \parindent \z@ \rightskip \@pnumwidth
43 \parfillskip -\@pnumwidth 43 \parfillskip -\@pnumwidth
44 \leavevmode \bfseries 44 \leavevmode \bfseries
45 \advance\leftskip\@tempdima 45 \advance\leftskip\@tempdima
46 \hskip -\leftskip 46 \hskip -\leftskip
47 #1\nobreak\hfil 47 #1\nobreak\hfil
48 \nobreak\hb@xt@\@pnumwidth{\hss #2% 48 \nobreak\hb@xt@\@pnumwidth{\hss #2%
49 \kern-\p@\ker 49 \kern-\p@\kern\p@}\par
50 \penalty\@highpenalty 50 \penalty\@highpenalty
51 \endgroup 51 \endgroup
52 \fi} 52 \fi}
53 %% Redefine \l@section and \l@subsection 53 %% Redefine \l@section and \l@subsection
54 \renewcommand*\l@section{\@dottedtocline{1}{2. !! 54 \renewcommand*\l@section{\@dottedtocline{1}{1.8em}{3.2em}}
55 \renewcommand*\l@subsection{\@dottedtocline{2} !! 55 \renewcommand*\l@subsection{\@dottedtocline{2}{5em}{4.3em}}
56 \makeatother 56 \makeatother
57 %% Prevent default \sphinxtableofcontentshook !! 57 %% Sphinx < 1.8 doesn't have \sphinxtableofcontentshook
>> 58 \providecommand{\sphinxtableofcontentshook}{}
>> 59 %% Undefine it for compatibility with Sphinx 1.7.9
58 \renewcommand{\sphinxtableofcontentshook}{} % 60 \renewcommand{\sphinxtableofcontentshook}{} % Empty the hook
59 61
60 % Prevent column squeezing of tabulary. \tymi 62 % Prevent column squeezing of tabulary. \tymin is set by Sphinx as:
61 % \setlength{\tymin}{3\fontcharwd\font`0 } 63 % \setlength{\tymin}{3\fontcharwd\font`0 }
62 % , which is too short. 64 % , which is too short.
63 \setlength{\tymin}{20em} 65 \setlength{\tymin}{20em}
64 66
65 % Adjust \headheight for fancyhdr 67 % Adjust \headheight for fancyhdr
66 \addtolength{\headheight}{1.6pt} 68 \addtolength{\headheight}{1.6pt}
67 \addtolength{\topmargin}{-1.6pt} 69 \addtolength{\topmargin}{-1.6pt}
68 70
69 % Translations have Asian (CJK) characters whi 71 % Translations have Asian (CJK) characters which are only displayed if
70 % xeCJK is used 72 % xeCJK is used
71 \usepackage{ifthen} <<
72 \newboolean{enablecjk} <<
73 \setboolean{enablecjk}{false} <<
74 \IfFontExistsTF{Noto Sans CJK SC}{ 73 \IfFontExistsTF{Noto Sans CJK SC}{
75 \IfFileExists{xeCJK.sty}{ !! 74 % Load xeCJK when CJK font is available
76 \setboolean{enablecjk}{true} <<
77 }{} <<
78 }{} <<
79 \ifthenelse{\boolean{enablecjk}}{ <<
80 % Load xeCJK when both the Noto Sans CJK f <<
81 \usepackage{xeCJK} 75 \usepackage{xeCJK}
82 % Noto CJK fonts don't provide slant shape 76 % Noto CJK fonts don't provide slant shape. [AutoFakeSlant] permits
83 % its emulation. 77 % its emulation.
84 % Select KR variant at the beginning of ea 78 % Select KR variant at the beginning of each document so that quotation
85 % and apostorph symbols of half-width is u 79 % and apostorph symbols of half-width is used in TOC of Latin documents.
86 \IfFontExistsTF{Noto Serif CJK KR}{ 80 \IfFontExistsTF{Noto Serif CJK KR}{
87 \setCJKmainfont{Noto Serif CJK KR}[Aut 81 \setCJKmainfont{Noto Serif CJK KR}[AutoFakeSlant]
88 }{ 82 }{
89 \setCJKmainfont{Noto Sans CJK KR}[Auto 83 \setCJKmainfont{Noto Sans CJK KR}[AutoFakeSlant]
90 } 84 }
91 \setCJKsansfont{Noto Sans CJK KR}[AutoFake 85 \setCJKsansfont{Noto Sans CJK KR}[AutoFakeSlant]
92 \setCJKmonofont{Noto Sans Mono CJK KR}[Aut 86 \setCJKmonofont{Noto Sans Mono CJK KR}[AutoFakeSlant]
93 % Teach xeCJK of half-width symbols 87 % Teach xeCJK of half-width symbols
94 \xeCJKDeclareCharClass{HalfLeft}{`“,`‘ 88 \xeCJKDeclareCharClass{HalfLeft}{`“,`‘}
95 \xeCJKDeclareCharClass{HalfRight}{`”,` 89 \xeCJKDeclareCharClass{HalfRight}{`”,`’}
96 % CJK Language-specific font choices 90 % CJK Language-specific font choices
97 %% for Simplified Chinese 91 %% for Simplified Chinese
98 \IfFontExistsTF{Noto Serif CJK SC}{ 92 \IfFontExistsTF{Noto Serif CJK SC}{
99 \newCJKfontfamily[SCmain]\scmain{Noto 93 \newCJKfontfamily[SCmain]\scmain{Noto Serif CJK SC}[AutoFakeSlant]
100 \newCJKfontfamily[SCserif]\scserif{Not 94 \newCJKfontfamily[SCserif]\scserif{Noto Serif CJK SC}[AutoFakeSlant]
101 }{ 95 }{
102 \newCJKfontfamily[SCmain]\scmain{Noto 96 \newCJKfontfamily[SCmain]\scmain{Noto Sans CJK SC}[AutoFakeSlant]
103 \newCJKfontfamily[SCserif]\scserif{Not 97 \newCJKfontfamily[SCserif]\scserif{Noto Sans CJK SC}[AutoFakeSlant]
104 } 98 }
105 \newCJKfontfamily[SCsans]\scsans{Noto Sans 99 \newCJKfontfamily[SCsans]\scsans{Noto Sans CJK SC}[AutoFakeSlant]
106 \newCJKfontfamily[SCmono]\scmono{Noto Sans 100 \newCJKfontfamily[SCmono]\scmono{Noto Sans Mono CJK SC}[AutoFakeSlant]
107 %% for Traditional Chinese 101 %% for Traditional Chinese
108 \IfFontExistsTF{Noto Serif CJK TC}{ 102 \IfFontExistsTF{Noto Serif CJK TC}{
109 \newCJKfontfamily[TCmain]\tcmain{Noto 103 \newCJKfontfamily[TCmain]\tcmain{Noto Serif CJK TC}[AutoFakeSlant]
110 \newCJKfontfamily[TCserif]\tcserif{Not 104 \newCJKfontfamily[TCserif]\tcserif{Noto Serif CJK TC}[AutoFakeSlant]
111 }{ 105 }{
112 \newCJKfontfamily[TCmain]\tcmain{Noto 106 \newCJKfontfamily[TCmain]\tcmain{Noto Sans CJK TC}[AutoFakeSlant]
113 \newCJKfontfamily[TCserif]\tcserif{Not 107 \newCJKfontfamily[TCserif]\tcserif{Noto Sans CJK TC}[AutoFakeSlant]
114 } 108 }
115 \newCJKfontfamily[TCsans]\tcsans{Noto Sans 109 \newCJKfontfamily[TCsans]\tcsans{Noto Sans CJK TC}[AutoFakeSlant]
116 \newCJKfontfamily[TCmono]\tcmono{Noto Sans 110 \newCJKfontfamily[TCmono]\tcmono{Noto Sans Mono CJK TC}[AutoFakeSlant]
117 %% for Korean 111 %% for Korean
118 \IfFontExistsTF{Noto Serif CJK KR}{ 112 \IfFontExistsTF{Noto Serif CJK KR}{
119 \newCJKfontfamily[KRmain]\krmain{Noto 113 \newCJKfontfamily[KRmain]\krmain{Noto Serif CJK KR}[AutoFakeSlant]
120 \newCJKfontfamily[KRserif]\krserif{Not 114 \newCJKfontfamily[KRserif]\krserif{Noto Serif CJK KR}[AutoFakeSlant]
121 }{ 115 }{
122 \newCJKfontfamily[KRmain]\krmain{Noto 116 \newCJKfontfamily[KRmain]\krmain{Noto Sans CJK KR}[AutoFakeSlant]
123 \newCJKfontfamily[KRserif]\krserif{Not 117 \newCJKfontfamily[KRserif]\krserif{Noto Sans CJK KR}[AutoFakeSlant]
124 } 118 }
125 \newCJKfontfamily[KRsans]\krsans{Noto Sans 119 \newCJKfontfamily[KRsans]\krsans{Noto Sans CJK KR}[AutoFakeSlant]
126 \newCJKfontfamily[KRmono]\krmono{Noto Sans 120 \newCJKfontfamily[KRmono]\krmono{Noto Sans Mono CJK KR}[AutoFakeSlant]
127 %% for Japanese 121 %% for Japanese
128 \IfFontExistsTF{Noto Serif CJK JP}{ 122 \IfFontExistsTF{Noto Serif CJK JP}{
129 \newCJKfontfamily[JPmain]\jpmain{Noto 123 \newCJKfontfamily[JPmain]\jpmain{Noto Serif CJK JP}[AutoFakeSlant]
130 \newCJKfontfamily[JPserif]\jpserif{Not 124 \newCJKfontfamily[JPserif]\jpserif{Noto Serif CJK JP}[AutoFakeSlant]
131 }{ 125 }{
132 \newCJKfontfamily[JPmain]\jpmain{Noto 126 \newCJKfontfamily[JPmain]\jpmain{Noto Sans CJK JP}[AutoFakeSlant]
133 \newCJKfontfamily[JPserif]\jpserif{Not 127 \newCJKfontfamily[JPserif]\jpserif{Noto Sans CJK JP}[AutoFakeSlant]
134 } 128 }
135 \newCJKfontfamily[JPsans]\jpsans{Noto Sans 129 \newCJKfontfamily[JPsans]\jpsans{Noto Sans CJK JP}[AutoFakeSlant]
136 \newCJKfontfamily[JPmono]\jpmono{Noto Sans 130 \newCJKfontfamily[JPmono]\jpmono{Noto Sans Mono CJK JP}[AutoFakeSlant]
>> 131 % Dummy commands for Sphinx < 2.3 (no 'extrapackages' support)
>> 132 \providecommand{\onehalfspacing}{}
>> 133 \providecommand{\singlespacing}{}
137 % Define custom macros to on/off CJK 134 % Define custom macros to on/off CJK
138 %% One and half spacing for CJK contents 135 %% One and half spacing for CJK contents
139 \newcommand{\kerneldocCJKon}{\makexeCJKact 136 \newcommand{\kerneldocCJKon}{\makexeCJKactive\onehalfspacing}
140 \newcommand{\kerneldocCJKoff}{\makexeCJKin 137 \newcommand{\kerneldocCJKoff}{\makexeCJKinactive\singlespacing}
141 % Define custom macros for switching CJK f 138 % Define custom macros for switching CJK font setting
142 %% for Simplified Chinese 139 %% for Simplified Chinese
143 \newcommand{\kerneldocBeginSC}{% 140 \newcommand{\kerneldocBeginSC}{%
144 \begingroup% 141 \begingroup%
145 \scmain% 142 \scmain%
146 \xeCJKDeclareCharClass{FullLeft}{`“, 143 \xeCJKDeclareCharClass{FullLeft}{`“,`‘}% Full-width in SC
147 \xeCJKDeclareCharClass{FullRight}{`” 144 \xeCJKDeclareCharClass{FullRight}{`”,`’}% Full-width in SC
148 \renewcommand{\CJKrmdefault}{SCserif}% 145 \renewcommand{\CJKrmdefault}{SCserif}%
149 \renewcommand{\CJKsfdefault}{SCsans}% 146 \renewcommand{\CJKsfdefault}{SCsans}%
150 \renewcommand{\CJKttdefault}{SCmono}% 147 \renewcommand{\CJKttdefault}{SCmono}%
151 \xeCJKsetup{CJKspace = false}% gobble 148 \xeCJKsetup{CJKspace = false}% gobble white spaces by ' '
152 % For CJK ascii-art alignment 149 % For CJK ascii-art alignment
153 \setmonofont{Noto Sans Mono CJK SC}[Au 150 \setmonofont{Noto Sans Mono CJK SC}[AutoFakeSlant]%
154 } 151 }
155 \newcommand{\kerneldocEndSC}{\endgroup} 152 \newcommand{\kerneldocEndSC}{\endgroup}
156 %% for Traditional Chinese 153 %% for Traditional Chinese
157 \newcommand{\kerneldocBeginTC}{% 154 \newcommand{\kerneldocBeginTC}{%
158 \begingroup% 155 \begingroup%
159 \tcmain% 156 \tcmain%
160 \xeCJKDeclareCharClass{FullLeft}{`“, 157 \xeCJKDeclareCharClass{FullLeft}{`“,`‘}% Full-width in TC
161 \xeCJKDeclareCharClass{FullRight}{`” 158 \xeCJKDeclareCharClass{FullRight}{`”,`’}% Full-width in TC
162 \renewcommand{\CJKrmdefault}{TCserif}% 159 \renewcommand{\CJKrmdefault}{TCserif}%
163 \renewcommand{\CJKsfdefault}{TCsans}% 160 \renewcommand{\CJKsfdefault}{TCsans}%
164 \renewcommand{\CJKttdefault}{TCmono}% 161 \renewcommand{\CJKttdefault}{TCmono}%
165 \xeCJKsetup{CJKspace = false}% gobble 162 \xeCJKsetup{CJKspace = false}% gobble white spaces by ' '
166 % For CJK ascii-art alignment 163 % For CJK ascii-art alignment
167 \setmonofont{Noto Sans Mono CJK TC}[Au 164 \setmonofont{Noto Sans Mono CJK TC}[AutoFakeSlant]%
168 } 165 }
169 \newcommand{\kerneldocEndTC}{\endgroup} 166 \newcommand{\kerneldocEndTC}{\endgroup}
170 %% for Korean 167 %% for Korean
171 \newcommand{\kerneldocBeginKR}{% 168 \newcommand{\kerneldocBeginKR}{%
172 \begingroup% 169 \begingroup%
173 \krmain% 170 \krmain%
174 \renewcommand{\CJKrmdefault}{KRserif}% 171 \renewcommand{\CJKrmdefault}{KRserif}%
175 \renewcommand{\CJKsfdefault}{KRsans}% 172 \renewcommand{\CJKsfdefault}{KRsans}%
176 \renewcommand{\CJKttdefault}{KRmono}% 173 \renewcommand{\CJKttdefault}{KRmono}%
177 % \xeCJKsetup{CJKspace = true} % true 174 % \xeCJKsetup{CJKspace = true} % true by default
178 % For CJK ascii-art alignment (still m 175 % For CJK ascii-art alignment (still misaligned for Hangul)
179 \setmonofont{Noto Sans Mono CJK KR}[Au 176 \setmonofont{Noto Sans Mono CJK KR}[AutoFakeSlant]%
180 } 177 }
181 \newcommand{\kerneldocEndKR}{\endgroup} 178 \newcommand{\kerneldocEndKR}{\endgroup}
182 %% for Japanese 179 %% for Japanese
183 \newcommand{\kerneldocBeginJP}{% 180 \newcommand{\kerneldocBeginJP}{%
184 \begingroup% 181 \begingroup%
185 \jpmain% 182 \jpmain%
186 \renewcommand{\CJKrmdefault}{JPserif}% 183 \renewcommand{\CJKrmdefault}{JPserif}%
187 \renewcommand{\CJKsfdefault}{JPsans}% 184 \renewcommand{\CJKsfdefault}{JPsans}%
188 \renewcommand{\CJKttdefault}{JPmono}% 185 \renewcommand{\CJKttdefault}{JPmono}%
189 \xeCJKsetup{CJKspace = false}% gobble 186 \xeCJKsetup{CJKspace = false}% gobble white space by ' '
190 % For CJK ascii-art alignment 187 % For CJK ascii-art alignment
191 \setmonofont{Noto Sans Mono CJK JP}[Au 188 \setmonofont{Noto Sans Mono CJK JP}[AutoFakeSlant]%
192 } 189 }
193 \newcommand{\kerneldocEndJP}{\endgroup} 190 \newcommand{\kerneldocEndJP}{\endgroup}
194 191
195 % Single spacing in literal blocks 192 % Single spacing in literal blocks
196 \fvset{baselinestretch=1} 193 \fvset{baselinestretch=1}
197 % To customize \sphinxtableofcontents 194 % To customize \sphinxtableofcontents
198 \usepackage{etoolbox} 195 \usepackage{etoolbox}
199 % Inactivate CJK after tableofcontents 196 % Inactivate CJK after tableofcontents
200 \apptocmd{\sphinxtableofcontents}{\kerneld 197 \apptocmd{\sphinxtableofcontents}{\kerneldocCJKoff}{}{}
201 \xeCJKsetup{CJKspace = true}% For inter-ph 198 \xeCJKsetup{CJKspace = true}% For inter-phrase space of Korean TOC
202 % Suppress extra white space at latin .. n !! 199 }{ % No CJK font found
203 \AtBeginEnvironment{sphinxVerbatim}{\CJKse <<
204 }{ % Don't enable CJK <<
205 % Custom macros to on/off CJK and switch C 200 % Custom macros to on/off CJK and switch CJK fonts (Dummy)
206 \newcommand{\kerneldocCJKon}{} 201 \newcommand{\kerneldocCJKon}{}
207 \newcommand{\kerneldocCJKoff}{} 202 \newcommand{\kerneldocCJKoff}{}
208 %% By defining \kerneldocBegin(SC|TC|KR|JP 203 %% By defining \kerneldocBegin(SC|TC|KR|JP) as commands with an argument
209 %% and ignore the argument (#1) in their d 204 %% and ignore the argument (#1) in their definitions, whole contents of
210 %% CJK chapters can be ignored. 205 %% CJK chapters can be ignored.
211 \newcommand{\kerneldocBeginSC}[1]{% 206 \newcommand{\kerneldocBeginSC}[1]{%
212 %% Put a note on missing CJK fonts or !! 207 %% Put a note on missing CJK fonts in place of zh_CN translation.
213 %% zh_CN translation. !! 208 \begin{sphinxadmonition}{note}{Note on missing fonts:}
214 \begin{sphinxadmonition}{note}{Note on <<
215 Translations of Simplified Chinese 209 Translations of Simplified Chinese (zh\_CN), Traditional Chinese
216 (zh\_TW), Korean (ko\_KR), and Jap 210 (zh\_TW), Korean (ko\_KR), and Japanese (ja\_JP) were skipped
217 due to the lack of suitable font f !! 211 due to the lack of suitable font families.
218 package. <<
219 212
220 If you want them, please install n !! 213 If you want them, please install ``Noto Sans CJK'' font families
221 font families along with the texli !! 214 by following instructions from
222 instructions from <<
223 \sphinxcode{./scripts/sphinx-pre-i 215 \sphinxcode{./scripts/sphinx-pre-install}.
224 Having optional non-variable ``Not !! 216 Having optional ``Noto Serif CJK'' font families will improve
225 improve the looks of those transla !! 217 the looks of those translations.
226 \end{sphinxadmonition}} 218 \end{sphinxadmonition}}
227 \newcommand{\kerneldocEndSC}{} 219 \newcommand{\kerneldocEndSC}{}
228 \newcommand{\kerneldocBeginTC}[1]{} 220 \newcommand{\kerneldocBeginTC}[1]{}
229 \newcommand{\kerneldocEndTC}{} 221 \newcommand{\kerneldocEndTC}{}
230 \newcommand{\kerneldocBeginKR}[1]{} 222 \newcommand{\kerneldocBeginKR}[1]{}
231 \newcommand{\kerneldocEndKR}{} 223 \newcommand{\kerneldocEndKR}{}
232 \newcommand{\kerneldocBeginJP}[1]{} 224 \newcommand{\kerneldocBeginJP}[1]{}
233 \newcommand{\kerneldocEndJP}{} 225 \newcommand{\kerneldocEndJP}{}
234 } 226 }
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.