forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r524071 - /forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml
Date Fri, 30 Mar 2007 13:17:14 GMT
Author: crossley
Date: Fri Mar 30 06:17:13 2007
New Revision: 524071

URL: http://svn.apache.org/viewvc?view=rev&rev=524071
Log:
Add FAQ #linkmap to explain the automatically generated "Site Linkmap Table of Contents".

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

Modified: forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml?view=diff&rev=524071&r1=524070&r2=524071
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml Fri Mar 30 06:17:13 2007
@@ -586,6 +586,32 @@
         </p>
       </answer>
     </faq>
+
+    <faq id="linkmap">
+      <question>How to show a Table Of Contents for the whole site?</question>
+      <answer>
+        <p>
+          Every site has an automatically generated document at
+          <code>/linkmap.html</code>
+          which is produced from the site.xml navigation configuration.
+          It uses the @label and absolutized @href and element name and @description attribute
for
+          each node.
+        </p>
+        <p>
+          For example, the Forrest project's <link href="site:linkmap">Site Linkmap
Table of Contents</link>.
+        </p>
+        <p>
+          The document is also useful when developing your documentation and linking
+          to other docs. The element names (column #2) e.g.
+           href="site:<strong>mail-lists</strong>" or href="site:<strong>howto/overview</strong>"
+        </p>
+        <p>
+          This is also the document that 'forrest site' uses to kick-start the
+          Cocoon crawler which then follows links to build each page. See the
+          project.start-uri in the forrest.properties file.
+        </p>
+      </answer>
+    </faq>
   </part>
   <part id="technical">
     <title>Technical</title>



Mime
View raw message