inline {@toc}

Display a table of contents of all {@id}s declared in a file

by Gregory Beaver
Tag Documentation written by [email protected]
Copyright 2002, Gregory Beaver
(phpDocumentor 1.2+)

{@toc}

Description

The inline {@toc} tag is used as a sub-element of the <refentry> tag to display a table of contents of the current tutorial. This table of contents is generated directly by a call to Converter::formatTutorialTOC().

Example

This sample tutorial:

<refentry id="{@id}">
<refnamediv>
<refname>{@}toc} example</refname>
<refpurpose>Uses {@}toc} to generate a table of contents</refpurpose>
</refnamediv>
{@toc}
<refsect1 id="{@id one}">
<title>First section</title>
</refsect1>
<refsect1 id="{@id two}">
<title>Second section</title>
<refsect2 id="{@id sub}">
<title>Sub-section</title>
</refsect2>
</refsect1>
<refsect1 id="{@id three}">
<title>Third section</title>
</refsect1>
</refentry>

Will parse as if it were

<refentry id="{@id}">
<refnamediv>
<refname>{@}toc} example</refname>
<refpurpose>Uses {@}toc} to generate a table of contents</refpurpose>
</refnamediv>
<refsect1>
<itemizedlist>
<listitem><para>{@tutorial mytutorial#one}</para></listitem>
<listitem><para>{@tutorial mytutorial#two}
<itemizedlist>
<listitem><para>{@tutorial mytutorial#two.sub}</para></listitem>
</itemizedlist>
</para></listitem>
<listitem><para>{@tutorial mytutorial#three}</para></listitem>
</refsect1>
<refsect1 id="{@id one}">
<title>First section</title>
</refsect1>
<refsect1 id="{@id two}">
<title>Second section</title>
<refsect2 id="{@id sub}">
<title>Sub-section</title>
</refsect2>
</refsect1>
<refsect1 id="{@id three}">
<title>Third section</title>
</refsect1>
</refentry>

The format of the table of contents is Converter-dependent, and for the converters supplied with phpDocumentor, can be set up through the use of tutorial_toc.tpl in the template for tremendous customization control

Prev	Up	Next
inline {@source}	phpDocumentor Inline tags	inline {@tutorial}