2 .\" mdoc-export-html manual page.
3 .\" (C) 2008 Novell, Inc.
5 .\" Jonathan Pryor (jpryor@novell.com)
7 .de Sp \" Vertical space (when we can't use .PP)
11 .TH "mdoc-export-html" 1
13 mdoc export-html \- Convert \fBmdoc\fR(5) XML to HTML.
15 \fBmdoc export-html\fR [OPTION]* DIRECTORIES
17 \fBmdoc export-html\fR creates HTML files from the \fBmdoc\fR(5)-formatted
18 documentation XML files within \fIDIRECTORIES\fR.
21 .B \-\-default\-template
22 Writes the default XSLT used to \fIstdout\fR.
24 \fB\-\-ext\fR=\fIEXTENSION\fR
25 The file extension to use for created files.
27 This defaults to \fIhtml\fR.
29 \fB\-\-force-update\fR
30 Always generate new files. If not specified,
31 will only generate a new output file if the source
32 documentation file is newer than the target output file.
34 \fB\-o\fR, \fB\-\-out\fR=\fIDIRECTORY\fR
35 Write the created files within directory \fIDIRECTORY\fR.
37 \fB\-\-template\fR=\fIFILE\fR
38 An XSLT file to use to generate the created files.
40 If not specified, uses the template produced by \fI\-\-dump\-template\fR.
42 See the \fITEMPLATE FORMAT\fR section below for more information.
44 \fB\-h\fR, \fB\-?\fR, \fB\-\-help\fR
45 Display a help message and exit.
47 The template file is an XSLT which needs to process the following input XML
52 <CollectionTitle>Collection Title</CollectionTitle>
53 <PageTitle>Page Title</PageTitle>
54 <Summary>Page Summary</Summary>
55 <Signature>Type Declaration</Signature>
56 <Remarks>Type Remarks</Remarks>
57 <Members>Type Members</Members>
58 <Copyright>Documentation Copyright</Copyright>
62 The generated HTML also makes use of several CSS classes. You can either use
63 the \fIcreate-default-style\fR named template found within the
64 \fI\-\-default\-template\fR output to generate these classes, or explicitly
65 define the following CSS classes:
103 .I .EnumerationsTable
111 .I .InnerSignatureTable
113 .I .TypePermissionsTable
118 All members within the HTML file have an \fIid\fR
119 attribute to permit linking to a specific member. The value of the
120 \fIid\fR attribute is the String ID of the specified member.
122 See the \fICREF FORMAT\fR section of \fBmdoc\fR(5) for more information.
125 Visit http://lists.ximian.com/mailman/listinfo/mono-docs-list for details.
127 Visit http://www.mono-project.com/mdoc for details