version 1.3, 2017/01/17 15:32:44 |
version 1.7, 2017/03/15 11:29:53 |
|
|
.Fa "struct html *h" |
.Fa "struct html *h" |
.Fa "const char *word" |
.Fa "const char *word" |
.Fc |
.Fc |
|
.Ft char * |
|
.Fo html_make_id |
|
.Fa "const struct roff_node *n" |
|
.Fc |
|
.Ft int |
|
.Fo html_strlen |
|
.Fa "const char *cp" |
|
.Fc |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The mandoc HTML formatter is not a formal library. |
The mandoc HTML formatter is not a formal library. |
However, as it is compiled into more than one program, in particular |
However, as it is compiled into more than one program, in particular |
Line 137 Most attributes require one |
|
Line 145 Most attributes require one |
|
.Va char * |
.Va char * |
argument which becomes the value of the attribute. |
argument which becomes the value of the attribute. |
The arguments have to be given in the same order as the attribute letters. |
The arguments have to be given in the same order as the attribute letters. |
|
If an argument is |
|
.Dv NULL , |
|
the respective attribute is not written. |
.Bl -tag -width 1n -offset indent |
.Bl -tag -width 1n -offset indent |
.It Cm c |
.It Cm c |
Print a |
Print a |
.Cm class |
.Cm class |
attribute. |
attribute. |
|
This attribute letter can optionally be followed by the modifier letter |
|
.Cm T . |
|
In that case, a |
|
.Cm title |
|
attribute with the same value is also printed. |
.It Cm h |
.It Cm h |
Print a |
Print a |
.Cm href |
.Cm href |
Line 175 Print an arbitrary attribute. |
|
Line 191 Print an arbitrary attribute. |
|
This format letter requires two |
This format letter requires two |
.Vt char * |
.Vt char * |
arguments, the attribute name and the value. |
arguments, the attribute name and the value. |
|
The name must not be |
|
.Dv NULL . |
.It Cm s |
.It Cm s |
Print a |
Print a |
.Cm style |
.Cm style |
attribute. |
attribute. |
If present, it must be the last format letter. |
If present, it must be the last format letter. |
In contrast to the other format letters, this one does not yet |
In contrast to the other format letters, this one does not yet |
print the value and does not require an argument. |
print the value and does not take an argument. |
Instead, the rest of the format string consists of pairs of |
Instead, the rest of the format string consists of pairs of |
argument type letters and style name letters. |
argument type letters and style name letters. |
.El |
.El |
|
|
argument, interpreted as an |
argument, interpreted as an |
.Xr mdoc 7 Ns -style |
.Xr mdoc 7 Ns -style |
width specifier. |
width specifier. |
|
If the argument is |
|
.Dv NULL , |
|
nothing is printed for this pair. |
|
.It Cm W |
|
Similar to |
|
.Cm w , |
|
but makes the width negative by multiplying it with \(mi1. |
.El |
.El |
.Pp |
.Pp |
Style name letters decide what to do with the preceding argument: |
Style name letters decide what to do with the preceding argument: |
|
|
.Vt char * |
.Vt char * |
arguments. |
arguments. |
The first is the style name, the second its value. |
The first is the style name, the second its value. |
|
The style name must not be |
|
.Dv NULL . |
.El |
.El |
.Pp |
.Pp |
.Fn print_otag |
.Fn print_otag |
|
|
.Fn print_tagq |
.Fn print_tagq |
functions. |
functions. |
.Pp |
.Pp |
|
The function |
|
.Fn html_make_id |
|
takes a node containing one or more text children |
|
and returns a newly allocated string containing the concatenation |
|
of the child strings, with blanks replaced by underscores. |
|
If the node |
|
.Fa n |
|
contains any non-text child node, |
|
.Fn html_make_id |
|
returns |
|
.Dv NULL |
|
instead. |
|
The caller is responsible for freeing the returned string. |
|
.Pp |
|
The function |
|
.Fn html_strlen |
|
counts the number of characters in |
|
.Fa cp . |
|
It is used as a crude estimate of the width needed to display a string. |
|
.Pp |
The functions |
The functions |
.Fn html_strlen , |
|
.Fn print_eqn , |
.Fn print_eqn , |
.Fn print_tbl , |
.Fn print_tbl , |
and |
and |
Line 336 implementation of common mandoc utility functions |
|
Line 382 implementation of common mandoc utility functions |
|
.An -nosplit |
.An -nosplit |
The mandoc HTML formatter was written by |
The mandoc HTML formatter was written by |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . |
This manual was written by |
It is maintained by |
.An Ingo Schwarze Aq Mt schwarze@openbsd.org . |
.An Ingo Schwarze Aq Mt schwarze@openbsd.org , |
|
who also wrote this manual. |