mandoc/mandoc_html.3 - diff

Return to mandoc_html.3 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc_html.3 between version 1.5 and 1.16

version 1.5, 2017/01/28 22:36:38

version 1.16, 2018/06/25 14:13:54

Line 1

.\" $Id$

.\"

.\" Permission to use, copy, modify, and distribute this software for any

.\" purpose with or without fee is hereby granted, provided that the above

Line 25

.Ft void

.Fn print_gen_decls "struct html *h"

.Ft void

.Fn print_gen_comment "struct html *h" "struct roff_node *n"

.Ft void

.Fn print_gen_head "struct html *h"

.Ft struct tag *

.Fo print_otag

Line 48

Line 50

.Fa "struct html *h"

.Fa "const char *word"

.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

The mandoc HTML formatter is not a formal library.

However, as it is compiled into more than one program, in particular

Line 101 and

Line 111 and

declarations required for the current document type.

.Pp

The function

.Fn print_gen_comment

prints the leading comments, usually containing a Copyright notice

and license, as an HTML comment.

It is intended to be called right after opening the

.Aq Ic HTML

element.

Pass the first

.Dv ROFFT_COMMENT

node in

.Fa n .

.Pp

The function

.Fn print_gen_head

prints the opening

.Aq Ic META

Line 145 the respective attribute is not written.

Line 167 the respective attribute is not written.

Print a

.Cm class

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

Print a

.Cm href

Line 191 Instead, the rest of the format string consists of pai

Line 218 Instead, the rest of the format string consists of pai

argument type letters and style name letters.

.El

.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

.It Cm h

Requires one

.Vt int

argument, interpreted as a horizontal length in units of

.Dv SCALE_EN .

.It Cm s

Requires one

.Vt char *

Line 206 argument, used as a style value.

Line 228 argument, used as a style value.

Requires one

.Vt struct roffsu *

argument, used as a length.

.It Cm v

Requires one

.Vt int

argument, interpreted as a vertical length in units of

.Dv SCALE_VS .

.It Cm w

Requires one

.Vt char *

argument, interpreted as an

.Xr mdoc 7 Ns -style

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

.Pp

Style name letters decide what to do with the preceding argument:

.Bl -tag -width 1n -offset indent

.It Cm b

Set

.Cm margin-bottom

to the given length.

.It Cm h

Set

.Cm height

to the given length.

.It Cm i

Set

.Cm text-indent

to the given length.

.It Cm l

Set

.Cm margin-left

to the given length.

.It Cm t

Set

.Cm margin-top

to the given length.

.It Cm w

Set

.Cm width

to the given length.

.It Cm W

Set

.Cm min-width

to the given length.

.It Cm \&?

The special pair

.Cm s?

Line 301 and

Line 277 and

.Fn print_tagq

functions.

.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

.Fn html_strlen ,

.Fn print_eqn ,

.Fn print_tbl ,

and

CVSweb