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 \fB\-\-ext\fR=\fIEXTENSION\fR
  22 The file extension to use for created files.
  23 .Sp
  24 This defaults to \fIhtml\fR.
  25 .TP
  26 .B \-\-default\-template
  27 Writes the default XSLT used to \fIstdout\fR.
  28 .TP
  29 \fB\-\-template\fR=\fIFILE\fR
  30 An XSLT file to use to generate the created files.
  31 .Sp
  32 If not specified, uses the template produced by \fI\-\-dump\-template\fR.
  33 .Sp
  34 See the \fITEMPLATE FORMAT\fR section below for more information.
  35 .TP
  36 \fB\-o\fR, \fB\-\-out\fR=\fIDIRECTORY\fR
  37 Write the created files within directory \fIDIRECTORY\fR.
  38 .TP
  39 \fB\-h\fR, \fB\-?\fR, \fB\-\-help\fR
  40 Display a help message and exit.
  41 .SH TEMPLATE FORMAT
  42 The template file is an XSLT which needs to process the following input XML
  43 document:
  44 .nf
  45
  46   <Page>
  47     <CollectionTitle>Collection Title</CollectionTitle>
  48     <PageTitle>Page Title</PageTitle>
  49     <Summary>Page Summary</Summary>
  50     <Signature>Type Declaration</Signature>
  51     <Remarks>Type Remarks</Remarks>
  52     <Members>Type Members</Members>
  53     <Copyright>Documentation Copyright</Copyright>
  54   </Page>
  55
  56 .fi
  57 The generated HTML also makes use of several CSS classes.  You can either use
  58 the \fIcreate-default-style\fR named template found within the
  59 \fI\-\-default\-template\fR output to generate these classes, or explicitly
  60 define the following CSS classes:
  61 .RS
  62 .ne 8
  63 .TP
  64 .I .CollectionTitle
  65 .TP
  66 .I .PageTitle
  67 .TP
  68 .I .Summary
  69 .TP
  70 .I .Signature
  71 .TP
  72 .I .Remarks
  73 .TP
  74 .I .Members
  75 .TP
  76 .I .Copyright
  77 .TP
  78 .I .Section
  79 .TP
  80 .I .SectionBox
  81 .TP
  82 .I .NamespaceName
  83 .TP
  84 .I .NamespaceSummary
  85 .TP
  86 .I .MemberName
  87 .TP
  88 .I .MemberSignature
  89 .TP
  90 .I .MemberBox
  91 .TP
  92 .I .Subsection
  93 .TP
  94 .I .SubsectionBox
  95 .TP
  96 .I .SignatureTable
  97 .TP
  98 .I .EnumerationsTable
  99 .TP
 100 .I .CodeExampleTable
 101 .TP
 102 .I .MembersListing
 103 .TP
 104 .I .TypesListing
 105 .TP
 106 .I .InnerSignatureTable
 107 .TP
 108 .I .TypePermissionsTable
 109 .ne
 110 .RE
 111 .PP
 112 .SH HTML LINKS
 113 All members within the HTML file have an \fIid\fR
 114 attribute to permit linking to a specific member.  The value of the
 115 \fIid\fR attribute is the String ID of the specified member.
 116 .PP
 117 See the \fICREF FORMAT\fR section of \fBmdoc\fR(5) for more information.
 118 .SH MAILING LISTS
 119 .TP
 120 Visit http://lists.ximian.com/mailman/listinfo/mono-docs-list for details.
 121 .SH WEB SITE
 122 Visit http://www.mono-project.com/mdoc for details