Annotation of mandoc/mandoc_html.3, Revision 1.7
1.7 ! schwarze 1: .\" $Id: mandoc_html.3,v 1.6 2017/03/13 19:01:38 schwarze Exp $
1.1 schwarze 2: .\"
1.3 schwarze 3: .\" Copyright (c) 2014, 2017 Ingo Schwarze <schwarze@openbsd.org>
1.1 schwarze 4: .\"
5: .\" Permission to use, copy, modify, and distribute this software for any
6: .\" purpose with or without fee is hereby granted, provided that the above
7: .\" copyright notice and this permission notice appear in all copies.
8: .\"
9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16: .\"
1.7 ! schwarze 17: .Dd $Mdocdate: March 13 2017 $
1.1 schwarze 18: .Dt MANDOC_HTML 3
19: .Os
20: .Sh NAME
21: .Nm mandoc_html
22: .Nd internals of the mandoc HTML formatter
23: .Sh SYNOPSIS
24: .In "html.h"
25: .Ft void
26: .Fn print_gen_decls "struct html *h"
27: .Ft void
28: .Fn print_gen_head "struct html *h"
29: .Ft struct tag *
30: .Fo print_otag
31: .Fa "struct html *h"
32: .Fa "enum htmltag tag"
1.2 schwarze 33: .Fa "const char *fmt"
34: .Fa ...
1.1 schwarze 35: .Fc
36: .Ft void
37: .Fo print_tagq
38: .Fa "struct html *h"
39: .Fa "const struct tag *until"
40: .Fc
41: .Ft void
42: .Fo print_stagq
43: .Fa "struct html *h"
44: .Fa "const struct tag *suntil"
45: .Fc
46: .Ft void
47: .Fo print_text
48: .Fa "struct html *h"
49: .Fa "const char *word"
50: .Fc
1.7 ! schwarze 51: .Ft char *
! 52: .Fo html_make_id
! 53: .Fa "const struct roff_node *n"
! 54: .Fc
! 55: .Ft int
! 56: .Fo html_strlen
! 57: .Fa "const char *cp"
! 58: .Fc
1.1 schwarze 59: .Sh DESCRIPTION
60: The mandoc HTML formatter is not a formal library.
61: However, as it is compiled into more than one program, in particular
62: .Xr mandoc 1
63: and
64: .Xr man.cgi 8 ,
65: and because it may be security-critical in some contexts,
66: some documentation is useful to help to use it correctly and
67: to prevent XSS vulnerabilities.
68: .Pp
69: The formatter produces HTML output on the standard output.
70: Since proper escaping is usually required and best taken care of
71: at one central place, the language-specific formatters
72: .Po
73: .Pa *_html.c ,
74: see
75: .Sx FILES
76: .Pc
77: are not supposed to print directly to
78: .Dv stdout
79: using functions like
80: .Xr printf 3 ,
81: .Xr putc 3 ,
82: .Xr puts 3 ,
83: or
84: .Xr write 2 .
85: Instead, they are expected to use the output functions declared in
86: .Pa html.h
87: and implemented as part of the main HTML formatting engine in
88: .Pa html.c .
89: .Ss Data structures
90: These structures are declared in
91: .Pa html.h .
92: .Bl -tag -width Ds
93: .It Vt struct html
94: Internal state of the HTML formatter.
95: .It Vt struct tag
96: One entry for the LIFO stack of HTML elements.
97: Members are
98: .Fa "enum htmltag tag"
99: and
100: .Fa "struct tag *next" .
101: .El
102: .Ss Private interface functions
103: The function
104: .Fn print_gen_decls
105: prints the opening
106: .Ao Pf \&? Ic xml ? Ac
107: and
108: .Aq Pf \&! Ic DOCTYPE
109: declarations required for the current document type.
110: .Pp
111: The function
112: .Fn print_gen_head
113: prints the opening
114: .Aq Ic META
115: and
116: .Aq Ic LINK
117: elements for the document
118: .Aq Ic HEAD ,
119: using the
120: .Fa style
121: member of
122: .Fa h
123: unless that is
124: .Dv NULL .
125: It uses
126: .Fn print_otag
127: which takes care of properly encoding attributes,
128: which is relevant for the
129: .Fa style
130: link in particular.
131: .Pp
132: The function
133: .Fn print_otag
134: prints the start tag of an HTML element with the name
135: .Fa tag ,
1.2 schwarze 136: optionally including the attributes specified by
137: .Fa fmt .
138: If
139: .Fa fmt
140: is the empty string, no attributes are written.
141: Each letter of
142: .Fa fmt
143: specifies one attribute to write.
144: Most attributes require one
145: .Va char *
146: argument which becomes the value of the attribute.
147: The arguments have to be given in the same order as the attribute letters.
1.5 schwarze 148: If an argument is
149: .Dv NULL ,
150: the respective attribute is not written.
1.2 schwarze 151: .Bl -tag -width 1n -offset indent
152: .It Cm c
153: Print a
154: .Cm class
155: attribute.
1.6 schwarze 156: This attribute letter can optionally be followed by the modifier letter
157: .Cm T .
158: In that case, a
159: .Cm title
160: attribute with the same value is also printed.
1.2 schwarze 161: .It Cm h
162: Print a
163: .Cm href
164: attribute.
1.3 schwarze 165: This attribute letter can optionally be followed by a modifier letter.
166: If followed by
167: .Cm R ,
168: it formats the link as a local one by prefixing a
169: .Sq #
170: character.
171: If followed by
172: .Cm I ,
173: it interpretes the argument as a header file name
174: and generates a link using the
175: .Xr mandoc 1
176: .Fl O Cm includes
177: option.
178: If followed by
179: .Cm M ,
180: it takes two arguments instead of one, a manual page name and
181: section, and formats them as a link to a manual page using the
182: .Xr mandoc 1
183: .Fl O Cm man
184: option.
1.2 schwarze 185: .It Cm i
186: Print an
187: .Cm id
188: attribute.
189: .It Cm \&?
190: Print an arbitrary attribute.
191: This format letter requires two
192: .Vt char *
193: arguments, the attribute name and the value.
1.5 schwarze 194: The name must not be
195: .Dv NULL .
1.2 schwarze 196: .It Cm s
197: Print a
198: .Cm style
199: attribute.
200: If present, it must be the last format letter.
201: In contrast to the other format letters, this one does not yet
1.5 schwarze 202: print the value and does not take an argument.
1.2 schwarze 203: Instead, the rest of the format string consists of pairs of
204: argument type letters and style name letters.
205: .El
206: .Pp
207: Argument type letters each require on argument as follows:
208: .Bl -tag -width 1n -offset indent
209: .It Cm h
210: Requires one
211: .Vt int
212: argument, interpreted as a horizontal length in units of
213: .Dv SCALE_EN .
214: .It Cm s
215: Requires one
216: .Vt char *
217: argument, used as a style value.
218: .It Cm u
219: Requires one
220: .Vt struct roffsu *
221: argument, used as a length.
222: .It Cm v
223: Requires one
224: .Vt int
225: argument, interpreted as a vertical length in units of
226: .Dv SCALE_VS .
227: .It Cm w
228: Requires one
229: .Vt char *
230: argument, interpreted as an
231: .Xr mdoc 7 Ns -style
232: width specifier.
1.5 schwarze 233: If the argument is
234: .Dv NULL ,
235: nothing is printed for this pair.
1.4 schwarze 236: .It Cm W
237: Similar to
238: .Cm w ,
239: but makes the width negative by multiplying it with \(mi1.
1.2 schwarze 240: .El
241: .Pp
242: Style name letters decide what to do with the preceding argument:
243: .Bl -tag -width 1n -offset indent
244: .It Cm b
245: Set
246: .Cm margin-bottom
247: to the given length.
248: .It Cm h
249: Set
250: .Cm height
251: to the given length.
252: .It Cm i
253: Set
254: .Cm text-indent
255: to the given length.
256: .It Cm l
257: Set
258: .Cm margin-left
259: to the given length.
260: .It Cm t
261: Set
262: .Cm margin-top
263: to the given length.
264: .It Cm w
265: Set
266: .Cm width
267: to the given length.
268: .It Cm W
269: Set
270: .Cm min-width
271: to the given length.
272: .It Cm \&?
273: The special pair
274: .Cm s?
275: requires two
276: .Vt char *
277: arguments.
278: The first is the style name, the second its value.
1.5 schwarze 279: The style name must not be
280: .Dv NULL .
1.2 schwarze 281: .El
282: .Pp
283: .Fn print_otag
284: uses the private function
1.1 schwarze 285: .Fn print_encode
286: to take care of HTML encoding.
287: If required by the element type, it remembers in
288: .Fa h
289: that the element is open.
290: The function
291: .Fn print_tagq
292: is used to close out all open elements up to and including
293: .Fa until ;
294: .Fn print_stagq
295: is a variant to close out all open elements up to but excluding
296: .Fa suntil .
297: .Pp
298: The function
299: .Fn print_text
300: prints HTML element content.
301: It uses the private function
302: .Fn print_encode
303: to take care of HTML encoding.
304: If the document has requested a non-standard font, for example using a
305: .Xr roff 7
306: .Ic \ef
307: font escape sequence,
308: .Fn print_text
309: wraps
310: .Fa word
311: in an HTML font selection element using the
312: .Fn print_otag
313: and
314: .Fn print_tagq
315: functions.
316: .Pp
1.7 ! schwarze 317: The function
! 318: .Fn html_make_id
! 319: takes a node containing one or more text children
! 320: and returns a newly allocated string containing the concatenation
! 321: of the child strings, with blanks replaced by underscores.
! 322: If the node
! 323: .Fa n
! 324: contains any non-text child node,
! 325: .Fn html_make_id
! 326: returns
! 327: .Dv NULL
! 328: instead.
! 329: The caller is responsible for freeing the returned string.
! 330: .Pp
! 331: The function
! 332: .Fn html_strlen
! 333: counts the number of characters in
! 334: .Fa cp .
! 335: It is used as a crude estimate of the width needed to display a string.
! 336: .Pp
1.1 schwarze 337: The functions
338: .Fn print_eqn ,
339: .Fn print_tbl ,
340: and
341: .Fn print_tblclose
342: are not yet documented.
343: .Sh FILES
344: .Bl -tag -width mandoc_aux.c -compact
345: .It Pa main.h
346: declarations of public functions for use by the main program,
347: not yet documented
348: .It Pa html.h
349: declarations of data types and private functions
350: for use by language-specific HTML formatters
351: .It Pa html.c
352: main HTML formatting engine and utility functions
353: .It Pa mdoc_html.c
354: .Xr mdoc 7
355: HTML formatter
356: .It Pa man_html.c
357: .Xr man 7
358: HTML formatter
359: .It Pa tbl_html.c
360: .Xr tbl 7
361: HTML formatter
362: .It Pa eqn_html.c
363: .Xr eqn 7
364: HTML formatter
365: .It Pa out.h
366: declarations of data types and private functions
367: for shared use by all mandoc formatters,
368: not yet documented
369: .It Pa out.c
370: private functions for shared use by all mandoc formatters
371: .It Pa mandoc_aux.h
372: declarations of common mandoc utility functions, see
373: .Xr mandoc 3
374: .It Pa mandoc_aux.c
375: implementation of common mandoc utility functions
376: .El
377: .Sh SEE ALSO
378: .Xr mandoc 1 ,
379: .Xr mandoc 3 ,
380: .Xr man.cgi 8
381: .Sh AUTHORS
382: .An -nosplit
383: The mandoc HTML formatter was written by
384: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
1.5 schwarze 385: It is maintained by
386: .An Ingo Schwarze Aq Mt schwarze@openbsd.org ,
387: who also wrote this manual.
CVSweb