forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r178943 - in /forrest/trunk/site-author/content/xdocs: docs/faq.xml docs/linking.xml site.xml
Date Sun, 29 May 2005 11:38:23 GMT
Author: crossley
Date: Sun May 29 04:38:22 2005
New Revision: 178943

URL: http://svn.apache.org/viewcvs?rev=178943&view=rev
Log:
Added FAQ about use of site.xml

Modified:
    forrest/trunk/site-author/content/xdocs/docs/faq.xml
    forrest/trunk/site-author/content/xdocs/docs/linking.xml
    forrest/trunk/site-author/content/xdocs/site.xml

Modified: forrest/trunk/site-author/content/xdocs/docs/faq.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/docs/faq.xml?rev=178943&r1=178942&r2=178943&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs/faq.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs/faq.xml Sun May 29 04:38:22 2005
@@ -99,6 +99,48 @@
           browser. </p>
       </answer>
     </faq>
+    <faq id="site-xml">
+      <question>
+        How to use the <code>site.xml</code> configuration file for menus and
linking.
+      </question>
+      <answer>
+        <p>
+          The <code>site.xml</code> configuration file is used for two different
purposes:
+          defining the left-hand navigation menus, and as a method for defining references
+          to be used when linking between documents.
+          This file is fully explained in
+          <link href="site:linking">Menus and Linking</link>. Here is a precis:
+        </p>
+        <p>
+          Use unique element names. The labels can be whatever text you want.
+        </p>
+        <source><![CDATA[<faq label="FAQs" href="faq.html">
+  <tech label="Technical" href="faq-tech.html">
+    <docbook href="#docbook"/>
+    <ignoring_javadocs href="#ignoring_javadocs"/>
+  </tech>
+  <user label="User" href="faq-user.html">
+</faq>]]></source>
+        <p>
+          That will create a menu like this with three links:
+        </p>
+        <source>FAQs
+   Technical
+   User</source>
+
+        <p>
+          These documents can be linked to from other documents, like this:
+        </p>
+        <source><![CDATA[<a href="site:faq/tech"> link to the top of the Tech
FAQs
+<a href="site:faq/tech/docbook"> link to the DocBook FAQ in the Tech FAQs]]></source>
+
+        <p>
+          If that "docbook" entry was a unique name in your site.xml then you
+          can shorten that latter link:
+        </p>
+        <source><![CDATA[<a href="site:docbook"> link to the DocBook FAQ in
the Tech FAQs]]></source>
+      </answer>
+    </faq>
     <faq id="PDF-output">
       <question>How can I generate one pdf-file out of the whole site or selected pages
of the site?</question>
       <answer>

Modified: forrest/trunk/site-author/content/xdocs/docs/linking.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/docs/linking.xml?rev=178943&r1=178942&r2=178943&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs/linking.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs/linking.xml Sun May 29 04:38:22 2005
@@ -148,6 +148,9 @@
           "<code>ext:</code>" scheme.  So "<code>ext:commons/resolver/</code>"
becomes
           "<code>http://xml.apache.org/commons/resolver/</code>"</li>
       </ul>
+      <p>
+        See another <link href="site:faq/site-xml">explained example</link>.
+      </p>
     </section>
 
     <section id="menu_generation">

Modified: forrest/trunk/site-author/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/site.xml?rev=178943&r1=178942&r2=178943&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/site.xml (original)
+++ forrest/trunk/site-author/content/xdocs/site.xml Sun May 29 04:38:22 2005
@@ -42,6 +42,7 @@
       <pdf_images href="#pdf_images"/>
       <cli-xconf href="#cli-xconf"/>
       <pageBreaks href="#pageBreaks"/>
+      <site-xml href="#site-xml"/>
     </faq>
     <changes label="Changes" href="changes.html"/>
     <changes-rss href="changes.rss"/>



Mime
View raw message