VirtualBox

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

Last change on this file was 99497, checked in by vboxsync, 12 months ago

manual: Split out the topics of converted manpages into separate files and generate ditamap files for each manpage to avoid needing to hardcode anything in UserManual.xml. This means that the topics inside a manpage can be supressed from the toc, but otoh, they get numbered (with 4.x). The per-topic files are named by refentry/refsect1/refsect2 @id and are currently not cleaned up by 'kmk clean'. bugref:10302

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

© 2023 Oracle
ContactPrivacy policyTerms of Use