You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by bw...@apache.org on 2003/02/18 12:13:43 UTC
cvs commit: jakarta-turbine-maven/xdocs site.xml

bwalding    2003/02/18 03:13:43

  Added:       xdocs    site.xml
  Log:
  o MAVEN-282: Add doc discussing consolidated navigation.xml
  
  Revision  Changes    Path
  1.1                  jakarta-turbine-maven/xdocs/site.xml
  
  Index: site.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
    <properties>
      <title>Site Navigation</title>
      <author email="bwalding@apache.org">Ben Walding</author>
    </properties>
  
    <body>
  
      <section name="Implementation">
      	<p>
  	    	Create a single navigation.xml that contains the menu structure for
  	    	the entire document tree.  Add all items and sub-items.
      	</p>
      	
      	<p> 
      		For items that can collapse when you are not browsing them, add <code>collapse="true"</code>
      		to the item declaration.
      	</p>
      	
      	<source><![CDATA[
      	<?xml version="1.0" encoding="ISO-8859-1"?>
  <project name="Maven xdoc Plugin">
  
    <title>Maven xdoc Plugin</title>
  
    <body>
      <links>
        <item name="Maven"  href="http://jakarta.apache.org/turbine/maven/"/>
      </links>
      <menu>
        <item name="Alpha" href="/alpha/index.html">   
  	      <item name="Alpha One" href="/alpha/one/index.html"/>
  	      <item name="Alpha Two" href="/alpha/two/index.html"/>
  	  </item>
        <item name="Beta" href="/beta/index.html" collapse="true">
  	      <item name="Beta One" href="/beta/one/index.html" collapse="true"/>
  	      <item name="Beta Two" href="/beta/two/index.html" collapse="true"/>
  	  </item>
      </menu>
    </body>
  </project>
      	]]>
      	</source>
      	
      	<p>
      		Now the menus will expand and collapse as you navigate through them.
      	</p>
      	
  
      </section>
      
      <section name="Caveats">
      	<ol>
      		<li>You must refer to subdirectories as /folder/index.html.  Navigation will get quite confused
      			if you refer to them as /folder/ or just /folder
      		</li>
      		<li>
      			If you have a sub-item with the same url as another item, the site navigation will
      			expand to display all items with that URL (when either is selected).  All instances 
      			of the item will be highlighted.
      		</li>
      	</ol>
      </section>
      
      
  
  
    </body>
  </document>