org.apache.maven.doxia.macro.toc

Class TocMacro

public class TocMacro extends AbstractMacro

Macro to display a Table Of Content in a given Sink. The input for this macro are:
section
Display the specificated section number or all sections if 0 (in this case, other parameters are ignored).
Positive int, not mandatory, 0 by default.
fromDepth
Display the depth starting for the given section number.
Positive int, not mandatory, 0 by default.
toDepth
Display the depth ending for the given section number.
Positive int, not mandatory, 5 by default.
For instance, in an APT file, you could write:
%{toc|section=2|fromDepth=2|toDepth=2}
Display a TOC for the section number 2 in the document, from the subsection depth 1 to the subsection depth 2
%{toc}
display a TOC with all section and subsections (similar to %{toc|section=0} )
Moreover, you need to write APT link for section to allow anchor, for instance:
 * {SubSection 1}
 
Similarly, in an XDOC file, you could write:
 <macro name="toc">
   <param name="section" value="1" />
   <param name="fromDepth" value="1" />
   <param name="toDepth" value="2" />
 </macro>
 

Version: $Id: TocMacro.java 561315 2007-07-31 12:50:41Z vsiveton $

Author: Vincent Siveton

UNKNOWN: role-hint="toc"

Method Summary
voidexecute(Sink sink, MacroRequest request)

Method Detail

execute

public void execute(Sink sink, MacroRequest request)
{@inheritDoc }
Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.