blob: 8c78db1a59c7a1fbe8598d068be7866a9680f045 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
.\"
.\" monodocs2html manual page.
.\" (C) 2006 Jonathan Pryor
.\" Author:
.\" Jonathan Pryor (jonpryor@vt.edu)
.\"
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.TH "monodocs2html" 1
.SH NAME
monodocs2html \- Translate Monodoc XML to HTML
.SH SYNOPSIS
.B monodocs2html
\-source:SOURCE_DIR \-dest:DEST_DIR
[OPTIONS]*
.SH DESCRIPTION
\fImonodocs2html\fR has been obsoleted by \fBmdoc\fR(1). See the
\fBmdoc-export-html\fR(1) man page.
.PP
.I monodocs2html
is a program that creates HTML documentation from the Monodoc documentation
XML files.
.SH OPTIONS
.TP
.I \-dest:DEST_DIR
Write the HTML files into the directory
.I DEST_DIR
\&.
.TP
.I \-dumptemplate
Dump the default page template to standard output so that you can use it as a
base for a new template for use with the
.I \-template
option.
.TP
.I \-ext:FILE_EXTENSION
.I FILE_EXTENSION
is the file extension for generated files.
.Sp
This defaults to
.I html
\&.
.TP
.I \-?, \-help
Show program argument information.
.TP
.I \-onlytype:TYPE
Only generate HTML for the type
.I TYPE
\&.
.TP
.I \-source:SOURCE_DIR
.I SOURCE_DIR
is the base directory containing the Monodoc XML documentation.
.Sp
This directory should contain an
.I index.xml
file, the
.I namespace-name.xml
files (one for each namespace), and
.I namespace-name
directories (one for each namespace), which will contain the
.I type.xml
files holding the monodoc documentation.
.TP
.I \-template:TEMPLATE
Generate HTML using the page template
.I TEMPLATE
\&.
.TP
.I \-V, \-version
Display version and licensing information.
.SH TEMPLATE FORMAT
The template file is an XSLT which needs to process the following input XML
document:
.nf
<Page>
<CollectionTitle>Collection Title</CollectionTitle>
<PageTitle>Page Title</PageTitle>
<Summary>Page Summary</Summary>
<Signature>Type Declaration</Signature>
<Remarks>Type Remarks</Remarks>
<Members>Type Members</Members>
<Copyright>Documentation Copyright</Copyright>
</Page>
.fi
The generated HTML also makes use of the following CSS classes, which should
be defined so that output is nicely formatted:
.RS
.ne 8
.TP
.I .CollectionTitle
.TP
.I .PageTitle
.TP
.I .Summary
.TP
.I .Signature
.TP
.I .Remarks
.TP
.I .Members
.TP
.I .Copyright
.TP
.I .Section
.TP
.I .SectionBox
.TP
.I .NamespaceName
.TP
.I .NamespaceSummary
.TP
.I .MemberName
.TP
.I .MemberSignature
.TP
.I .MemberBox
.TP
.I .Subsection
.TP
.I .SubsectionBox
.TP
.I .SignatureTable
.TP
.I .EnumerationsTable
.TP
.I .CodeExampleTable
.TP
.I .MembersListing
.TP
.I .TypesListing
.TP
.I .InnerSignatureTable
.TP
.I .TypePermissionsTable
.ne
.RE
.SH HTML LINKS
All members within the HTML file have a
.I id
attribute to permit linking to a specific member. The value of the
.I id
attribute is the String ID of the specified member.
See the
.B STRING ID FORMAT
section of the
.B monodocer
man page for more information.
.SH MAILING LISTS
.TP
Visit http://lists.ximian.com/mailman/listinfo/mono-docs-list for details.
.SH WEB SITE
Visit http://www.mono-project.com for details
|
