<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<link rel="stylesheet" type="text/css" href="default.css"/>
<title>DoxyComment formatting template</title>
</head>
<body>
<h1>DoxyComment formatting template</h1>
<p class="toc">
<b>Content:</b><br/>
<a href="#latest">Getting the latest version</a><br/>
<a href="#introduction">Introduction</a><br/>
<a href="#req_install">Requirements and installation</a><br/>
<a href="#using_template">Using the template</a><br/>
<a href="#how_it_works">How it works</a><br />
<a href="#quirks">Quirks</a><br/>
</p>
<!-- Getting the latest version section -->
<h2><a id="latest">Getting the latest version</a></h2>
<p>
This package is being updated from time to time. Below you will find links
to the available downloads:
</p>
<p>
<a href="template_change_log.html">View the change log</a>
<br/>
<a href="http://sourceforge.net/project/showfiles.php?group_id=159018">Download the DoxyComment Formatting Template</a>
</p>
<!-- Introduction section -->
<h2><a id="introduction">Introduction</a></h2>
<p>
The DoxyComment formatting template is an xslt processor for
xml files generated by <a href="http://www.doxygen.org">doxygen</a>. The
processor parses the xml output to generate xhtml compliant web pages
similar in structure and design to
<a href="http://msdn.microsoft.com/library/">Microsoft's MSDN library</a>.
The processor embeds (using xml data islands) mshelp2 compliant meta-data
into the generated documents to allow for easy ingest into Micrsoft's Help
Compiler.
</p>
<p>
The package also contains a test sample, which illustrates how the extraction
and generation process can be automated using simple batch scripts.
</p>
<!-- Requirements and installation section -->
<h2><a id="req_install">Requirements and installation</a></h2>
<table>
<tr>
<th>Requirement</th>
<th>Description</th>
</tr>
<tr>
<td><a href="http://www.doxygen.org">Doxygen</a></td>
<td>
Doxygen is used to extract and cross-link documentation from your
source files. Doxygen outputs the documentation in an open xml
format.
</td>
</tr>
<tr>
<td><a href="http://www.xmllab.net/Products/nxslt/tabid/62/Default.aspx">nxslt</a></td>
<td>
nxslt is used to process the xml output from doxygen. The processor
applies various page templates to selected sub-sets of the xml
hierarchy to form the output documentation pages.
</td>
</tr>
<tr>
<td><a href="http://msdn.microsoft.com/vstudio/extend/">Visual Studio 2005 SDK (v2 RTM)</a></td>
<td>
(optional) The SDK contains the Micrsoft Help Compiler 2.0 tools
which can be used to compile and register MSHelp2 collections.
</td>
</tr>
</table>
<!-- Using the template section -->
<h2><a id="using_template">Using the template</a></h2>
<p>
More to come.
</p>
<!-- How it works section -->
<h2><a id="how_it_works">How it works</a></h2>
<p>
More to come.
</p>
<!-- Quirks section -->
<h2><a id="quirks">Quirks</a></h2>
<p>
More to come.
</p>
<!-- Footer starts here -->
<hr/>
<table class="transparent">
<tr>
<td>$Id$</td>
<td rowspan="2">
<a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" style="border:0" alt="Valid XHTML 1.0 Strict" height="31" width="88" /></a>
</td>
<td rowspan="2">
<a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=159018&type=1" style="border:0" width="88" height="31" alt="SourceForge.net Logo" /></a>
</td>
</tr>
<tr>
<td>
Copyright © 2006 by Troels Gram.
</td>
</tr>
</table>
</body>
</html>
DoxyComment Code
[r32]: / trunk / web / template.html Maximize Restore History
Download this file
124 lines (112 with data), 4.2 kB