Author: ltheussl
Date: Tue Jan 6 14:24:59 2009
New Revision: 732151
URL: http://svn.apache.org/viewvc?rev=732151&view=rev
Log:
Clarification of TOC macro parameters
Modified:
maven/doxia/site/src/site/apt/macros/index.apt
Modified: maven/doxia/site/src/site/apt/macros/index.apt
URL:
http://svn.apache.org/viewvc/maven/doxia/site/src/site/apt/macros/index.apt?rev=732151&r1=732150&r2=732151&view=diff
==============================================================================
--- maven/doxia/site/src/site/apt/macros/index.apt (original)
+++ maven/doxia/site/src/site/apt/macros/index.apt Tue Jan 6 14:24:59 2009
@@ -157,9 +157,12 @@
subsections in your document. For instance, in an APT file, you could write:
-----
-%{toc|section=2|fromDepth=0|toDepth=4}
+%{toc|section=2|fromDepth=2|toDepth=3}
-----
+ This displays a TOC for the second section in the document, including all
+ subsections (depth 2) and sub-subsections (depth 3).
+
<<Note>> that in Doxia, apt section titles are not implicit anchors
(see {{{../references/doxia-apt.html}Enhancements to the APT format}}), so
you need
to insert explicit anchors for links to work!
@@ -179,7 +182,7 @@
*-----------+--------------+
| section | Display a TOC for the specified section only, or all sections if
0 (in this case, other parameters are ignored). Positive int, not mandatory, 0
by default.
*-----------+--------------+
-| fromDepth | Minimum section depth to include in the TOC. Positive int, not
mandatory, 0 by default.
+| fromDepth | Minimum section depth to include in the TOC (sections are depth
1, sub-sections depth 2, etc.). Positive int, not mandatory, 0 by default.
*-----------+--------------+
| toDepth | Maximum section depth to include in the TOC. Positive int, not
mandatory, 5 by default.
*-----------+--------------+
