chapter_4_section_3.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: Creating a TOC Template File</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-BABHAEAC" title="Creating a TOC Template File" 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_2.html" target="_self">< Previous Page</a><span style="margin-left: 8px"><a href="chapter_4_section_4.html" target="_self">Next Page ></a></span>
</td>
</tr></table>
<hr>
<a name="BABHAEAC" title="Creating a TOC Template File" turn_anchor="no"></a><br><h2>Creating a TOC Template File</h2>
<p>TOC template files are basically ordinary HTML files. They
can contain any HTML content. In addition to HTML content, they
can also contain conditional HTML content—that is, content that
is only included if certain conditions are met. Finally, they can
include various lists.</p>
<p>The template support is particularly powerful when combined
with support for frameworks (which, for HeaderDoc purposes, is essentially
a loose grouping of related documentation stored in the same output
directory).</p>
<p>Here are the special tags that indicate conditional or list
content:</p>
<p></p>
<dl class="content_text"><br><dt class="content_text"><tt>$$title@@</tt></dt>
<dd class="content_text">Inserts “Foo Documentation” where Foo is the framework
name.</dd>
<br><dt class="content_text"><tt>$$tocname@@</tt></dt>
<dd class="content_text">Inserts the name of the main TOC file. Useful when used
with multiple landing page templates, as described in <span class="content_text"><a logicalPath="//apple_ref/doc/uid/TP40001215-CH350-BEJEFDGF" href="chapter_4_section_4.html#//apple_ref/doc/uid/TP40001215-CH350-BEJEFDGF">“Using Multiple Landing Page Templates”</a></span>.</dd>
<br><dt class="content_text"><tt>$$framework@@</tt></dt>
<dd class="content_text">Inserts the framework name.</dd>
<br><dt class="content_text"><tt>$$frameworkdir@@</tt></dt>
<dd class="content_text">Inserts the framework directory name (the name of the
“<code>.hdoc</code>” file without the extension). This
is useful when used with multiple landing page templates, as described
in <span class="content_text"><a logicalPath="//apple_ref/doc/uid/TP40001215-CH350-BEJEFDGF" href="chapter_4_section_4.html#//apple_ref/doc/uid/TP40001215-CH350-BEJEFDGF">“Using Multiple Landing Page Templates”</a></span>.</dd>
<br><dt class="content_text"><tt>$$frameworkdiscussion@@</tt></dt>
<dd class="content_text">Inserts the framework discussion.</dd>
<br><dt class="content_text"><tt>$$frameworkabstract@@</tt></dt>
<dd class="content_text">Inserts the framework abstract.</dd>
<br><dt class="content_text"><tt>$$headersection@@</tt></dt>
<dd class="content_text">Start of conditional block for headers. If there are
no headers listed, content between this tag and the closing conditional
block tag will not appear.</dd>
<br><dt class="content_text"><tt>$$/headersection@@</tt></dt>
<dd class="content_text">End of conditional block for headers.</dd>
<br><dt class="content_text"><tt>$$headerlist@@</tt></dt>
<dd class="content_text">A list of all headers in the output directory.</dd>
<br><dt class="content_text"><tt>$$classsection@@</tt></dt>
<dd class="content_text">Start of conditional block for classes. If there are
no classes listed, content between this tag and the closing conditional
block tag will not appear.</dd>
<br><dt class="content_text"><tt>$$/classsection@@</tt></dt>
<dd class="content_text">End of conditional block for classes.</dd>
<br><dt class="content_text"><tt>$$classlist@@</tt></dt>
<dd class="content_text">A list of all classes in the output directory.</dd>
<br><dt class="content_text"><tt>$$categorysection@@</tt></dt>
<dd class="content_text">Start of conditional block for categories. If there
are no categories listed, content between this tag and the closing
conditional block tag will not appear.</dd>
<br><dt class="content_text"><tt>$$/categorysection@@</tt></dt>
<dd class="content_text">End of conditional block for categories.</dd>
<br><dt class="content_text"><tt>$$categorylist@@</tt></dt>
<dd class="content_text">A list of all categories in the output directory.</dd>
<br><dt class="content_text"><tt>$$protocolsection@@</tt></dt>
<dd class="content_text">Start of conditional block for protocols. If there are
no protocols listed, content between this tag and the closing conditional
block tag will not appear.</dd>
<br><dt class="content_text"><tt>$$/protocolsection@@</tt></dt>
<dd class="content_text">End of conditional block for protocols.</dd>
<br><dt class="content_text"><tt>$$protocollist@@</tt></dt>
<dd class="content_text">A list of all protocols in the output directory.</dd>
<br><dt class="content_text"><tt>$$datasection@@</tt></dt>
<dd class="content_text">Start of conditional block for data (globals and constants).
If there are no data elements listed, content between this tag and
the closing conditional block tag will not appear.</dd>
<br><dt class="content_text"><tt>$$/datasection@@</tt></dt>
<dd class="content_text">End of conditional block for data (globals and constants).</dd>
<br><dt class="content_text"><tt>$$datalist@@</tt></dt>
<dd class="content_text">A list of all data elements in the output directory.</dd>
<br><dt class="content_text"><tt>$$typesection@@</tt></dt>
<dd class="content_text">Start of conditional block for types. If there are no
types listed, content between this tag and the closing conditional
block tag will not appear.</dd>
<br><dt class="content_text"><tt>$$/typesection@@</tt></dt>
<dd class="content_text">End of conditional block for types.</dd>
<br><dt class="content_text"><tt>$$typelist@@</tt></dt>
<dd class="content_text">A list of all types in the output directory.</dd>
<br><dt class="content_text"><tt>$$functionsection@@</tt></dt>
<dd class="content_text">Start of conditional block for functions or methods.
If there are no functions or methods listed, content between this
tag and the closing conditional block tag will not appear.</dd>
<br><dt class="content_text"><tt>$$/functionsection@@</tt></dt>
<dd class="content_text">End of conditional block for functions or methods.</dd>
<br><dt class="content_text"><tt>$$functionlist@@</tt></dt>
<dd class="content_text">A list of all functions/methods in the output directory.</dd></dl>
<p>List tags default to a raw list (single column) with no border.
However, you can change the number of columns, the table width,
and border quite easily. 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> $$functionlist cols=3 order=down atts=border=”0” cellpadding=”1” cellspacing=”0” width=”420”@@</code></pre></td><td><code><pre></pre></code></td></tr></table></td></tr></table></table>
<p>specifies that the table will be three columns, listed down
the first column, then down the next column, and so on. It also
specifies that the additional attributes <tt>border</tt>, <tt>cellpadding</tt>, <tt>cellspacing</tt>,
and <tt>width</tt> will be inserted
into the table tag automatically. Note that the <tt>atts</tt> parameter
must be the last parameter listed.</p>
<p> </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) {
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_2.html" target="_self">< Previous Page</a><span style="margin-left: 8px"><a href="chapter_4_section_4.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>