Author: ltheussl
Date: Thu May 7 10:47:37 2009
New Revision: 772604
URL: http://svn.apache.org/viewvc?rev=772604&view=rev
Log:
Fix docs about depth counting, see DOXIA-316.
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=772604&r1=772603&r2=772604&view=diff
==============================================================================
--- maven/doxia/site/src/site/apt/macros/index.apt (original)
+++ maven/doxia/site/src/site/apt/macros/index.apt Thu May 7 10:47:37 2009
@@ -158,11 +158,11 @@
subsections in your document. For instance, in an APT file, you could write:
-----
-%{toc|section=2|fromDepth=2|toDepth=3}
+%{toc|section=2|fromDepth=1|toDepth=2}
-----
This displays a TOC for the second section in the document, including all
- subsections (depth 2) and sub-subsections (depth 3).
+ subsections (depth 1) and sub-subsections (depth 2).
<<Note>> that in Doxia, apt section titles are not implicit anchors
(see {{{../references/doxia-apt.html}Enhancements to the APT format}}), so
you need
@@ -183,7 +183,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 (sections are depth
1, sub-sections depth 2, etc.). Positive int, not mandatory, 0 by default.
+| fromDepth | Minimum section depth to include in the TOC (sections are depth
0, sub-sections depth 1, etc.). Positive int, not mandatory, 0 by default.
*-----------+--------------+
| toDepth | Maximum section depth to include in the TOC. Positive int, not
mandatory, 5 by default.
*-----------+--------------+
