1monodocs2html(1)            General Commands Manual           monodocs2html(1)
2
3
4

NAME

6       monodocs2html - Translate Monodoc XML to HTML
7

SYNOPSIS

9       monodocs2html -source:SOURCE_DIR -dest:DEST_DIR [OPTIONS]*
10

OPTIONS

12       -dest:DEST_DIR
13              Write the HTML files into the directory DEST_DIR .
14
15       -dumptemplate
16              Dump  the  default  page template to standard output so that you
17              can use it as a base for a new template for use with  the  -tem‐
18              plate option.
19
20       -ext:FILE_EXTENSION
21              FILE_EXTENSION is the file extension for generated files.
22
23              This defaults to html .
24
25       -?, -help
26              Show program argument information.
27
28       -onlytype:TYPE
29              Only generate HTML for the type TYPE .
30
31       -source:SOURCE_DIR
32              SOURCE_DIR is the base directory containing the Monodoc XML doc‐
33              umentation.
34
35              This directory should contain an index.xml file, the  namespace-
36              name.xml  files  (one  for  each  namespace), and namespace-name
37              directories (one for each namespace),  which  will  contain  the
38              type.xml files holding the monodoc documentation.
39
40       -template:TEMPLATE
41              Generate HTML using the page template TEMPLATE .
42
43       -V, -version
44              Display version and licensing information.
45

DESCRIPTION

47       monodocs2html  is  a  program  that creates HTML documentation from the
48       Monodoc documentation XML files.
49

TEMPLATE FORMAT

51       The template file is an XSLT which needs to process the following input
52       XML document:
53            <Page>
54              <CollectionTitle>Collection Title</CollectionTitle>
55              <PageTitle>Page Title</PageTitle>
56              <Summary>Page Summary</Summary>
57              <Signature>Type Declaration</Signature>
58              <Remarks>Type Remarks</Remarks>
59              <Members>Type Members</Members>
60              <Copyright>Documentation Copyright</Copyright>
61            </Page>
62       The  generated  HTML also makes use of the following CSS classes, which
63       should be defined so that output is nicely formatted:
64
65              .CollectionTitle
66
67              .PageTitle
68
69              .Summary
70
71              .Signature
72
73              .Remarks
74
75              .Members
76
77              .Copyright
78
79              .Section
80
81              .SectionBox
82
83              .NamespaceName
84
85              .NamespaceSummary
86
87              .MemberName
88
89              .MemberSignature
90
91              .MemberBox
92
93              .Subsection
94
95              .SubsectionBox
96
97              .SignatureTable
98
99              .EnumerationsTable
100
101              .CodeExampleTable
102
103              .MembersListing
104
105              .TypesListing
106
107              .InnerSignatureTable
108
109              .TypePermissionsTable
110

112       All members within the HTML file have a id attribute to permit  linking
113       to  a  specific member.  The value of the id attribute is the String ID
114       of the specified member.  See the STRING ID FORMAT section of the  mon‐
115       odocer man page for more information.
116

MAILING LISTS

118       Visit    http://lists.ximian.com/mailman/listinfo/mono-docs-list    for
119       details.
120

WEB SITE

122       Visit http://www.mono-project.com for details
123
124
125
126                                                              monodocs2html(1)
Impressum