version 1.5, 2017/01/28 22:36:38 |
version 1.8, 2017/05/12 17:58:21 |
|
|
.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 145 the respective attribute is not written. |
|
Line 153 the respective attribute is not written. |
|
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 191 Instead, the rest of the format string consists of pai |
|
Line 204 Instead, the rest of the format string consists of pai |
|
argument type letters and style name letters. |
argument type letters and style name letters. |
.El |
.El |
.Pp |
.Pp |
Argument type letters each require on argument as follows: |
Argument type letters each require one argument as follows: |
.Bl -tag -width 1n -offset indent |
.Bl -tag -width 1n -offset indent |
.It Cm h |
.It Cm h |
Requires one |
Requires one |
Line 220 width specifier. |
|
Line 233 width specifier. |
|
If the argument is |
If the argument is |
.Dv NULL , |
.Dv NULL , |
nothing is printed for this pair. |
nothing is printed for this pair. |
.It Cm W |
.Pp |
Similar to |
The |
.Cm w , |
.Cm w |
but makes the width negative by multiplying it with \(mi1. |
argument type letter can optionally be followed by one or two |
|
modifier letters. |
|
The modifier |
|
.Cm + |
|
increases the width by 10% to make even bold text fit |
|
and adds two units for padding between columns. |
|
The modifier |
|
.Cm \- |
|
makes the width negative by multiplying it with \-1. |
.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: |
|
|
.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 |