man/mdoc-export-html.1

   1 .\"
   2 .\" mdoc-export-html manual page.
   3 .\" (C) 2008 Novell, Inc.
   4 .\" Author:
   5 .\"   Jonathan Pryor (jpryor@novell.com)
   6 .\"
   7 .de Sp \" Vertical space (when we can't use .PP)
   8 .if t .sp .5v
   9 .if n .sp
  10 ..
  11 .TH "mdoc-export-html" 1
  12 .SH NAME
  13 mdoc export-html \- Convert \fBmdoc\fR(5) XML to HTML.
  14 .SH SYNOPSIS
  15 \fBmdoc export-html\fR [OPTION]* DIRECTORIES
  16 .SH DESCRIPTION
  17 \fBmdoc export-html\fR creates HTML files from the \fBmdoc\fR(5)-formatted
  18 documentation XML files within \fIDIRECTORIES\fR.
  19 .SH OPTIONS
  20 .TP
  21 .B \-\-default\-template
  22 Writes the default XSLT used to \fIstdout\fR.
  23 .TP
  24 \fB\-\-ext\fR=\fIEXTENSION\fR
  25 The file extension to use for created files.
  26 .Sp
  27 This defaults to \fIhtml\fR.
  28 .TP
  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.
  33 .TP
  34 \fB\-o\fR, \fB\-\-out\fR=\fIDIRECTORY\fR
  35 Write the created files within directory \fIDIRECTORY\fR.
  36 .TP
  37 \fB\-\-template\fR=\fIFILE\fR
  38 An XSLT file to use to generate the created files.
  39 .Sp
  40 If not specified, uses the template produced by \fI\-\-dump\-template\fR.
  41 .Sp
  42 See the \fITEMPLATE FORMAT\fR section below for more information.
  43 .TP
  44 \fB\-\-with\-profile\fR=\fIPROFILE\fR
  45 Only process types and members within the .NET profile \fIPROFILE\fR.
  46 May be specified multiple times.  If not specified, all types and members,
  47 regardless of version, are processed.
  48 .Sp
  49 Valid profiles are:
  50 .nf
  51         monotouch
  52         net_1_0
  53         net_1_1
  54         net_2_0
  55         net_3_0
  56         net_3_5
  57         net_4_0
  58         silverlight
  59 .fi
  60 .TP
  61 \fB\-\-with\-version\fR=\fIVERSION\fR
  62 Only process types and members within the assembly version \fIVERSION\fR.
  63 May be specified multiple times.  If not specified, all types and members,
  64 regardless of version, are processed.
  65 .Sp
  66 \fIVERSION\fR is an assembly version, e.g. 2.0.5.0.
  67 .TP
  68 \fB\-h\fR, \fB\-?\fR, \fB\-\-help\fR
  69 Display a help message and exit.
  70 .SH TEMPLATE FORMAT
  71 The template file is an XSLT which needs to process the following input XML
  72 document:
  73 .nf
  74
  75   <Page>
  76     <CollectionTitle>Collection Title</CollectionTitle>
  77     <PageTitle>Page Title</PageTitle>
  78     <Summary>Page Summary</Summary>
  79     <Signature>Type Declaration</Signature>
  80     <Remarks>Type Remarks</Remarks>
  81     <Members>Type Members</Members>
  82     <Copyright>Documentation Copyright</Copyright>
  83   </Page>
  84
  85 .fi
  86 The generated HTML also makes use of several CSS classes.  You can either use
  87 the \fIcreate-default-style\fR named template found within the
  88 \fI\-\-default\-template\fR output to generate these classes, or explicitly
  89 define the following CSS classes:
  90 .RS
  91 .ne 8
  92 .TP
  93 .I .CollectionTitle
  94 .TP
  95 .I .PageTitle
  96 .TP
  97 .I .Summary
  98 .TP
  99 .I .Signature
 100 .TP
 101 .I .Remarks
 102 .TP
 103 .I .Members
 104 .TP
 105 .I .Copyright
 106 .TP
 107 .I .Section
 108 .TP
 109 .I .SectionBox
 110 .TP
 111 .I .NamespaceName
 112 .TP
 113 .I .NamespaceSummary
 114 .TP
 115 .I .MemberName
 116 .TP
 117 .I .MemberSignature
 118 .TP
 119 .I .MemberBox
 120 .TP
 121 .I .Subsection
 122 .TP
 123 .I .SubsectionBox
 124 .TP
 125 .I .SignatureTable
 126 .TP
 127 .I .EnumerationsTable
 128 .TP
 129 .I .CodeExampleTable
 130 .TP
 131 .I .MembersListing
 132 .TP
 133 .I .TypesListing
 134 .TP
 135 .I .InnerSignatureTable
 136 .TP
 137 .I .TypePermissionsTable
 138 .ne
 139 .RE
 140 .PP
 141 .SH HTML LINKS
 142 All members within the HTML file have an \fIid\fR
 143 attribute to permit linking to a specific member.  The value of the
 144 \fIid\fR attribute is the String ID of the specified member.
 145 .PP
 146 See the \fICREF FORMAT\fR section of \fBmdoc\fR(5) for more information.
 147 .SH MAILING LISTS
 148 .TP
 149 Visit http://lists.ximian.com/mailman/listinfo/mono-docs-list for details.
 150 .SH WEB SITE
 151 Visit http://www.mono-project.com/mdoc for details