You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
66 lines
2.6 KiB
66 lines
2.6 KiB
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
|
<HTML>
|
|
<HEAD>
|
|
<TITLE>Mini-XML Programmers Manual, Version 2.3</TITLE>
|
|
<META NAME="author" CONTENT="Michael R. Sweet">
|
|
<META NAME="copyright" CONTENT="Copyright 2003-2007">
|
|
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=iso-iso-8859-1">
|
|
<LINK REL="Start" HREF="index.html">
|
|
<LINK REL="Contents" HREF="index.html">
|
|
<LINK REL="Prev" HREF="CommentingYourCode.html">
|
|
<LINK REL="Next" HREF="MiniXMLLicense.html">
|
|
<STYLE TYPE="text/css"><!--
|
|
BODY { font-family: sans-serif }
|
|
H1 { font-family: sans-serif }
|
|
H2 { font-family: sans-serif }
|
|
H3 { font-family: sans-serif }
|
|
H4 { font-family: sans-serif }
|
|
H5 { font-family: sans-serif }
|
|
H6 { font-family: sans-serif }
|
|
SUB { font-size: smaller }
|
|
SUP { font-size: smaller }
|
|
PRE { font-family: monospace }
|
|
A { text-decoration: none }
|
|
--></STYLE>
|
|
</HEAD>
|
|
<BODY>
|
|
<A HREF="index.html">Contents</A>
|
|
<A HREF="CommentingYourCode.html">Previous</A>
|
|
<A HREF="MiniXMLLicense.html">Next</A>
|
|
<HR NOSHADE>
|
|
<H2><A NAME="5_3">Titles, Sections, and Introductions</A></H2>
|
|
<P><TT>Mxmldoc</TT> also provides options to set the title, section, and
|
|
introduction text for the generated documentation. The <TT>--title text</TT>
|
|
option specifies the title for the documentation. The title string is
|
|
usually put in quotes:</P>
|
|
<PRE>
|
|
<KBD>mxmldoc filename.xml \
|
|
--title "My Famous Documentation" \
|
|
>filename.html ENTER</KBD>
|
|
</PRE>
|
|
<P>The <TT>--section name</TT> option specifies the section for the
|
|
documentation. For HTML documentation, the name is placed in a HTML
|
|
comment such as:</P>
|
|
<PRE>
|
|
<!-- SECTION: name -->
|
|
</PRE>
|
|
<P>For man pages, the section name is usually just a number ("3"), or a
|
|
number followed by a vendor name ("3acme"). The section name is used in
|
|
the <TT>.TH</TT> directive in the man page:</P>
|
|
<PRE>
|
|
.TH mylibrary 3acme "My Title" ...
|
|
</PRE>
|
|
<P>The default section name for man page output is "3". There is no
|
|
default section name for HTML output.</P>
|
|
<P>Finally, the <TT>--intro filename</TT> option specifies a file to
|
|
embed after the title and section but before the generated
|
|
documentation. For HTML documentation, the file must consist of valid
|
|
HTML without the usual <TT>DOCTYPE</TT>, <TT>html</TT>, and <TT>body</TT>
|
|
elements. For man page documentation, the file must consist of valid <TT>
|
|
nroff(1)</TT> text.</P>
|
|
<HR NOSHADE>
|
|
<A HREF="index.html">Contents</A>
|
|
<A HREF="CommentingYourCode.html">Previous</A>
|
|
<A HREF="MiniXMLLicense.html">Next</A>
|
|
</BODY>
|
|
</HTML>
|
|
|