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

DESCRIPTION

12       monodocs2html  has  been  obsoleted  by  mdoc(1).  See the mdoc-export-
13       html(1) man page.
14
15       monodocs2html is a program that creates  HTML  documentation  from  the
16       Monodoc documentation XML files.
17

OPTIONS

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

TEMPLATE FORMAT

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

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

MAILING LISTS

121       Visit    http://lists.ximian.com/mailman/listinfo/mono-docs-list    for
122       details.
123

WEB SITE

125       Visit http://www.mono-project.com for details
126
127
128
129                                                              monodocs2html(1)
Impressum