1mdoc-export-html(1)         General Commands Manual        mdoc-export-html(1)
2
3
4

NAME

6       mdoc export-html - Convert mdoc(5) XML to HTML.
7

SYNOPSIS

9       mdoc export-html [OPTION]* DIRECTORIES
10

DESCRIPTION

12       mdoc export-html creates HTML files from the mdoc(5)-formatted documen‐
13       tation XML files within DIRECTORIES.
14

OPTIONS

16       --default-template
17              Writes the default XSLT used to stdout.
18
19       --ext=EXTENSION
20              The file extension to use for created files.
21
22              This defaults to html.
23
24       --force-update
25              Always generate new files.  If not specified, will only generate
26              a new output file if the source documentation file is newer than
27              the target output file.
28
29       -o, --out=DIRECTORY
30              Write the created files within directory DIRECTORY.
31
32       --template=FILE
33              An XSLT file to use to generate the created files.
34
35              If not specified, uses the template produced by --dump-template.
36
37              See the TEMPLATE FORMAT section below for more information.
38
39       --with-profile=PROFILE
40              Only process types and members within the .NET profile  PROFILE.
41              May  be  specified  multiple times.  If not specified, all types
42              and members, regardless of version, are processed.
43
44              Valid profiles are:
45                   monotouch
46                   net_1_0
47                   net_1_1
48                   net_2_0
49                   net_3_0
50                   net_3_5
51                   net_4_0
52                   silverlight
53
54       --with-version=VERSION
55              Only process types and members within the assembly version  VER‐
56              SION.   May  be specified multiple times.  If not specified, all
57              types and members, regardless of version, are processed.
58
59              VERSION is an assembly version, e.g. 2.0.5.0.
60
61       -h, -?, --help
62              Display a help message and exit.
63

TEMPLATE FORMAT

65       The template file is an XSLT which needs to process the following input
66       XML document:
67
68         <Page>
69           <CollectionTitle>Collection Title</CollectionTitle>
70           <PageTitle>Page Title</PageTitle>
71           <Summary>Page Summary</Summary>
72           <Signature>Type Declaration</Signature>
73           <Remarks>Type Remarks</Remarks>
74           <Members>Type Members</Members>
75           <Copyright>Documentation Copyright</Copyright>
76         </Page>
77
78       The  generated  HTML  also  makes  use of several CSS classes.  You can
79       either use the create-default-style named  template  found  within  the
80       --default-template  output  to  generate  these  classes, or explicitly
81       define the following CSS classes:
82
83              .CollectionTitle
84
85              .PageTitle
86
87              .Summary
88
89              .Signature
90
91              .Remarks
92
93              .Members
94
95              .Copyright
96
97              .Section
98
99              .SectionBox
100
101              .NamespaceName
102
103              .NamespaceSummary
104
105              .MemberName
106
107              .MemberSignature
108
109              .MemberBox
110
111              .Subsection
112
113              .SubsectionBox
114
115              .SignatureTable
116
117              .EnumerationsTable
118
119              .CodeExampleTable
120
121              .MembersListing
122
123              .TypesListing
124
125              .InnerSignatureTable
126
127              .TypePermissionsTable
128

130       All members within the HTML file have an id attribute to permit linking
131       to  a  specific member.  The value of the id attribute is the String ID
132       of the specified member.
133
134       See the CREF FORMAT section of mdoc(5) for more information.
135

MAILING LISTS

137       Visit    http://lists.ximian.com/mailman/listinfo/mono-docs-list    for
138       details.
139

WEB SITE

141       Visit http://www.mono-project.com/mdoc for details
142
143
144
145                                                           mdoc-export-html(1)
Impressum