forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r190889 - /forrest/trunk/site-author/content/xdocs/docs_0_70/linking.xml
Date Thu, 16 Jun 2005 09:43:23 GMT
Author: crossley
Date: Thu Jun 16 02:43:21 2005
New Revision: 190889

Add some tips about configuring the interaction between tabs.xml and site.xml


Modified: forrest/trunk/site-author/content/xdocs/docs_0_70/linking.xml
--- forrest/trunk/site-author/content/xdocs/docs_0_70/linking.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_70/linking.xml Thu Jun 16 02:43:21 2005
@@ -19,6 +19,7 @@
 <!ENTITY a '<code>index.xml</code>'>
 <!ENTITY b '<code>todo.xml</code>'>
 <!ENTITY s '<code>site.xml</code>'>
+<!ENTITY t '<code>tabs.xml</code>'>
@@ -295,11 +296,58 @@
         <title>Selecting the current tab</title>
           The tab selection algorithm is quite simple: the tab with the
-          "<code>id</code>" which matches that of the current <code>site.xml</code>
-          node is "selected". If you experience any problems, try to add a 
-          <code>&lt;foo label="Foo" href="index.html"/&gt;</code> to
-          <code>site.xml</code> configuration.
+          "<code>id</code>" which matches that of the current &s;
+          node is "selected". However the interaction of &t; and &s;
+          while powerful, can be complex to establish.
+      </section>
+      <section id="tab-site">
+        <title>Configuring the interaction between tabs.xml and site.xml</title>
+        <p>
+          This is a collection of tips to assist with getting your menus and tabs
+          to properly display.
+        </p>
+        <ul>
+          <li>
+            View your site's 
+            <link href="../abs-menulinks">abs-menulinks</link> pipeline in a
+            browser. This is part of the internal Cocoon machinery, but like
+            other sitemap resources, it is useful to view them to assist with
+            debugging.
+          </li>
+          <li>
+            The Forrest website also accompanies your software release
+            in the <code>site-author</code> directory, so
+            inspect its &t; and &s; to see how it is done. Also see the
+            'forrest seed site' example. It is not as complex as the Forrest website.
+          </li>
+          <li>
+            When you are fiddling with your attributes, change one thing at a time
+            and document what you have changed.</li>
+          <li>
+            The value of the tab @id attribute cannot begin with a digit.
+            Likewise, element names in &t; and &s; cannot begin with a digit.
+          </li>
+          <li>
+            Add label attributes to &s; elements to make the menus show.
+            With nested elements in &s; if the outer element does not have a label
+            attribute then the inner elements will not be displayed.
+          </li>
+          <li>
+            To cause tabs and menu items to be highlighted, there need to be
+            corresponding elements in &s; that have href attributes which match
+            the relevant path.
+          </li>
+          <li>
+            When the tab points to a directory, then to make the tab highlighted
+            when selected, you need an element which matches index.html within the
+            group of elements that define the menus for this tab in the &s;
+            file. That element can be without a label attribute, so that it doesn't
+            display as a menu item. However doing that causes that tab's menus
+            to be collapsed.
+          </li>
+        </ul>

View raw message