antlets/src/documentation/content/xdocs tabs.xml,NONE,1.1 site.xml,NONE,1.1 index.xml,NONE,1.1

Update of /cvsroot/metamorphosis/antlets/src/documentation/content/xdocs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv16072/src/documentation/content/xdocs

Added Files:
	tabs.xml site.xml index.xml 
Log Message:
added ability to build a documentation portal using forrest.
uses makeantlet's capability to abstract information from the antlets

--- NEW FILE: tabs.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE tabs PUBLIC "-//APACHE//DTD Cocoon Documentation Tab V1.0//EN" "http://apache.org/forrest/dtd/tab-cocoon-v10.dtd">

<tabs software="MyProj"
  title="MyProj"
  copyright="Foo"
  xmlns:xlink="http://www.w3.org/1999/xlink">

  <!-- The rules are:
    @dir will always have '/@indexfile' added.
    @indexfile gets appended to @dir if the tab is selected. Defaults to 'index.html'
    @href is not modified unless it is root-relative and obviously specifies a
    directory (ends in '/'), in which case /index.html will be added
    If @id's are present, site.xml entries with a matching @tab will be in that tab.
  -->

  <tab id="" label="Home" dir="" indexfile="index.html"/>
  <!-- Add new tabs here, eg:
  <tab label="How-Tos" dir="community/howto/"/>
  <tab label="XML Site" dir="xml-site/"/>
  -->

</tabs>

--- NEW FILE: site.xml ---
<?xml version="1.0"?>

<!--
Forrest site.xml

This file contains an outline of the site's information content.  It is used to:
- Generate the website menus (though these can be overridden - see docs)
- Provide semantic, location-independent aliases for internal 'site:' URIs, eg
<link href="site:changes"> links to changes.html (or ../changes.html if in
  subdir).
- Provide aliases for external URLs in the external-refs section.  Eg, <link
  href="ext:cocoon"> links to http://xml.apache.org/cocoon/ 

See http://xml.apache.org/forrest/linking.html for more info
-->

<site label="MyProj" href="" xmlns="http://apache.org/forrest/linkmap/1.0" tab="">

  <!-- static part of the AntLets portal -->
  <about label="Antlets">
    <index label="Index" href="index.html" description="Home of Antlet portal"/>
    <!-- changes label="Changes" href="changes.html" description="History of Changes" />
       <todo label="Todo" href="todo.html"  description="Todo List" /
    -->
  </about>
  <!-- end of static part of the AntLets portal -->

  <!-- generated part of the AntLets portal -->
  <!-- for each Antlet an element needs to be generated with the following properties, indicated with the
       junit Antlet as an example:
  
         <antletjunit label="junit" href="junit/" tab="">
           <sample1 label="junitpart1" href="part1.html" description="part1" />
           <sample2 label="junitpart2" href="part2.html" description="part2" />
         </antletjunit>
       -->

  <antletcheckstyle label="checkstyle" href="checkstyle/" tab="">
    <antletTargetscheckstyle label="Antlet targets" href="xbuild-doc.html" description="Antlet targets" />
    <antletPropertiescheckstyle label="Antlet properties" href="properties-doc.html" description="Antlet properties" />
  </antletcheckstyle>

  <antletcvsbuild label="cvsbuild" href="cvsbuild/" tab="">
    <antletTargetscvsbuild label="Antlet targets" href="xbuild-doc.html" description="Antlet targets" />
    <antletPropertiescvsbuild label="Antlet properties" href="properties-doc.html" description="Antlet properties" />
  </antletcvsbuild>

  <antletforrest label="forrest" href="forrest/" tab="">
    <antletTargetsforrest label="Antlet targets" href="xbuild-doc.html" description="Antlet targets" />
    <antletPropertiesforrest label="Antlet properties" href="properties-doc.html" description="Antlet properties" />
  </antletforrest>

  <antletinit label="init" href="init/" tab="">
    <antletTargetsinit label="Antlet targets" href="xbuild-doc.html" description="Antlet targets" />
    <antletPropertiesinit label="Antlet properties" href="properties-doc.html" description="Antlet properties" />
  </antletinit>

  <antletjalopy label="jalopy" href="jalopy/" tab="">
    <antletTargetsjalopy label="Antlet targets" href="xbuild-doc.html" description="Antlet targets" />
    <antletPropertiesjalopy label="Antlet properties" href="properties-doc.html" description="Antlet properties" />
  </antletjalopy>

  <antletjava label="java" href="java/" tab="">
    <antletTargetsjava label="Antlet targets" href="xbuild-doc.html" description="Antlet targets" />
    <antletPropertiesjava label="Antlet properties" href="properties-doc.html" description="Antlet properties" />
  </antletjava>
  
  <antletjavasrc label="javasrc" href="javasrc/" tab="">
    <antletTargetsjavasrc label="Antlet targets" href="xbuild-doc.html" description="Antlet targets" />
    <antletPropertiesjavasrc label="Antlet properties" href="properties-doc.html" description="Antlet properties" />
  </antletjavasrc>

  <antletjaxb label="jaxb" href="jaxb/" tab="">
    <antletTargetsjaxb label="Antlet targets" href="xbuild-doc.html" description="Antlet targets" />
    <antletPropertiesjaxb label="Antlet properties" href="properties-doc.html" description="Antlet properties" />
  </antletjaxb>

  <antletjdepend label="jdepend" href="jdepend/" tab="">
    <antletTargetsjdepend label="Antlet targets" href="xbuild-doc.html" description="Antlet targets" />
    <antletPropertiesjdepend label="Antlet properties" href="properties-doc.html" description="Antlet properties" />
  </antletjdepend>
  
  <antletjunit label="junit" href="junit/" tab="">
    <antletTargetsjunit label="Antlet targets" href="xbuild-doc.html" description="Antlet targets" />
    <antletPropertiesjunit label="Antlet properties" href="properties-doc.html" description="Antlet properties" />
  </antletjunit>

  <antletmakeantlet label="makeantlet" href="makeantlet/" tab="">
    <antletTargetsmakeantlet label="Antlet targets" href="xbuild-doc.html" description="Antlet targets" />
    <antletPropertiesmakeantlet label="Antlet properties" href="properties-doc.html" description="Antlet properties" />
  </antletmakeantlet>

  <antletpmd label="pmd" href="pmd/" tab="">
    <antletTargetspmd label="Antlet targets" href="xbuild-doc.html" description="Antlet targets" />
    <antletPropertiespmd label="Antlet properties" href="properties-doc.html" description="Antlet properties" />
  </antletpmd>
  
  <antletruperDepend label="ruperDepend" href="ruperDepend/" tab="">
    <antletTargetsruperDepend label="Antlet targets" href="xbuild-doc.html" description="Antlet targets" />
    <antletPropertiesruperDepend label="Antlet properties" href="properties-doc.html" description="Antlet properties" />
  </antletruperDepend>
  
  <antletscripts label="scripts" href="scripts/" tab="">
    <antletTargetsscripts label="Antlet targets" href="xbuild-doc.html" description="Antlet targets" />
    <antletPropertiesscripts label="Antlet properties" href="properties-doc.html" description="Antlet properties" />
  </antletscripts>
  
  <antletversion label="version" href="version/" tab="">
    <antletTargetsversion label="Antlet targets" href="xbuild-doc.html" description="Antlet targets" />
    <antletPropertiesversion label="Antlet properties" href="properties-doc.html" description="Antlet properties" />
  </antletversion>
  
  <antletwebapp label="webapp" href="webapp/" tab="">
    <antletTargetswebapp label="Antlet targets" href="xbuild-doc.html" description="Antlet targets" />
    <antletPropertieswebapp label="Antlet properties" href="properties-doc.html" description="Antlet properties" />
  </antletwebapp>
  
  <antletxdoclet label="xdoclet" href="xdoclet/" tab="">
    <antletTargetsxdoclet label="Antlet targets" href="xbuild-doc.html" description="Antlet targets" />
    <antletPropertiesxdoclet label="Antlet properties" href="properties-doc.html" description="Antlet properties" />
  </antletxdoclet>
  
  <!-- end of generated part of the AntLets portal -->
  
  <all>
    <whole_site_html label="Whole Site HTML" href="site.html"/>
    <whole_site_html label="Whole Site PDF" href="site.pdf"/>
  </all>
  
  <external-refs>
    <xml.apache.org href="http://xml.apache.org/">
      <forrest href="forrest/">
        <validation href="validation.html"/>
        <webapp href="your-project.html#webapp"/>
        <document-v11 href="document-v11.html"/>
      </forrest>
      <cocoon href="cocoon/"/>
    </xml.apache.org>
    <cvs.sourceforge.net href="http://cvs.sourceforge.net/">
      <metamorphosis-antlets href="viewcvs.py/metamorphosis/antlets/">
        <jaxb-example href="jaxb/src/xbuild.xml?view=markup"/>
        <antlet-sources href="java/"/>
      </metamorphosis-antlets>
    </cvs.sourceforge.net>
  </external-refs>

</site>

--- NEW FILE: index.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://apache.org/forrest/dtd/document-v12.dtd">
<document> 
  <header> 
    <title>Antlets</title> 
  </header> 
  <body> 
    <section>
      <title>What is an antlet</title>
        <p>An antlet is an ant build file desgined for importing called xbuild.xml and optionally other resources. </p>
        <p>Antlets are stored locally in <![CDATA[$ANT_HOME/tools/antlets/<antlet-name>.]]> If the antlet is not found 
           there importer looks for <![CDATA[<antlet-name>.jar ]]> in the href given. If it is found it is downloaded and 
           extracted to $ANT_HOME/tools/antlets/<![CDATA[<antlet-name>]]>. </p>
        <p>Antlets can contain any resources need for the build file, xml, xslt, even jars. However it is not recommended 
           to distribute jars inside the antlet, to keep the anlet size down and reduce jar conflicts. </p>
    </section>

    <section>
      <title>Write your own antlet</title>
        <p>Create a file called xbuild.xml just like any normal ant build.xml file. By convention all properties in the 
           antlet start with <![CDATA[<antlet-name>.antlet. <dirname property="java.antlet.dir" 
           file="${ant.file.java.antlet}"/>]]> is a convient way to reference resource you ship with your antlet. 
           <link href="ext:metamorphosis-antlets/jaxb-example">This jaxb-example</link> is a good example.</p>
        <p>When you are ready to publish your antlet simply jar it up in a file called <![CDATA[<antlet-name>.jar.]]></p>
    </section>

    <section>
      <title>makeantlet</title>
        <p>The makeantlet antlet can help you with this. Take a look at  
           <link href="ext:metamorphosis-antlets/antlet-sources">this</link> for a good example.</p>
        <p>With makeantlet a simple</p>
        <p><em>ant install-antlet</em></p>
        <p>will install the antlet for you.</p>
    </section>

  </body>
</document>



-------------------------------------------------------
This SF.Net email is sponsored by: IBM Linux Tutorials
Free Linux tutorial presented by Daniel Robbins, President and CEO of
GenToo technologies. Learn everything from fundamentals to system
administration.http://ads.osdn.com/?ad_id=1470&alloc_id=3638&op=click