diff options
author | Kristaps Dzonsons <kristaps@bsd.lv> | 2008-12-15 01:54:58 +0000 |
---|---|---|
committer | Kristaps Dzonsons <kristaps@bsd.lv> | 2008-12-15 01:54:58 +0000 |
commit | 8c40cedbf308bc349ccfa8ac9e9a396c6e23a32b (patch) | |
tree | 635233a1182c9fb9bf7042ec55b79e6086ea481d /index.7 | |
parent | 497b7df8efa21274a9619e06469f928c44ad7cfb (diff) | |
download | mandoc-8c40cedbf308bc349ccfa8ac9e9a396c6e23a32b.tar.gz |
Purged all old files in favour of new design. Selective reintegration.
Diffstat (limited to 'index.7')
-rw-r--r-- | index.7 | 156 |
1 files changed, 0 insertions, 156 deletions
diff --git a/index.7 b/index.7 deleted file mode 100644 index 6e3dc723..00000000 --- a/index.7 +++ /dev/null @@ -1,156 +0,0 @@ -.\" -.Dd $Mdocdate$ -.Dt index 7 -.Os LOCAL -.\" -.Sh NAME -.Nm mdocml -.Nd compile mdoc macros into mark-up language -.\" -.Sh DESCRIPTION -The -.Nm -utility compiles -.Xr mdoc 7 -macros, such as those inheriting from -.Xr mdoc.samples 7 , -into XML or HTML documents. Unlike other similar utilities such as -.Xr rman 1 -and -.Xr man2html 1 , -.Nm -is a full macro parser operating on source documents, specifically mdoc, -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 -is -.Ud -.\" -.Ss Validation -In order to operate sanely, -.Nm -fully validates its input. This includes, but is not limited to, the -following checks: -.Pp -.Bl -enum -compact -.It -valid special characters (such as -.Sq \en -and -.Sq \et ) , -.It -sane macro scope (such as -.Sq \&.Sh -macros clobbering a pending -.Sq \&.Bl -scope), -.It -valid predefined characters (such as \\*(>= and \\*q), -.It -correctly-ordered prelude and sections, -.It -sane macro argument values (such as those for -.Sq \&.Dt -or -.Sq \&.Sm ) , -.It -valid manual sections and systems; -.It -and so on. -.El -.\" -.Ss Filtering -When a line of source has been parsed, it's passed to the output -filters, which format and display data. The two available filters are -HTML and XML. -.Pp -The HTML filter has the following features: -.Pp -.Bl -enum -compact -.It -HTML-4.01 strict compliance; -.It -proper rendering 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; -.It -and so on. -.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 DOWNLOADS -Download -.Nm -at http://mdocml.bsd.lv/mdocml.tar.gz -.Ns . -.\" - UPDATE ME WITH EVERY RELEASE. ---------------------------------- -The current version is 1.0.3, dated 10/12/2008. -.\" ------------------------------------------------------------------ -.Pp -An OpenBSD port is available at http://mdocml.bsd.lv/mdocml-port.tar.gz -.Ns . -.Pp -Previous versions are archived as mdocml-x.y.z.tar.gz, 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 -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 -.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. -.It Xr roffit Ns : http://daniel.haxx.se/projects/roffit/ -HTML from roff manual source. Dead project? -.El -.\" -.Sh AUTHORS -The -.Nm -utility was written by -.An Kristaps Dzonsons Aq kristaps@kth.se . |