mandoc/index.7 - diff

Return to index.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/index.7 between version 1.6 and 1.7

version 1.6, 2008/12/07 23:08:23

version 1.7, 2008/12/07 23:44:19

Line 19 into XML or HTML documents. Unlike other similar util

and

.Xr man2html 1 ,

.Nm

acts directly on source documents, validating its input and producing a

is a full macro parser operating on source documents, specifically mdoc,

variety of outputs.

validating input and compiling to HTML and XML output types.

.Pp

The

.Nm

utility is tested specifically on

.Ox

manual sources as compiled and invoked both on

.Ox

and Linux.

.Nm

.Ud

.\"

.Ss Validation

In order to operate sanely,

Line 30 following checks:

Line 41 following checks:

.Pp

.Bl -enum -compact

.It

special characters (such as

valid special characters (such as

.Sq \en

and

.Sq \et ) ,

.It

macro scope (such as

sane macro scope (such as

.Sq \&.Sh

macros clobbering a pending

.Sq \&.Bl

scope),

.It

predefined characters (such as \\*(>= and \\*q),

valid predefined characters (such as \\*(>= and \\*q),

.It

correctly-ordered document prelude,

.It

sane argument values (such as those for

sane macro argument values (such as those for

.Sq \&.Dt

.Sq \&.Sm ) ,

.It

and so on.

.El

.Pp

The

.Nm

utility has been tested under Linux and

.Ox ,

specifically on

.Ox

manual source.

.Nm

.Ud

.\"

.Ss Filtering

When a block of source has been verified, it's passed to the front-end

When a line of source has been parsed, it's passed to the output

fitlers, which format and display data. The

filters, which format and display data. The two available filters are

.Nm

HTML and XML.

utility is invoked with a filter by the

.Fl f

flag. The HTML filter has the following features:

.Pp

The HTML filter has the following features:

.Pp

.Bl -enum -compact

.It

HTML-4.01 strict compliance.

Line 92 The XML filter creates a correct XML tree with

Line 91 The XML filter creates a correct XML tree with

and

.Dq inline

namespaces corresponding to macro categories. Namespace identifiers

correspond to their definitions.

correspond to their definitions. A sample is available at

http://mdocml.bsd.lv/index.xml

.Ns .

.\"

.Sh DOWNLOADS

Download

Line 102 at http://mdocml.bsd.lv/mdocml.tgz

Line 103 at http://mdocml.bsd.lv/mdocml.tgz

.\" - UPDATE ME WITH EVERY RELEASE. ----------------------------------

The current version is 1.0.0, dated 08/12/2008.

.\" ------------------------------------------------------------------

.Pp

Previous versions are archived as mdocml-x.y.z.tgz, with the appropriate

versions filled in.

.\"

.Sh DOCUMENTS

The manual for

CVSweb