man/monodocs2html.1

   1 .\"
   2 .\" monodocs2html manual page.
   3 .\" (C) 2006 Jonathan Pryor
   4 .\" Author:
   5 .\"   Jonathan Pryor (jonpryor@vt.edu)
   6 .\"
   7 .de Sp \" Vertical space (when we can't use .PP)
   8 .if t .sp .5v
   9 .if n .sp
  10 ..
  11 .TH "monodocs2html" 1
  12 .SH NAME
  13 monodocs2html \- Translate Monodoc XML to HTML
  14 .SH SYNOPSIS
  15 .B monodocs2html
  16 \-source:SOURCE_DIR \-dest:DEST_DIR
  17 [OPTIONS]*
  18 .SH DESCRIPTION
  19 \fImonodocs2html\fR has been obsoleted by \fBmdoc\fR(1).  See the
  20 \fBmdoc-export-html\fR(1) man page.
  21 .PP
  22 .I monodocs2html
  23 is a program that creates HTML documentation from the Monodoc documentation
  24 XML files.
  25 .SH OPTIONS
  26 .TP
  27 .I \-dest:DEST_DIR
  28 Write the HTML files into the directory
  29 .I DEST_DIR
  30 \&.
  31 .TP
  32 .I \-dumptemplate
  33 Dump the default page template to standard output so that you can use it as a
  34 base for a new template for use with the
  35 .I \-template
  36 option.
  37 .TP
  38 .I \-ext:FILE_EXTENSION
  39 .I FILE_EXTENSION
  40 is the file extension for generated files.
  41 .Sp
  42 This defaults to
  43 .I html
  44 \&.
  45 .TP
  46 .I \-?, \-help
  47 Show program argument information.
  48 .TP
  49 .I \-onlytype:TYPE
  50 Only generate HTML for the type
  51 .I TYPE
  52 \&.
  53 .TP
  54 .I \-source:SOURCE_DIR
  55 .I SOURCE_DIR
  56 is the base directory containing the Monodoc XML documentation.
  57 .Sp
  58 This directory should contain an
  59 .I index.xml
  60 file, the
  61 .I namespace-name.xml
  62 files (one for each namespace), and
  63 .I namespace-name
  64 directories (one for each namespace), which will contain the
  65 .I type.xml
  66 files holding the monodoc documentation.
  67 .TP
  68 .I \-template:TEMPLATE
  69 Generate HTML using the page template
  70 .I TEMPLATE
  71 \&.
  72 .TP
  73 .I \-V, \-version
  74 Display version and licensing information.
  75 .SH TEMPLATE FORMAT
  76 The template file is an XSLT which needs to process the following input XML
  77 document:
  78 .nf
  79         <Page>
  80           <CollectionTitle>Collection Title</CollectionTitle>
  81           <PageTitle>Page Title</PageTitle>
  82           <Summary>Page Summary</Summary>
  83           <Signature>Type Declaration</Signature>
  84           <Remarks>Type Remarks</Remarks>
  85           <Members>Type Members</Members>
  86           <Copyright>Documentation Copyright</Copyright>
  87         </Page>
  88 .fi
  89 The generated HTML also makes use of the following CSS classes, which should
  90 be defined so that output is nicely formatted:
  91 .RS
  92 .ne 8
  93 .TP
  94 .I .CollectionTitle
  95 .TP
  96 .I .PageTitle
  97 .TP
  98 .I .Summary
  99 .TP
 100 .I .Signature
 101 .TP
 102 .I .Remarks
 103 .TP
 104 .I .Members
 105 .TP
 106 .I .Copyright
 107 .TP
 108 .I .Section
 109 .TP
 110 .I .SectionBox
 111 .TP
 112 .I .NamespaceName
 113 .TP
 114 .I .NamespaceSummary
 115 .TP
 116 .I .MemberName
 117 .TP
 118 .I .MemberSignature
 119 .TP
 120 .I .MemberBox
 121 .TP
 122 .I .Subsection
 123 .TP
 124 .I .SubsectionBox
 125 .TP
 126 .I .SignatureTable
 127 .TP
 128 .I .EnumerationsTable
 129 .TP
 130 .I .CodeExampleTable
 131 .TP
 132 .I .MembersListing
 133 .TP
 134 .I .TypesListing
 135 .TP
 136 .I .InnerSignatureTable
 137 .TP
 138 .I .TypePermissionsTable
 139 .ne
 140 .RE
 141 .SH HTML LINKS
 142 All members within the HTML file have a
 143 .I id
 144 attribute to permit linking to a specific member.  The value of the
 145 .I id
 146 attribute is the String ID of the specified member.
 147 See the
 148 .B STRING ID FORMAT
 149 section of the
 150 .B monodocer
 151 man page for more information.
 152 .SH MAILING LISTS
 153 .TP
 154 Visit http://lists.ximian.com/mailman/listinfo/mono-docs-list for details.
 155 .SH WEB SITE
 156 Visit http://www.mono-project.com for details