Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

* man/mdoc-assemble.1: Document //node use within .source files.

svn path=/trunk/mono/; revision=117509
  • Loading branch information...
commit c658c51787b27dab029392cf8e8bdcd963fce87d 1 parent cf0b04d
Jonathan Pryor authored
Showing with 25 additions and 1 deletion.
  1. +4 −0 ChangeLog
  2. +21 −1 man/mdoc-assemble.1
View
4 ChangeLog
@@ -1,3 +1,7 @@
+2008-10-30 Jonathan Pryor <jpryor@novell.com>
+
+ * man/mdoc-assemble.1: Document //node use within .source files.
+
2008-10-27 Jb Evain <jbevain@novell.com>
* data/cecil.pc.in: update version.
View
22 man/mdoc-assemble.1
@@ -31,10 +31,29 @@ The \fI.source\fR file has the following format:
<?xml version="1.0"?>
<monodoc>
+ <node label="LABEL" name="PATH" parent="PARENT">
+ <node label="LABEL2" name="PATH2" />
+ <!-- ... -->
+ </node>
<source provider="PROVIDER" basefile="BASEFILE" path="PATH" />
+ <!-- other <source/> elements -->
</monodoc>
.fi
+The \fI/monodoc/node\fR node is an optional node that specifies where in the
+monodoc tree the documentation should be displayed, and \fI//node\fR elements
+may be nested to any depth to create trees. \fI//node/@label\fR is the label
+that will be displayed within the monodoc tree.
+.PP
+\fI//node/@name\fR is the name of the monodoc tree node, and may be used as
+the value of the \fI/monodoc/source/@path\fR value.
+.PP
+\fI//node/@parent\fR is the node name to use as the parent node.
+\fI$MONO_INSTALL_PREFIX/lib/monodoc/monodoc.xml\fR contains a list of such
+names, and this can be any \fI//node/@name\fR value. If the
+\fI//node/@parent\fR value isn't found, then it's inserted under the
+"Various" tree node.
+.PP
The \fI/monodoc/source/@provider\fR attribute specifies which format provider
should be used when reading the \fI.tree\fR and \fI.zip\fR files; this
\fImust\fR correspond to one of the \fI--format\fR values.
@@ -47,7 +66,8 @@ value.
The \fI/monodoc/source/@path\fR attribute specifies the parent node in
\fBmonodoc\fR(1)'s tree view where the documentation will be inserted.
See the \fI$MONO_INSTALL_PREFIX/lib/monodoc/monodoc.xml\fR
-file for a list of \fIPATH\fR values (the \fI//node/@name\fR values).
+file for a list of \fIPATH\fR values (the \fI//node/@name\fR values), or it
+may be a \fI//node/@name\fR value in the same \fI.source\fR file.
.PP
Once the \fIBASEFILE.source\fR has been written, the documentation can be
installed so that \fBmonodoc\fR(1) will display the documentation with the
Please sign in to comment.
Something went wrong with that request. Please try again.