forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From je...@apache.org
Subject cvs commit: xml-forrest/src/documentation/content/xdocs your-project.xml
Date Sun, 07 Sep 2003 04:58:15 GMT
jefft       2003/09/06 21:58:15

  Modified:    src/documentation/content/xdocs your-project.xml
  Log:
  General updates and synch with 0.5
  
  Revision  Changes    Path
  1.30      +65 -27    xml-forrest/src/documentation/content/xdocs/your-project.xml
  
  Index: your-project.xml
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/your-project.xml,v
  retrieving revision 1.29
  retrieving revision 1.30
  diff -u -r1.29 -r1.30
  --- your-project.xml	13 Aug 2003 10:34:55 -0000	1.29
  +++ your-project.xml	7 Sep 2003 04:58:15 -0000	1.30
  @@ -156,10 +156,12 @@
   /forrest.properties      # Optional file describing your site layout
   /src/documentation/      # Doc-specific files
   /src/documentation/skinconf.xml    # Info about your project used by the skin
  +/src/documentation/content/        # Site content.
   /src/documentation/content/xdocs   # XML content.
   /src/documentation/content/xdocs/index.xml # Home page
   /src/documentation/content/xdocs/site.xml  # Navigation file for site structure
   /src/documentation/content/xdocs/tabs.xml  # Skin-specific 'tabs' file.
  +/src/documentation/content/*.html,pdf      # Static content files
   /src/documentation/resources/images        # Project images (logos, etc)
   
   
  @@ -169,8 +171,6 @@
     HTML in a browser to make sure everything works.
   - Edit status.xml and src/documentation/skinconf.xml and customize for your
     project.
  -- Replace src/documentation/resources/images/project-logo.gif with your project
  -  logo.
   - Start adding content in xdocs/, remembering to add new files to site.xml
   - Provide any feedback to forrest-dev@xml.apache.org
   
  @@ -179,7 +179,7 @@
       
   
   BUILD SUCCESSFUL
  -Total time: 2 seconds
  +Total time: 8 seconds
         </source>
         <note>
           As you've probably begun to notice, we like to document things right in the
  @@ -191,23 +191,38 @@
         <source>
   jeff@expresso:~/apache/xml-mysite$ tree
   .
  +|-- forrest-targets.ent
   |-- forrest.properties
   |-- src
   |   `-- documentation
   |       |-- README.txt
   |       |-- content
  +|       |   |-- hello.pdf
  +|       |   |-- test1.html
  +|       |   |-- test2.html
   |       |   `-- xdocs
  -|       |       |-- site.xml
   |       |       |-- index.xml
  -|       |       |-- sample.xml
  -|       |       |-- subdir
  -|       |       |   `-- index.xml
  +|       |       |-- samples
  +|       |       |   |-- ehtml-sample.ehtml
  +|       |       |   |-- faq.xml
  +|       |       |   |-- ihtml-sample.ihtml
  +|       |       |   |-- index.xml
  +|       |       |   |-- sample.xml
  +|       |       |   |-- sample2.xml
  +|       |       |   |-- sdocbook.xml
  +|       |       |   |-- subdir
  +|       |       |   |   |-- book-sample.xml
  +|       |       |   |   `-- index.xml
  +|       |       |   `-- wiki-sample.cwiki
  +|       |       |-- site.xml
   |       |       `-- tabs.xml
   |       |-- resources
   |       |   `-- images
   |       |       |-- group-logo.gif
  +|       |       |-- group.svg
   |       |       |-- icon.png
  -|       |       `-- project-logo.gif
  +|       |       |-- project-logo.gif
  +|       |       `-- project.svg
   |       `-- skinconf.xml
   `-- status.xml
         </source>
  @@ -250,18 +265,11 @@
             like this:
           </p>
   <source><![CDATA[
  -<?xml version="1.0"?>
  -
  -<!--
  -Skin configuration file. This file contains details of your project,
  -which will be used to configure the chosen Forrest skin.
  --->
  -
   <skinconfig>
     <!-- Do we want to disable the Google search box? -->
     <disable-search>false</disable-search>
  -  <!-- Do we want to disable the print link? -->
  -  <disable-print-link>false</disable-print-link>
  +  <!-- Do we want to disable the print link? If enabled, valid HTML 4.0.1 -->
  +  <disable-print-link>true</disable-print-link>  
     <!-- Do we want to disable the PDF link? -->
     <disable-pdf-link>false</disable-pdf-link>
     <!-- Do we want to disable the xml source link? -->
  @@ -269,12 +277,13 @@
     <!-- Do we want to disable w3c compliance links? -->
     <disable-compliance-links>false</disable-compliance-links>
   
  -  <searchsite-domain>mydomain</searchsite-domain>
  -  <searchsite-name>MyProject</searchsite-name>
  +  <searchsite-domain>mydomain</searchsite-domain>  
  +  <searchsite-name>MyProject</searchsite-name>  
   
     <!-- mandatory project logo
          skin: forrest-site renders it at the top -->
     <project-name>MyProject</project-name>
  +  <project-description>MyProject Description</project-description>
     <project-url>http://myproj.mygroup.org/</project-url>
     <project-logo>images/project.png</project-logo>
     <!-- Alternative static image:
  @@ -283,6 +292,7 @@
     <!-- optional group logo
          skin: forrest-site renders it at the top-left corner -->
     <group-name>MyGroup</group-name>
  +  <group-description>MyGroup Description</group-description>
     <group-url>http://mygroup.org</group-url>
     <group-logo>images/group.png</group-logo>
     <!-- Alternative static image:
  @@ -305,6 +315,13 @@
       <link2 name="myProject" href="http://xml.apache.org/"/>
       <link3 name="" href=""/>
     </trail>
  +
  +  <!-- Configure how many "section" levels need to be included in the
  +  generated Table of Contents (TOC). By default, if no toc element is provided
  +  below, then 2 levels are included. Level 0 does not generate any TOC at all.
  +  -->
  +  <toc level="2"/>
  +
     <!-- Credits are typically rendered as a set of small clickable images in the
     page footer -->
     <credits>
  @@ -472,6 +489,10 @@
           <li>Read content from exotic sources like <link
               href="http://www.rpbourret.com/xml/XMLDBLinks.htm">XML
               databases</link></li>
  +        <li>Integrate any of <link href="ext:cocoon">Cocoon's</link>
vast array
  +          of capabilities.  The possibilities are best appreciated by
  +          downloading the latest Cocoon distribution and playing with the
  +          samples.</li>
         </ul>
         <p>
           If your site defines its own sitemap, it must perform all the operations of
  @@ -482,11 +503,11 @@
         </p>
         <p>
           The sitemap syntax is described in the <link
  -          href="ext:cocoon/sitemap">Cocoon
  -          sitemap docs</link>.  The Forrest sitemap is broken into multiple files.
The
  -        main one is <strong>sitemap.xmap</strong>, which delegates to others.
  -        See the <link href="site:sitemap-ref">Sitemap Reference</link> for
a
  -        tour of the default sitemap.
  +          href="ext:cocoon/sitemap">Cocoon sitemap docs</link>.  The Forrest
  +        sitemap is broken into multiple files. The main one is
  +        <strong>sitemap.xmap</strong>, which delegates to others.  See the
<link
  +          href="site:sitemap-ref">Sitemap Reference</link> for a tour of the
  +        default sitemap.
         </p>
         <section id="adding_new_content_type">
           <title>Example: Adding a new content type</title>
  @@ -692,10 +713,12 @@
           <source>
   project.skin=forrest-site
           </source>
  +        <!--
           <note>
             The mechanism for defining which skin to use will change in the future from
             Ant @token@ values to Cocoon input module values.
           </note>
  +        -->
           <section id="new_skin">
             <title>Defining a new skin</title>
             <p>
  @@ -704,7 +727,7 @@
               <code>${project.skins-dir}</code> points). The default sitemap
assumes a
               certain skin layout, so the easiest way to create a new skin is by
               copying an existing Forrest skin.  For example, copy
  -            <code>xml-forrest/src/resources/skins/forrest-site</code> to
  +            <code>xml-forrest/src/resources/skins/template</code> to
               <code>src/documentation/skins/myskin</code>, and add
               <code>project.skin=myskin</code> to forrest.properties.
             </p>
  @@ -731,6 +754,21 @@
                 layout, and adds the header and footer.
               </dd>
             </dl>
  +          <p>
  +            Typically there is a lot of commonality between skins.  XSLT
  +            provides an 'import' mechanism whereby one XSLT can extend another.
  +            Forrest XSLTs typically 'import' from a common base:
  +          </p>
  +          <source><![CDATA[
  +<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  +
  +  <xsl:import href="../../../common/xslt/html/document2html.xsl"/>
  +
  +  ]]><strong>... overrides of default templates ...</strong><![CDATA[

  +</xsl:stylesheet>]]></source>
  +          <p>This is particularly relevant for menu rendering (book2menu.xsl),
  +            where the common stylesheet does the 'logic' of which item is
  +            selected, and overriding stylesheets define the presentation.</p>
           </section>
         </section>
   
  
  
  

Mime
View raw message