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.5 and 1.13

version 1.5, 2008/12/07 21:30:49

version 1.13, 2008/12/10 14:42:46

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

Downloads (source and ports) are available in the

.Sx DOWNLOADS

section.

.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 45 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,

correctly-ordered prelude and sections,

.It

sane argument values (such as those for

sane macro argument values (such as those for

.Sq \&.Dt

.Sq \&.Sm ) ,

.It

valid manual sections and systems;

.It

and so on.

.El

.\"

.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

.Pp

.Fl f

The HTML filter has the following features:

flag. The HTML filter has the following features:

.Pp

.Bl -enum -compact

.It

HTML-4.01 strict compliance.

Line 67 Proper render of values in UTF-8, such as

Line 85 Proper render of values in UTF-8, such as

.Dq quotes

and \*(>= predefined values.

.It

URI-appearing http://bsd.lv strings are correctly enclosed in link tags.

URI-appearing http://bsd.lv/ strings are correctly enclosed in link tags.

.It

CSS-dictated style with meaningful non-CSS defaults.

.El

.Pp

The XML filter creates a correct XML tree with

.Dq block ,

.Dq head ,

.Dq body ,

and

.Dq inline

namespaces corresponding to macro categories. Namespace identifiers

correspond to their definitions. A sample is available at

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

.Ns .

.\"

.Sh ENVIRONMENT

.Sh DOWNLOADS

The

Download

.Nm

utility has been tested under Linux and

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

.Ox ,

.Ns .

specifically on

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

.Ox

The current version is 1.0.3, dated 10/12/2008.

manual source.

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

.Pp

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

versions filled in.

.\"

.Sh DOCUMENTS

The manual for

.Nm

is available at http://mdocml.bsd.lv/mdocml.html

.Ns .

.\"

.Sh EXAMPLES

This page was produced as follows:

.Pp

.D1 % mdocml -fhtml -W -e -o index.html index.7

.D1 % mdocml -fhtml -Wall -e -o index.html index.7

.Pp

The original mdoc source is at http://mdocml.bsd.lv/index.txt

.Ns .

.\"

.Sh SEE ALSO

.Bl -ohang

Line 99 text and produces HTML output.

Line 140 text and produces HTML output.

and

.Ox

project CGI for producing HTML from nroff source.

.It Xr roffit Ns : http://daniel.haxx.se/projects/roffit/

HTML from roff manual source. Dead project?

.El

.\"

.Sh AUTHORS

CVSweb