=================================================================== RCS file: /cvs/mandoc/Attic/index.7,v retrieving revision 1.1 retrieving revision 1.6 diff -u -p -r1.1 -r1.6 --- mandoc/Attic/index.7 2008/12/04 16:19:52 1.1 +++ mandoc/Attic/index.7 2008/12/07 23:08:23 1.6 @@ -1,11 +1,11 @@ .\" -.Dd $Mdocdate: December 4 2008 $ +.Dd $Mdocdate: December 7 2008 $ .Dt index 7 .Os LOCAL .\" .Sh NAME .Nm mdocml -.Nd compile manpage source into mark-up language +.Nd compile mdoc macros into mark-up language .\" .Sh DESCRIPTION The @@ -21,8 +21,9 @@ and .Nm acts directly on source documents, validating its input and producing a variety of outputs. -.Ss Features -In order to operate properly, +.\" +.Ss Validation +In order to operate sanely, .Nm fully validates its input. This includes, but is not limited to, the following checks: @@ -43,23 +44,93 @@ scope), predefined characters (such as \\*(>= and \\*q), .It correctly-ordered document prelude, +.It +sane argument values (such as those for +.Sq \&.Dt +or +.Sq \&.Sm ) , +.It +and so on. .El -.\" -.Sh ENVIRONMENT +.Pp The .Nm -utility has been tested under Linux and OpenBSD. +utility has been tested under Linux and +.Ox , +specifically on +.Ox +manual source. +.Nm +is +.Ud +.\" +.Ss Filtering +When a block of source has been verified, it's passed to the front-end +fitlers, which format and display data. The +.Nm +utility is invoked with a filter by the +.Fl f +flag. The HTML filter has the following features: +.Pp +.Bl -enum -compact +.It +HTML-4.01 strict compliance. +.It +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. +.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. .\" +.Sh DOWNLOADS +Download +.Nm +at http://mdocml.bsd.lv/mdocml.tgz +.Ns . +.\" - UPDATE ME WITH EVERY RELEASE. ---------------------------------- +The current version is 1.0.0, dated 08/12/2008. +.\" ------------------------------------------------------------------ +.\" +.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 -o index.html index.7 +.D1 % mdocml -fhtml -W -e -o index.html index.7 .\" .Sh SEE ALSO -TODO. +.Bl -ohang +.It Xr rman Ns : http://polyglotman.sourceforge.net/rman.html +Accepts either formatted roff output or source and produces HTML output. +.It Xr man2html Ns : http://www.nongnu.org/man2html/ +Accepts formatted +.Xr nroff 1 +text and produces HTML output. +.It Xr man.cgi Ns : http://www.freebsd.org/cgi/man.cgi/source +.Fx +and +.Ox +project CGI for producing HTML from nroff source. +.El .\" .Sh AUTHORS The .Nm utility was written by -.An Em Kristaps Dzonsons Aq kristaps@kth.se . +.An Kristaps Dzonsons Aq kristaps@kth.se .