mxmldoc(1) [suse man page]

mxmldoc(1)							   Michael Sweet							mxmldoc(1)

NAME

       mxmldoc - mini-xml documentation generator

SYNOPSIS

       mxmldoc --no-output [ filename.xml ] source file(s) ]
       mxmldoc	[  --footer  footerfile ] [ --header headerfile ] [ --intro introfile ] [ --section section ] [ --title title ] [ filename.xml ] [
       source file(s) ] > filename.html
       mxmldoc [ --footer footerfile ] [ --framed basename ] [ --header headerfile ] [ --intro introfile ] [ --section section ] [ --title title ]
       [ filename.xml ] [ source file(s) ]
       mxmldoc --man manpage [ --footer footerfile ] [ --header headerfile ] [ --intro introfile ] [ --section section ] [ --title title ] [ file-
       name.xml ] [ source file(s) ] > filename.man

DESCRIPTION

       mxmldoc scans the specified C and C++ source files to produce an XML representation of globally	accessible  classes,  constants,  enumera-
       tions,  functions, structures, typedefs, unions, and variables - the XML file is updated as necessary. By default, a HTML representation of
       the XML file is written to the standard output.	Use the --no-output option to disable the HTML output.

       Man page source can be generated using the --man option.

       If no source files are specified then the current XML file is converted to the standard output.

       In general, any C or C++ source code is handled by mxmldoc, however it was specifically written to handle code with documentation  that	is
       formatted according to the CUPS Developer Guide which is available at "http://www.cups.org/documentation.php".

OPTIONS

       --footer footerfile
	    Inserts the specified file at the bottom of the output documentation.

       --framed basename
	    Created HTML documentation using frames - one for the table-of-contents and one for the body.

       --header headerfile
	    Inserts the specified file at the top of the output documentation.

       --intro introfile
	    Inserts the specified file before the table of contents.

       --man manpage
	    Generated a man page instead of HTML documentation.

       --no-output
	    Disables generation of documentation on the standard output.

       --section section
	    Sets the section/keywords in the output documentation.

       --title title
	    Sets the title of the output documentation.

SEE ALSO

       mxml(3), Mini-XML Programmers Manual, http://www.minixml.org/

COPYRIGHT

       Copyright 2003-2008 by Michael Sweet.

26 January 2008 						     Mini-XML								mxmldoc(1)

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 -template
	      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 documentation.

	      This directory should contain an index.xml file, the namespace-name.xml files (one for each namespace), and namespace-name  directo-
	      ries (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 monodocer man page for more information.

MAILING LISTS

       Visit http://lists.ximian.com/mailman/listinfo/mono-docs-list for details.

WEB SITE

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

																  monodocs2html(1)