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 index.xml live-sites.xml site.xml
Date Tue, 11 Feb 2003 16:54:56 GMT
jefft       2003/02/11 08:54:56

  Modified:    src/documentation/content/xdocs index.xml live-sites.xml
                        site.xml
  Log:
  Rewrite the index page to better reflect reality.
  
  Revision  Changes    Path
  1.21      +148 -43   xml-forrest/src/documentation/content/xdocs/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/index.xml,v
  retrieving revision 1.20
  retrieving revision 1.21
  diff -u -r1.20 -r1.21
  --- index.xml	8 Jan 2003 05:44:32 -0000	1.20
  +++ index.xml	11 Feb 2003 16:54:56 -0000	1.21
  @@ -7,54 +7,159 @@
     <body> 
       <section>
         <title>Introduction</title>
  -        <p>Forrest is an XML standards-oriented project documentation framework
  -         based on Apache Cocoon, providing XSLT stylesheets and schemas, images
  -         and other resources. Forrest uses these to render the XML source
  -         content into a website via command-line, robot, or a dynamic web
  -         application.
  +      <p>Forrest is an XML standards-oriented project documentation framework
  +        based on Apache Cocoon, providing XSLT stylesheets and schemas, images
  +        and other resources. Forrest uses these to render the XML source
  +        content into a website via command-line, robot, or a dynamic web
  +        application.
  +      </p>
  +    </section>
  +
  +    <section>
  +      <title>User-friendly</title>
  +      <p>
  +        Forrest is designed with the new user in mind.  Much effort has gone
  +        into making the process of generating a new site <strong>easy</strong>
and
  +        <strong>simple</strong>:
  +      </p>
  +      <ul>
  +        <li><strong>Step 1</strong>: Type <code>forrest seed</code>,
to populate
  +          the directory with template site structure and contents.</li>
  +        <li><strong>Step 2</strong>: Add content by editing docs in
  +          task-specific, presentation-neutral XML.</li>
  +        <li><strong>Step 3</strong>: Type <code>forrest</code>
to generate a
  +          complete website from the XML. Various website styles (known as skins)
  +          are available, and custom skins can be developed.</li>
  +      </ul>
  +      <note>For more information on Forrest installation and use, see the <link
  +          href="site:your-project">Getting Started</link> guide.
  +      </note>
  +      <p>
  +        Forrest's focus on low "startup cost" makes it ideal for rapid
  +        development of small sites, where time and budget constraints do not
  +        allow time-wasting HTML experiments.  By <strong>separating content from
  +          presentation</strong>, providing <strong>content templates</strong>
  +        and <strong>pre-written skins</strong>, Forrest is unequalled at letting
  +        content producers get their message out fast.  This makes Forrest great
  +        for <strong>project documentation</strong> (notably software projects),
  +        <strong>intranets</strong> and <strong>home pages</strong>.
  +      </p>
  +    </section>
  +    <section>
  +      <title>Powerful</title>
  +      <p>
  +        Forrest is far from a quick &amp; dirty solution however.  Forrest is
  +        built on one of the world's leading XML publishing frameworks, <link
  +          href="ext:cocoon">Apache Cocoon</link>, which provides advanced
  +        users with extremely powerful publishing capabilities.
  +      </p>
  +      <ul>
  +        <li>Multiple task-specific XML formats can be used (<link
  +            href="site:howto-samples/overview">howtos</link>, <link
  +            href="site:faq"><acronym title="Frequently Asked
  +              Questions">FAQ</acronym>s</link>,
  +          <link href="site:changes">changelogs</link> and <link
  +            href="site:todo">todo lists</link> supported natively). This list
  +          will soon expand to include Docbook and Wiki formats.</li>
  +        <li>Multiple output formats supported, currently HTML and PDF (using
  +          <link href="ext:fop">Apache FOP</link>).
  +        </li>
  +        <li>SVG to PNG rendering (using <link href="ext:batik">Apache
  +            Batik</link>); simply drop a SVG in the appropriate directory and it
  +          will be rendered as PNG.</li>
  +        <li>
  +          Transparent inclusion and aggregation of external content, like <link
  +            href="site:bugs">RSS feeds</link>.
  +        </li>
  +        <li>
  +          Anything else possible with the <link
  +            href="ext:cocoon/sitemap">Cocoon sitemap</link>.  Database
  +          queries, <link href="ext:apache-stats">charting</link>, web services
  +          integration; the possibilities are constantly growing as Cocoon grows.
  +        </li>
  +        <li>
  +          Based on Java, Forrest is a platform-independent, making the
  +          documentation system just as portable as the XML data.
  +        </li>
  +      </ul>
  +      <section>
  +        <title>Static or Dynamic</title>
  +        <p>
  +          Uniquely amongst comparable documentation tools, Forrest generates
  +          sites that can run both <strong>interactively</strong> as a dynamic
  +          web application, or as statically rendered pages.
           </p>
  +        <p>
  +          This provides a path for site growth: start off small and static, and
  +          if dynamic features (user login, forms processing, runtime data, site
  +          search etc) are one day needed, these can be accommodated by switching
  +          to webapp mode.
  +        </p>
  +        <p>
  +          Running as a webapp has another advantage: content can be written, and
  +          then the rendered output viewed almost instantly in a web browser.
  +          This technique requires a bit <link
  +            href="site:your-project/webapp">setting up</link>, but once working
  +          it makes Forrest's edit/review cycle faster than command-line
  +          transformation tools.
  +        </p>
  +      </section>
  +    </section>
   
  -      <p>Our first target is to create a consistent
  -        <link href="http://xml.apache.org/">xml.apache.org</link> website,
with a
  -      uniform, lightweight, easy-to-navigate layout and structure. Each project
  -      will be responsible for maintaining its own documentation and website,
  -      which are imported, aggregated and published automatically by Forrest.
  -      The framework is intentionally designed to allow Forrest to also be
  -      applied in other projects.
  +    <section>
  +      <title>History</title>
  +      <p>Forrest was started in January 2002, with the intention being to
  +        create a consistent <link
  +          href="http://xml.apache.org/">xml.apache.org</link> website, with a
  +        uniform, lightweight, easy-to-navigate layout and structure.  In
  +        addition, Forrest was to be a Sourceforge-like project management
  +        tool, complementing <link href="ext:gump">Jakarta Gump</link> (hence
  +        the name 'Forrest').
         </p>
  +      <p>
  +        Over time, the grander goals were shelved, and focus shifted to
  +        making Forrest a generic documentation tool, rather than something
  +        specific to xml.apache.org.
  +      </p>
  +      <warning>This historical xml.apache.org focus can still be observed in a
  +        number of this site's older pages.  These are being gradually
  +        updated.</warning>
  +    </section>
   
  -      <p>The Forrest framework comprises XML document grammars for the different
  -       types of documents that a project website typically consists of, a
  -       skinning facility to easily apply a different user interface, local and
  -       robot-based build systems to draw XML content from a repository and
  -       publish to local or remote sites, and a
  -      <link href="ext:cocoon">Cocoon</link>-based site
  -      generation mechanism.</p> 
  -      <p>The Forrest developers ... forrest-dev&lt;at&gt;xml.apache.org</p>

  -    </section> 
       <section>
         <title>Project Status</title>
  -      <p>The Forrest project is new and needs your help.</p>
  -      <ul>
  -      <li>Read our <link href="site:primer">Forrest Primer</link> to
  -      understand what Forrest is and how you can use and contribute to it.</li>
  -      <li>Please see the <link href="site:faq">FAQ</link> and join the
  -      discussion on the forrest-dev&lt;at&gt;xml.apache.org
  -      <link href="site:mail-lists">mail list</link>.
  -      </li>
  -      <li>Follow the <link href="site:your-project">Using Forrest</link>
  -       document to generate a website for your own project.
  -      </li>
  -      <li>There is also a fledgling <link href="site:dreams">Dream List</link>
  -      to help provide some direction.</li>
  -      <li>The 
  -        <link href="ext:forrest">Forrest website</link>
  -       is updated irregularly and manually, while we develop the
  -       <link href="site:forrestbot">forrestbot</link> facility
  -       which produces the
  -       <link href="http://forrestbot.cocoondev.org/">automatically generated</link>
site.
  -       </li>
  -      </ul> 
  -    </section> 
  +      <p>Forrest is currently progressing rapidly through a series of 0.x
  +        releases.  Forrest is quite usable, and used in a number of <link
  +          href="site:live-sites">live sites</link>, including <link
  +          href="http://xml.apache.org/">xml.apache.org</link>.  In general,
  +        prior to 1.0, ensuring quality of design will be considered more
  +        important than retaining backwards-compatibility.  Users (particularly
  +        those with custom sitemaps) should be aware that this is evolving
  +        software, and read the release notes carefully before upgrading.  That
  +        said, we appreciate the commitment in time that adopters make, and will
  +        not make capricious or undocumented backwards-incompatible changes.
  +      </p>
  +      <section>
  +        <title>Website status</title>
  +        <p>
  +          The <link href="ext:forrest">Forrest website</link> is updated
  +          irregularly and manually, while we develop the <link
  +            href="site:forrestbot">forrestbot</link> facility which produces the
  +          <link href="http://forrestbot.cocoondev.org/">automatically
  +            generated</link> site.
  +        </p>
  +      </section>
  +    </section>
  +    <section>
  +      <title>Help Wanted!</title>
  +      <p>
  +        Forrest is fairly new, and is in need of developers.  If you know (or
  +        want to learn) XML, Ant, HTML or CSS, then you're qualified to help!
  +        As with all Apache projects, Forrest is a meritocracy; the more you
  +        put in, the more you get to define the project's future.  See the
  +        <link href="site:contributing">"contributing"</link> page for more
  +        information.
  +      </p>
  +    </section>
     </body>
   </document>
  
  
  
  1.16      +1 -1      xml-forrest/src/documentation/content/xdocs/live-sites.xml
  
  Index: live-sites.xml
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/live-sites.xml,v
  retrieving revision 1.15
  retrieving revision 1.16
  diff -u -r1.15 -r1.16
  --- live-sites.xml	11 Feb 2003 15:42:59 -0000	1.15
  +++ live-sites.xml	11 Feb 2003 16:54:56 -0000	1.16
  @@ -23,7 +23,7 @@
           (Formatting Objects Processor)</li>
         <li><link href="http://www.dream-models.com">Dream Models, all about
electric RC models</link></li>
         <li><link href="http://www.lancecom.com/">Lance Communications</link></li>
  -      <li><link href="http://www.apache.org/~vgritsenko/stats/index.html">Apache
Stats (Vadim's Home Page)</link></li>
  +      <li><link href="ext:apache-stats">Apache Stats (Vadim's Home Page)</link></li>
         <li><link href="http://www.krysalis.sf.net/">Krysalis Community Project</link></li>
       </ul>
     </body>
  
  
  
  1.8       +3 -1      xml-forrest/src/documentation/content/xdocs/site.xml
  
  Index: site.xml
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/site.xml,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- site.xml	4 Feb 2003 10:16:02 -0000	1.7
  +++ site.xml	11 Feb 2003 16:54:56 -0000	1.8
  @@ -33,6 +33,7 @@
       <forrestbot-intro href="forrestbot-intro.html"/>
       <your-project label="Using Forrest" href="your-project.html">
         <new_content_type href="#adding_new_content_type"/>
  +      <webapp href="#webapp"/>
       </your-project>
       <validation label="XML Validation" href="validation.html"/>
       <linking label="Menus and Linking" href="linking.html"/>
  @@ -86,6 +87,7 @@
         <forrest href="forrest/"/>
         <xindice href="xindice/"/>
         <fop href="fop/"/>
  +      <batik href="batik/"/>
       </xml.apache.org>
       <mail-archive href="http://marc.theaimsgroup.com"/>
       <xpath-tut href="http://www.w3schools.com/xpath/"/>
  @@ -115,7 +117,7 @@
       <uri-rfc href="http://zvon.org/tmRFC/RFC2396/Output/index.html"/>
   
       <mozilla href="http://www.mozilla.org/"/>
  -        
  +    <apache-stats href="http://www.apache.org/~vgritsenko/stats/index.html"/>
     </external-refs>
   
   </site>
  
  
  

Mime
View raw message