You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@forrest.apache.org by ni...@apache.org on 2003/11/29 16:37:43 UTC
cvs commit: xml-forrest/src/documentation/content/xdocs linking.xml
nicolaken 2003/11/29 07:37:43
Modified: src/documentation/content/xdocs linking.xml
Log:
Add info in docs about new <toc> param used in Krysalis skin.
Thanks to Ross Gardler
Revision Changes Path
1.11 +34 -1 xml-forrest/src/documentation/content/xdocs/linking.xml
Index: linking.xml
===================================================================
RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/linking.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- linking.xml 19 Sep 2003 07:07:33 -0000 1.10
+++ linking.xml 29 Nov 2003 15:37:43 -0000 1.11
@@ -257,6 +257,39 @@
</section>
</section>
+
+ <section id="toc_generation">
+ <title>Table of Contents Generation</title>
+ <p>Each page can have an automatically generated table of contents. This
+ is created from the titles of each section in your xdoc. By default only
+ sections up to two levels deep are included and the table of contents is
+ displayed at the top of the page. However, you can configure this
+ behaviour in <code>src/documentation/skinconf.xml</code> using the <code>toc</code>
+ element.</p>
+
+ <source><![CDATA[
+<toc level="2" location="page"/>
+ ]]></source>
+
+ <ul>
+ <li><strong><code>level</code></strong> - is the depth to which you
+ want your table of contents to go. Setting it to 3 will therefore
+ include sections nested to 3 levels. Setting this to 0 will result in
+ no table of contents being generated.</li>
+ <li><strong><code>location</code></strong> - indicates where you
+ want the table of contents to be rendered. It can be set to one of
+ three values:
+ <ul>
+ <li><code>page</code> - the table of contents will be rendered
+ at the top of the body of your page</li>
+ <li><code>menu</code> - the table of contents will be rendered
+ in the menu to the left of the body of the page</li>
+ <li><code>menu, page</code> - table of contents will be rendered
+ in both the page and the menu positions</li>
+ </ul>
+ </li>
+ </ul>
+ </section>
<section id="linking">
<title>Linking systems</title>