You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general-cvs@xml.apache.org by cr...@apache.org on 2003/12/02 03:01:10 UTC
cvs commit: xml-site/targets/forrest linking.html linking.pdf
crossley 2003/12/01 18:01:10
Modified: targets/forrest linking.html linking.pdf
Log:
Added paragraph to explain href attribute in tabs.xml
Submitted by: Ross Gardler rgardler<AT>wkwyw.net
PR: FOR-92
Plus other minor text tweaks and consistent relative section anchors.
Revision Changes Path
1.17 +100 -26 xml-site/targets/forrest/linking.html
Index: linking.html
===================================================================
RCS file: /home/cvs/xml-site/targets/forrest/linking.html,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- linking.html 6 Oct 2003 03:01:14 -0000 1.16
+++ linking.html 2 Dec 2003 02:01:10 -0000 1.17
@@ -146,7 +146,7 @@
</li>
<li>
-<a href="live-sites.html">Live sites</a>
+<a href="live-sites.html">Example sites</a>
</li>
</ul>
@@ -248,7 +248,7 @@
</li>
<li>
-<a href="http://cvs.apache.org/viewcvs/xml-forrest/">CVS</a>
+<a href="http://cvs.apache.org/viewcvs/xml-forrest/">Browse CVS</a>
</li>
<li>
@@ -336,27 +336,33 @@
<a href="#intro">Introduction</a>
</li>
<li>
-<a href="#site.xml">site.xml</a>
+<a href="#site">site.xml</a>
</li>
<li>
<a href="#menu_generation">Generating Menus</a>
<ul class="minitoc">
<li>
-<a href="#Selecting+menu+entries">Selecting menu entries</a>
+<a href="#tabs-external">Tabs for External Resources</a>
</li>
<li>
-<a href="#Alternative+menu+selection+mechanisms.">Alternative menu selection mechanisms.</a>
+<a href="#selecting-entries">Selecting menu entries</a>
</li>
<li>
-<a href="#Selecting+the+current+tab">Selecting the current tab</a>
+<a href="#other-menu-selection">Alternative menu selection mechanisms.</a>
+</li>
+<li>
+<a href="#tab-selection">Selecting the current tab</a>
</li>
</ul>
</li>
<li>
+<a href="#toc-generation">Table of Contents Generation</a>
+</li>
+<li>
<a href="#linking">Linking systems</a>
<ul class="minitoc">
<li>
-<a href="#direct_linking">Direct linking</a>
+<a href="#direct-linking">Direct linking</a>
</li>
<li>
<a href="#indirect-linking">Indirect linking</a>
@@ -364,10 +370,10 @@
</ul>
</li>
<li>
-<a href="#Concept">Concept</a>
+<a href="#concept">Concept</a>
</li>
<li>
-<a href="#Implementation">Implementation</a>
+<a href="#implementation">Implementation</a>
</li>
</ul>
@@ -382,7 +388,7 @@
</div>
-<a name="N10023"></a><a name="site.xml"></a>
+<a name="N10023"></a><a name="site"></a>
<h3>site.xml</h3>
<div style="margin-left: 0 ; border: 2px">
<p>
@@ -536,7 +542,7 @@
<pre class="code">
<tabs ...>
<tab id="home" label="Home" dir=""/>
- <tab id="community" label="Community" dir="community"/>
+ <tab id="community" label="Community" dir="community" indexfile="mailLists.html"/>
<tab id="howto" label="How-Tos" dir="community/howto"/>
</tabs>
</pre>
@@ -547,7 +553,29 @@
<img alt="Community menu generated from site.xml" src="images/menu2.png">
<img alt="Howto menu generated from site.xml" src="images/menu3.png">
</p>
-<a name="N100DE"></a><a name="Selecting+menu+entries"></a>
+<p>When using the <span class="codefrag">dir</span> attribute as above the value of the
+ <span class="codefrag">indexfile</span> parameter is appended to the value of the
+ <span class="codefrag">dir</span> attribute (together with a preceding '/'). For example,
+ the link for the community tab above is
+ <span class="codefrag">community/mailLists.html</span>. Note that <span class="codefrag">indexfile</span>
+ defaults to <span class="codefrag">index.html</span> if no value is supplied. Therefore the
+ link for the howto tab is <span class="codefrag">community/howto/index.html</span>.</p>
+<a name="N100F6"></a><a name="tabs-external"></a>
+<h4>Tabs for External Resources</h4>
+<div style="margin-left: 0 ; border: 2px">
+<p>You can make a tab point to an external resource by using the
+ <span class="codefrag">href</span> attribute instead of the <span class="codefrag">dir</span> attribute.
+ The value of <span class="codefrag">href</span> should be the URI of the resource you wish
+ to link to. For example:</p>
+<pre class="code">
+<tab id="apache" label="XML Apache" href-"http://xml.apache.org/"/>
+ </pre>
+<p>Unlike the <span class="codefrag">dir</span> attribute, the value of <span class="codefrag">href</span>
+ is left unmodified by Forrest unless it is root-relative and obviously
+ specifies a directory (ends in '/'). In which case /index.html will be
+ added</p>
+</div>
+<a name="N10117"></a><a name="selecting-entries"></a>
<h4>Selecting menu entries</h4>
<div style="margin-left: 0 ; border: 2px">
<p>Forrest decides which menu entries to display by examining the
@@ -594,7 +622,7 @@
tab="home"</em>, and put them in the menu.
</p>
</div>
-<a name="N10130"></a><a name="Alternative+menu+selection+mechanisms."></a>
+<a name="N10169"></a><a name="other-menu-selection"></a>
<h4>Alternative menu selection mechanisms.</h4>
<div style="margin-left: 0 ; border: 2px">
<p>
@@ -602,7 +630,7 @@
entries is not the only one, although it is the most flexible. Here
we describe a few alternatives.
</p>
-<a name="N1013C"></a><a name="Directory-based+selection"></a>
+<a name="N10175"></a><a name="dir-menu-selection"></a>
<h5>Directory-based selection</h5>
<div style="margin-left: 0 ; border: 2px">
<p>In this scheme, each tab corresponds to a directory within the
@@ -627,7 +655,7 @@
</ul>
</div>
-<a name="N1016C"></a><a name="Specifying+menus+with+book.xml"></a>
+<a name="N101A5"></a><a name="book-menu-selection"></a>
<h5>Specifying menus with book.xml</h5>
<div style="margin-left: 0 ; border: 2px">
<p>
@@ -641,7 +669,7 @@
</p>
</div>
</div>
-<a name="N10189"></a><a name="Selecting+the+current+tab"></a>
+<a name="N101C2"></a><a name="tab-selection"></a>
<h4>Selecting the current tab</h4>
<div style="margin-left: 0 ; border: 2px">
<p>
@@ -651,12 +679,58 @@
</p>
</div>
</div>
+
+
+<a name="N101D3"></a><a name="toc-generation"></a>
+<h3>Table of Contents Generation</h3>
+<div style="margin-left: 0 ; border: 2px">
+<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 <span class="codefrag">src/documentation/skinconf.xml</span> using the <span class="codefrag">toc</span>
+ element.</p>
+<pre class="code">
+<toc level="2" location="page"/>
+ </pre>
+<ul>
+
+<li>
+<strong><span class="codefrag">level</span></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><span class="codefrag">location</span></strong> - indicates where you
+ want the table of contents to be rendered. It can be set to one of
+ three values:
+ <ul>
+
+<li>
+<span class="codefrag">page</span> - the table of contents will be rendered
+ at the top of the body of your page</li>
+
+<li>
+<span class="codefrag">menu</span> - the table of contents will be rendered
+ in the menu to the left of the body of the page</li>
+
+<li>
+<span class="codefrag">menu, page</span> - table of contents will be rendered
+ in both the page and the menu positions</li>
+
+</ul>
+
+</li>
+
+</ul>
+</div>
-<a name="N1019A"></a><a name="linking"></a>
+<a name="N10209"></a><a name="linking"></a>
<h3>Linking systems</h3>
<div style="margin-left: 0 ; border: 2px">
-<a name="N101A0"></a><a name="direct_linking"></a>
+<a name="N1020F"></a><a name="direct-linking"></a>
<h4>Direct linking</h4>
<div style="margin-left: 0 ; border: 2px">
<p>
@@ -675,7 +749,7 @@
one of them (here, the PDF) are likely to break.
</p>
</div>
-<a name="N101C6"></a><a name="indirect-linking"></a>
+<a name="N10235"></a><a name="indirect-linking"></a>
<h4>Indirect linking</h4>
<div style="margin-left: 0 ; border: 2px">
<p>
@@ -702,7 +776,7 @@
'idea' of "the todo file". It doesn't matter where it physically lives;
that will be sorted out by Forrest.
</p>
-<a name="N101EE"></a><a name="Resolving+site%3A+URIs"></a>
+<a name="N1025D"></a><a name="resolve-site-uris"></a>
<h5>Resolving site: URIs</h5>
<div style="margin-left: 0 ; border: 2px">
<p>
@@ -739,7 +813,7 @@
another category.
</p>
</div>
-<a name="N1022C"></a><a name="ext%3A+URIs%3A+linking+to+external+URLs"></a>
+<a name="N1029B"></a><a name="resolve-ext-uris"></a>
<h5>ext: URIs: linking to external URLs</h5>
<div style="margin-left: 0 ; border: 2px">
<p>
@@ -781,7 +855,7 @@
related URLs easy.
</p>
</div>
-<a name="N10260"></a><a name="Theory%3A+source+URIs"></a>
+<a name="N102CF"></a><a name="source-uris"></a>
<h5>Theory: source URIs</h5>
<div style="margin-left: 0 ; border: 2px">
<p>
@@ -800,7 +874,7 @@
translated into plain old HTML in the output.
</p>
</div>
-<a name="N1027F"></a><a name="Future+schemes"></a>
+<a name="N102EE"></a><a name="future-schemes"></a>
<h5>Future schemes</h5>
<div style="margin-left: 0 ; border: 2px">
<p>
@@ -873,7 +947,7 @@
</div>
</div>
-<a name="N10323"></a><a name="Concept"></a>
+<a name="N10392"></a><a name="concept"></a>
<h3>Concept</h3>
<div style="margin-left: 0 ; border: 2px">
<p>
@@ -888,7 +962,7 @@
</p>
</div>
-<a name="N1033A"></a><a name="Implementation"></a>
+<a name="N103A9"></a><a name="implementation"></a>
<h3>Implementation</h3>
<div style="margin-left: 0 ; border: 2px">
<p>Full details on the implementation of <a href="sitemap-ref.html#linkrewriting_impl">link rewriting</a> and <a href="sitemap-ref.html#menu_generation_impl">menu generation</a> are available in
@@ -898,7 +972,7 @@
<div class="attribution">by Jeff Turner; <span class="version">
- version 1.10</span>
+ version 1.11</span>
</div>
</div>
</td><td width="10"><img width="10" height="1" alt="" src="skin/images/spacer.gif" class="spacer"></td>
1.15 +394 -542 xml-site/targets/forrest/linking.pdf
<<Binary file>>
---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org