VirtualBox

source: vbox/trunk/doc/manual/pdf-theme-UserManual.yaml@ 105453

Last change on this file since 105453 was 105417, checked in by vboxsync, 5 months ago

doc/manual: Throw out a lot of meaningless (or outright misleading) content from the ditamap, and do a lot of polishing of the PDF theme. bugref:10705

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 8.4 KB
Line 
1# $Id: pdf-theme-UserManual.yaml 105417 2024-07-19 11:24:00Z vboxsync $
2
3brand:
4 color:
5 primary: '#1a3355'
6 secondary: '#6d767e'
7 tertiary: '#b9c7d0'
8 inverse: '#e5ebeb'
9 links: '#4169e1'
10 note:
11 background:
12 attention: '#fff3ce'
13 caution: '#f8d8db'
14 info: '#dbe5f1'
15 tip: '#d0e8de'
16
17pdf2:
18 font:
19 sans: 'Noto Sans'
20 serif: 'Noto Serif'
21 monospaced: 'DejaVu Sans Mono'
22 # ^^^ - Important to have proper unicode monospace font so we can use non-breaking hyphen (U+2011)
23 # in syntax diagrams.
24 #
25 # If the PDF contains any use of font "Helvetica" then it might be that the topic nesting is too deep.
26 # Maximum nesting is 4 (not sure what limits it), but all config for h5 is ignored.
27
28page:
29 size: PA4
30 mirror-margins: true
31
32header:
33 color: $brand-color-secondary
34 display-align: before
35 end-indent: 10mm
36 font-family: $pdf2-font-sans
37 padding-after: 6pt
38 padding-before: 12pt
39 start-indent: 10mm
40 odd:
41 content: '{chapter}'
42 text-align: end
43 even:
44 content: '{title}'
45 text-align: start
46
47footer:
48 color: $brand-color-secondary
49 end-indent: 10mm
50 font-family: $pdf2-font-sans
51 padding-after: 12pt
52 padding-before: 6pt
53 start-indent: 10mm
54 odd:
55 content: '{folio}'
56 font-weight: bold
57 text-align: end
58 even:
59 content: '{folio}'
60 font-weight: bold
61 text-align: start
62
63style:
64 body:
65 font-family: $pdf2-font-serif
66 font-size: 11pt
67 line-height: 1.3
68 start-indent: 48pt
69
70 cmdname:
71 color: $brand-color-primary
72 font-family: $pdf2-font-monospaced
73 font-weight: bold
74
75 codeblock:
76 background-color: $brand-color-inverse
77 border: solid 1pt $brand-color-tertiary
78 font-family: $pdf2-font-monospaced
79 font-size: 8pt
80 keep-together.within-page: always
81 space-after: 8pt
82
83 codeph:
84 color: $brand-color-secondary
85 font-family: $pdf2-font-monospaced
86 font-size: '0.9 * from-parent(font-size)'
87
88 cover:
89 # TODO: Could we get an SVG logo? Or at least a higher resolution one (this is 512x512, I think).
90 background-image: en_US/images/vboxlogo.png
91 background-repeat: no-repeat
92 background-position-horizontal: center
93
94 cover-title:
95 color: $brand-color-primary
96 font-family: $pdf2-font-sans
97 font-size: 48pt
98 font-weight: bold
99 line-height: 1.3
100 space-before: 165mm
101
102 example-title:
103 color: $brand-color-secondary
104
105 fig:
106 caption:
107 color: $brand-color-secondary
108 font-family: $pdf2-font-sans
109 font-size: 9pt
110 font-style: italic
111 font-weight: normal
112
113 filepath:
114 color: $brand-color-secondary
115 font-family: $pdf2-font-monospaced
116
117 h1:
118 border-after: solid 2pt $brand-color-inverse
119 color: $brand-color-primary
120 font-family: $pdf2-font-sans
121 font-size: 18pt
122 font-weight: bold
123 space-before: 0pt
124 padding-top: 0pt
125 space-after: 9pt
126 title-numbering: true
127
128 h2:
129 border-after: solid 1pt $brand-color-inverse
130 color: $brand-color-primary
131 font-family: $pdf2-font-sans
132 font-size: 16pt
133 font-style: italic
134 space-before: 16pt
135 space-after: 8pt
136 title-numbering: true
137
138 h3:
139 color: $brand-color-primary
140 font-family: $pdf2-font-sans
141 font-size: 14pt
142 font-weight: bold
143 space-before: 21pt
144 space-after: 7pt
145 title-numbering: true
146
147 h4:
148 color: $brand-color-primary
149 font-family: $pdf2-font-sans
150 font-size: 12pt
151 font-weight: bold
152 font-style: italic
153 space-before: 15pt
154 start-indent: 'from-parent(start-indent)'
155 title-numbering: true
156
157 link:
158 color: $brand-color-links
159 font-style: italic
160
161 note:
162 background-color: $brand-color-note-background-info
163 border: solid 1pt $brand-color-tertiary
164 keep-together.within-page: always
165 label:
166 font-family: $pdf2-font-sans
167 space-end: 2pt
168 padding-start: 6pt
169 start-indent: '6pt + from-parent(start-indent)'
170 padding-end: 6pt
171 end-indent: '6pt + from-parent(end-indent)'
172 space-before: 6pt
173 space-after: 12pt
174 attention:
175 background-color: $brand-color-note-background-attention
176 caution:
177 background-color: $brand-color-note-background-caution
178 important:
179 background-color: $brand-color-note-background-attention
180 notice:
181 background-color: $brand-color-note-background-attention
182 restriction:
183 background-color: $brand-color-note-background-attention
184 tip:
185 background-color: $brand-color-note-background-tip
186 warning:
187 background-color: $brand-color-note-background-caution
188
189 section-title:
190 color: $brand-color-secondary
191 font-family: $pdf2-font-sans
192
193 shortdesc:
194 color: $brand-color-secondary
195 line-height: 1.3
196
197 table:
198 caption:
199 color: $brand-color-secondary
200 font-family: $pdf2-font-sans
201 font-size: 9pt
202 font-style: italic
203 font-weight: normal
204 font-family: $pdf2-font-sans
205 font-size: 9pt
206 header:
207 background-color: $brand-color-inverse
208 font-family: $pdf2-font-monospaced # Hack for arrow glyphs
209
210 toc-1:
211 color: $brand-color-primary
212 font-family: $pdf2-font-sans
213 space-before: 6pt
214 start-indent: 0pt
215
216 toc-2:
217 color: black
218 space-before: 4pt
219 start-indent: 12pt
220
221 toc-3:
222 color: black
223 space-before: 2pt
224 start-indent: 32pt
225
226 toc-4:
227 color: black
228 space-before: 2pt
229 start-indent: 48pt
230
231 varname:
232 color: $brand-color-secondary
233 font-family: $pdf2-font-monospaced
234 font-style: italic
235
236
237 #
238 # The following properties requires an pdf-generator git newer than February 2023,
239 # or version 0.6.2+ (unreleased).
240 #
241
242 # We need to specify the font for each of these elements, so we get a consistent
243 # monospace font capable of doing non-breaking hyphen glyps. The default "Courier"
244 # does not do the job, at least not on Windows.
245 delim:
246 font-family: $pdf2-font-monospaced
247 groupchoice:
248 font-family: $pdf2-font-monospaced
249 groupcomp:
250 font-family: $pdf2-font-monospaced
251 groupseq:
252 font-family: $pdf2-font-monospaced
253 kwd:
254 font-family: $pdf2-font-monospaced
255 oper:
256 font-family: $pdf2-font-monospaced
257 repsep:
258 font-family: $pdf2-font-monospaced
259 sep:
260 font-family: $pdf2-font-monospaced
261 syntaxdiagram:
262 font-family: $pdf2-font-monospaced
263 start-indent: '1cm + from-parent(start-indent)'
264 text-indent: -1cm
265 keep-together.within-page: always
266 var:
267 font-family: $pdf2-font-monospaced
268 pre:
269 font-family: $pdf2-font-monospaced
270 userinput:
271 font-family: $pdf2-font-monospaced
272 screen:
273 font-family: $pdf2-font-monospaced
274 systemoutput:
275 font-family: $pdf2-font-monospaced
276
277
278 # Prevent a parameter and it's definition from ending up on different pages.
279 plentry:
280 keep-together.within-page: always
281
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette