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\-h\fR, \fB\-?\fR, \fB\-\-help\fR
  45 Display a help message and exit.
  46 .SH TEMPLATE FORMAT
  47 The template file is an XSLT which needs to process the following input XML
  48 document:
  49 .nf
  50
  51   <Page>
  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>
  59   </Page>
  60
  61 .fi
  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:
  66 .RS
  67 .ne 8
  68 .TP
  69 .I .CollectionTitle
  70 .TP
  71 .I .PageTitle
  72 .TP
  73 .I .Summary
  74 .TP
  75 .I .Signature
  76 .TP
  77 .I .Remarks
  78 .TP
  79 .I .Members
  80 .TP
  81 .I .Copyright
  82 .TP
  83 .I .Section
  84 .TP
  85 .I .SectionBox
  86 .TP
  87 .I .NamespaceName
  88 .TP
  89 .I .NamespaceSummary
  90 .TP
  91 .I .MemberName
  92 .TP
  93 .I .MemberSignature
  94 .TP
  95 .I .MemberBox
  96 .TP
  97 .I .Subsection
  98 .TP
  99 .I .SubsectionBox
 100 .TP
 101 .I .SignatureTable
 102 .TP
 103 .I .EnumerationsTable
 104 .TP
 105 .I .CodeExampleTable
 106 .TP
 107 .I .MembersListing
 108 .TP
 109 .I .TypesListing
 110 .TP
 111 .I .InnerSignatureTable
 112 .TP
 113 .I .TypePermissionsTable
 114 .ne
 115 .RE
 116 .PP
 117 .SH HTML LINKS
 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.
 121 .PP
 122 See the \fICREF FORMAT\fR section of \fBmdoc\fR(5) for more information.
 123 .SH MAILING LISTS
 124 .TP
 125 Visit http://lists.ximian.com/mailman/listinfo/mono-docs-list for details.
 126 .SH WEB SITE
 127 Visit http://www.mono-project.com/mdoc for details