chapter_4_section_2.html [plain text]
<html>
<head>
<META NAME="Generator" CONTENT="Gutenberg">
<META NAME="GeneratorVersion" CONTENT="v100.1">
<META http-equiv="content-type" CONTENT="text/html;charset=iso-8859-1">
<META NAME = "Copyright" CONTENT="Copyright 2004 Apple Computer, Inc. All Rights Reserved.">
<TITLE>Tools: HeaderDoc Unfettered: Running gatherHeaderDoc.pl</TITLE>
<base target="content">
<LINK REL="stylesheet" TYPE="text/css" HREF="../Resources/CSS/frameset_styles.css">
<style type="text/css"></style>
<script language="JavaScript" src="../Resources/JavaScript/page.js"></script>
</head>
<BODY bgcolor="#ffffff" onload="initialize_page();"><a name="//apple_ref/doc/uid/TP40001215-CH350-DontLinkElementID_1072" title="Running gatherHeaderDoc.pl" turn_anchor="no"></a>
<a name="top"></a>
<!-- start of header -->
<!--#include virtual="/includes/framesetheader" -->
<!-- end of header -->
<!-- start of path -->
<div class="breadcrumb"><a href="http://developer.apple.com/" target="_top">ADC Home</a> > <!--a logicalPath="//apple_ref/doc/uid/TP30000943" -->Reference Library<!--/a--> > <!--a logicalPath="//apple_ref/doc/uid/TP30000440" -->Documentation<!--/a--> > <!--a logicalPath="//apple_ref/doc/uid/TP30000436" -->Tools<!--/a--> > <a logicalPath="//apple_ref/doc/uid/TP40001215-CH345" href="../intro/chapter_1_section_1.html#//apple_ref/doc/uid/TP40001215-CH345">HeaderDoc Unfettered</a> > <a logicalPath="//apple_ref/doc/uid/TP40001215-CH350" href="chapter_4_section_1.html#//apple_ref/doc/uid/TP40001215-CH350">Using gatherHeaderDoc</a> > </div><br>
<!-- end of path -->
<table width="100%" cellpadding=0 cellspacing=0 border=0 class="mini_nav_text"><tr>
<td align=left scope="row">
<!-- insert Show/Hide frames -->
<script type="text/javascript" language="JavaScript"><!--
if (self != top) {
document.write('<a href="'+self.location+'" target="_top"><img src="../Resources/Images/show_toc_icon.gif" width="15" height="14" border="0" style="margin-bottom: -2px;" alt=""></a> <a href="'+self.location+'" target="_top">Hide TOC</a>');
}
else {
document.write('<a href="../index.html?'+self.location+'" target="_top"><img src="../Resources/Images/show_toc_icon.gif" width="15" height="14" border="0" style="margin-bottom: -2px;" alt=""></a> <a href="../index.html?'+self.location+'" target="_top">Show TOC</a>');
}
<!-- end Show/Hide frames -->
</td><td align=right>
<a href="chapter_4_section_1.html" target="_self">< Previous Page</a><span style="margin-left: 8px"><a href="chapter_4_section_3.html" target="_self">Next Page ></a></span>
</td>
</tr></table>
<hr>
<br><h2>Running gatherHeaderDoc.pl</h2>
<p>The <code>gatherHeaderDoc.pl</code> script scans an
input directory (recursively) for any documentation generated by
headerDoc2HTML. It creates a master table of contents (named <code>masterTOC.html</code> by
default—the name can be changed by setting a new name in the configuration
file or by specifying a second argument). It also adds a “top”
link to all the documentation sets it visits to make it easier to
navigate back to the master table of contents. </p>
<p>Here's an example of how to create documentation for a number
of headers (the sample ones provided with the scripts) and then
generate a master table of contents:</p>
<table><table cellpadding="8" width="100%" bgcolor="#F1F5F9" style="border: 1px solid #C9D1D7;"><tr><td scope="row"><table bgcolor="#F1F5F9" width="100%" border="0" cellspacing="0" cellpadding="0"><tr><td><pre><code> > headerdoc2html -o OutputDir ExampleHeaders</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code> > gatherheaderdoc OutputDir</code></pre></td><td><code><pre></pre></code></td></tr></table></td></tr></table></table>
<p>You can now open the file <tt>OutputDir/masterTOC.html</tt> in
your browser to see the interlinked sets of documentation.</p>
<p>You can also add a second argument to change the output file
name. For example:</p>
<table><table cellpadding="8" width="100%" bgcolor="#F1F5F9" style="border: 1px solid #C9D1D7;"><tr><td scope="row"><table bgcolor="#F1F5F9" width="100%" border="0" cellspacing="0" cellpadding="0"><tr><td><pre><code> > headerdoc2html -o OutputDir ExampleHeaders</code></pre></td><td><code><pre></pre></code></td></tr><tr><td scope="row"><pre><code> > gatherheaderdoc OutputDir MYTOCNAME.html</code></pre></td><td><code><pre></pre></code></td></tr></table></td></tr></table></table>
<p>This time, gatherHeaderDoc created the file <tt>OutputDir/MYTOCNAME.html</tt> instead
of <tt>OutputDir/masterTOC.html</tt>.</p>
<p>For more information on configuring gatherHeaderDoc, see <span class="content_text"><a logicalPath="//apple_ref/doc/uid/TP40001215-CH348-CEGJFJIB" href="../config/chapter_6_section_1.html#//apple_ref/doc/uid/TP40001215-CH348-CEGJFJIB">“Configuring HeaderDoc”</a></span>.</p>
<br><br>
<table width="100%" cellpadding=0 cellspacing=0 border=0 class="mini_nav_text"><tr>
<td align=left scope="row">
<!-- insert Show/Hide frames -->
<script type="text/javascript" language="JavaScript"><!--
if (self != top) {
// loaded in frames
document.write('<a href="'+self.location+'" target="_top"><img src="../Resources/Images/show_toc_icon.gif" width="15" height="14" border="0" style="margin-bottom: -2px;" alt=""></a> <a href="'+self.location+'" target="_top">Hide TOC</a>');
}
else {
// not loaded frames
document.write('<a href="../index.html?'+self.location+'" target="_top"><img src="../Resources/Images/show_toc_icon.gif" width="15" height="14" border="0" style="margin-bottom: -2px;" alt=""></a> <a href="../index.html?'+self.location+'" target="_top">Show TOC</a>');
}
//--></script>
<!-- end Show/Hide frames -->
</td><td align=right>
<a href="chapter_4_section_1.html" target="_self">< Previous Page</a><span style="margin-left: 8px"><a href="chapter_4_section_3.html" target="_self">Next Page ></a></span>
</td>
</tr></table>
<br><hr><p class="content_text"> <!--#if expr="0=1" -->© 1999, 2004 Apple Computer, Inc. All Rights Reserved. (<!--#endif -->Last updated: 2004-05-27<!--#if expr="0=1" -->)<!--#endif --></p>
<!-- start of footer -->
<!--#include virtual="/includes/framesetfooter" -->
<!-- end of footer -->
</BODY>
</html>