Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
monodocs2html(1)	    General Commands Manual	      monodocs2html(1)

NAME
       monodocs2html - Translate Monodoc XML to	HTML

SYNOPSIS
       monodocs2html -source:SOURCE_DIR	-dest:DEST_DIR [OPTIONS]*

DESCRIPTION
       monodocs2html  has  been	 obsoleted  by	mdoc(1).  See the mdoc-export-
       html(1) man page.

       monodocs2html is	a program that creates	HTML  documentation  from  the
       Monodoc documentation XML files.

OPTIONS
       -dest:DEST_DIR
	      Write the	HTML files into	the directory DEST_DIR .

       -dumptemplate
	      Dump  the	 default  page template	to standard output so that you
	      can use it as a base for a new template for use with  the	 -tem-
	      plate option.

       -ext:FILE_EXTENSION
	      FILE_EXTENSION is	the file extension for generated files.

	      This defaults to html .

       -?, -help
	      Show program argument information.

       -onlytype:TYPE
	      Only generate HTML for the type TYPE .

       -source:SOURCE_DIR
	      SOURCE_DIR is the	base directory containing the Monodoc XML doc-
	      umentation.

	      This directory should contain an index.xml file, the  namespace-
	      name.xml	files (one for each namespace),	and namespace-name di-
	      rectories	(one for  each	namespace),  which  will  contain  the
	      type.xml files holding the monodoc documentation.

       -template:TEMPLATE
	      Generate HTML using the page template TEMPLATE .

       -V, -version
	      Display version and licensing information.

TEMPLATE FORMAT
       The template file is an XSLT which needs	to process the following input
       XML document:
	    <Page>
	      <CollectionTitle>Collection Title</CollectionTitle>
	      <PageTitle>Page Title</PageTitle>
	      <Summary>Page Summary</Summary>
	      <Signature>Type Declaration</Signature>
	      <Remarks>Type Remarks</Remarks>
	      <Members>Type Members</Members>
	      <Copyright>Documentation Copyright</Copyright>
	    </Page>
       The generated HTML also makes use of the	following CSS  classes,	 which
       should be defined so that output	is nicely formatted:

	      .CollectionTitle

	      .PageTitle

	      .Summary

	      .Signature

	      .Remarks

	      .Members

	      .Copyright

	      .Section

	      .SectionBox

	      .NamespaceName

	      .NamespaceSummary

	      .MemberName

	      .MemberSignature

	      .MemberBox

	      .Subsection

	      .SubsectionBox

	      .SignatureTable

	      .EnumerationsTable

	      .CodeExampleTable

	      .MembersListing

	      .TypesListing

	      .InnerSignatureTable

	      .TypePermissionsTable

HTML LINKS
       All  members within the HTML file have a	id attribute to	permit linking
       to a specific member.  The value	of the id attribute is the  String  ID
       of  the specified member.  See the STRING ID FORMAT section of the mon-
       odocer man page for more	information.

MAILING	LISTS
       Visit http://lists.ximian.com/mailman/listinfo/mono-docs-list  for  de-
       tails.

WEB SITE
       Visit http://www.mono-project.com for details

							      monodocs2html(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | TEMPLATE FORMAT | HTML LINKS | MAILING LISTS | WEB SITE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=monodocs2html&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help