diff options
author | Jonathan Pryor <jpryor@novell.com> | 2009-08-30 00:32:54 +0400 |
---|---|---|
committer | Jonathan Pryor <jpryor@novell.com> | 2009-08-30 00:32:54 +0400 |
commit | 8ac5f1ce9a22c914f67310d8be0526225c52b5d1 (patch) | |
tree | 041bbb975a6a9f3a41f0e5948f1374d6861d33a9 /man/mdoc.5 | |
parent | 2f3d65b5c3fccdedb61b8d8859d3489242962e55 (diff) |
* man/mdoc.5: Document the new <format/> element.
svn path=/trunk/mono/; revision=140922
Diffstat (limited to 'man/mdoc.5')
-rw-r--r-- | man/mdoc.5 | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/man/mdoc.5 b/man/mdoc.5 index 9690445ce58..5d4102da37f 100644 --- a/man/mdoc.5 +++ b/man/mdoc.5 @@ -401,6 +401,31 @@ The \fIexception\fR element can contain the following elements: \fIsee\fR, and \fItypeparamref\fR. .TP +.I <format type="TYPE">XML_TEXT</format> +The \fI<format/>\fR element is an "escape hatch," for including (possibly XML) +content that is not valid \fBmdoc\fR(5) content. It's the moral equivalent of +\fBperlpod\fR(1) \fI=begin format\fR blocks. + +\fITYPE\fR is the mime type of \fIXML_TEXT\fR. \fBmdoc\fR(5) processors may +skip \fIformat/>\fR blocks of they use a type that isn't supported. + +For example: + +.nf + <format type="text/html"> + <table width="100%"> + <tr><td style="color:red">Hello, world!</td></tr> + </table> + </format> +.fi + +would cause the embedded HTML \fI<table/>\fR element to be inserted inline +into the resulting HTML document when \fBmdoc-export-html\fR(1) processes the +file. (Likewise, it may be skipped if processed by another program.) + +\fIformat/>\fR is intended to simplify importing documentation from existing +documentation sources. It should not be relied upon, if at all possible. +.TP .I <list>XML</list> Create a list or table of items. .I <list/> |