forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rgard...@apache.org
Subject svn commit: r482028 [2/2] - in /forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src: ./ resources/ resources/xslt/ xdocs/ xdocs/images/ xdocs/samples/ xdocs/samples/subdir/
Date Mon, 04 Dec 2006 03:23:31 GMT
Added: forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/linking.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/linking.xml?view=auto&rev=482028
==============================================================================
--- forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/linking.xml (added)
+++ forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/linking.xml Sun Dec  3 19:23:29 2006
@@ -0,0 +1,493 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://apache.org/forrest/dtd/document-v20.dtd">
+<document>
+  <header>
+    <title>Demonstration of linking</title>
+  </header>
+
+  <body>
+    <section id="overview">
+      <title>Overview</title>
+      <p>Forrest has many powerful techniques for linking between documents
+      and for managing the site navigation. This document demonstrates those
+      techniques.
+      The document "<a href="ext:linking">Menus and Linking</a>" 
+      has the full details.
+      </p>
+    </section>
+
+    <section id="uri-space">
+      <title>Building and maintaining consistent URI space</title>
+      <p>
+      When Forrest builds your site, it starts from the front page. Like
+      a robot, it traverses all of the links that it finds in the documents
+      and builds the corresponding pages. Any new links are further traversed.
+      </p>
+      <p>
+      Sometimes those links lead to documents that are generated directly
+      from xml source files, sometimes they are generated from other source
+      via an intermediate xml format. Other times the links lead to raw
+      un-processed content.
+      </p>
+      <p>
+       The site navigation configuration file "<code>site.xml</code>" provides
+       a way to manage this URI space. In the future, when documents are
+       re-arranged and renamed, the site.xml configuration will enable this
+       smoothly.
+      </p>
+    </section>
+
+    <section id="resource-space">
+      <title>Mapping the local resource space to the final URI space</title>
+      <p>
+       For both generated and raw (un-processed) files, the top-level of the
+       URI space corresponds to the "<code>content/xdocs/</code>" directory,
+       i.e. the location of the "<code>site.xml</code>" configuration file.
+      </p>
+      <note>
+        In versions prior to 0.7 raw un-processed content was stored in
+        the "<code>content/</code>" directory. In 0.7 onwards, raw
+        un-processed data is stored alongside the xdocs. In addition,
+        in 0.6 and earlier, HTML documents could be stored in the xdocs
+        directory and served without processing. If you 
+        you wish to emulate the behaviour of 0.6 and earlier see the 
+        next section.
+      </note>
+      <p>
+        A diagram will help.
+      </p>
+      <source><![CDATA[
+The resource space          ==============>    The final URI space
+------------------                             -------------------
+Generated content ...
+ content/xdocs/index.xml                       index.html
+ content/xdocs/samples/index.xml               samples/index.html
+ content/xdocs/samples/faq.xml                 samples/faq.html
+ content/xdocs/test1.html                      test1.html
+ content/xdocs/samples/test3.html              samples/test3.html
+ content/xdocs/samples/subdir/test4.html       samples/subdir/test4.html
+
+Raw un-processed content ...
+ content/xdocs/hello.pdf                       hello.pdf
+ content/xdocs/hello.sxw                       hello.sxw
+ content/xdocs/subdir/hello.sxw                subdir/hello.sxw
+]]></source>
+
+  <section>
+    <title>How Plugins May Affect The URI Space</title>
+      <p>By using <a href="site:plugins">Forrest Input Plugins</a>
+      you can process some file formats, such as
+      OpenOffice.org documents and produce processed content from them. For example,
+      the file <code>content/xdocs/hello.sxw</code> can be used to produce a 
+      skinned version of the document at with the name <code>hello.html</code>.
+      Similarly, you can use <a href="site:plugins">Forrest Output 
+      Plugins</a> to create different output formats such as PDF, in this 
+      case <code>content/xdocs/hello.sxw</code> can produce 
+      <code>hello.pdf</code>.</p>
+      
+      <p>However, this does not affect the handling of raw content. That is, you 
+      can still retrieve the raw un-processed version with, for example, 
+      <code>hello.sxw</code>. If you want to prevent the user retrieving the 
+      un-processed version you will have to create matchers that intercept
+      these requests within your project sitemap.</p>
+      </section>
+  
+    </section>
+
+    <section id="generated">
+      <title>Basic link to internal generated pages</title>
+      <p>
+      When this type of link is encountered, Forrest will look for a
+      corresponding xml file, relative to this document (i.e. in
+      <code>content/xdocs/samples/</code>).
+      </p>
+      <p>A generated document in the current directory, which corresponds to
+      <code>content/xdocs/samples/sample.html</code> ...
+      </p>
+      <source><![CDATA[<a href="sample.html">]]><a href="sample.html">sample.html</a><![CDATA[</a>]]></source>
+      <p>In a sub-directory, which corresponds to
+      <code>content/xdocs/samples/subdir/index.html</code> ...
+      </p>
+      <source><![CDATA[<a href="subdir/index.html">]]><a href="subdir/index.html">subdir/index.html</a><![CDATA[</a>]]></source>
+    </section>
+
+    <section id="raw">
+      <title>Basic link to raw un-processed content</title>
+      <p>
+      Raw content files are not intended for any processing, they are just
+      linked to (e.g. pre-prepared PDFs, zip archives).
+      These files are placed alongside your normal content in the 
+      "<code>content/xdocs</code>" directory.
+      </p>
+      <p>A raw document in the current directory, which corresponds to
+      <code>content/xdocs/samples/helloAgain.pdf</code> ...
+      </p>
+      <source><![CDATA[<a href="helloAgain.pdf">]]><a href="helloAgain.pdf">helloAgain.pdf</a><![CDATA[</a>]]></source>
+      <p>A raw document in a sub-directory, which corresponds to 
+      <code>content/xdocs/samples/subdir/hello.zip</code> ...
+      </p>
+      <source><![CDATA[<a href="subdir/hello.zip">]]><a href="subdir/hello.zip">subdir/hello.zip</a><![CDATA[</a>]]></source>
+      <p>A raw document at the next level up, which corresponds to 
+      <code>content/hello.pdf</code> ...
+      </p>
+      <source><![CDATA[<a href="../hello.pdf">]]><a href="../hello.pdf">../hello.pdf</a><![CDATA[</a>]]></source>
+      
+      <section id="no-decoration">
+        <title>Serving (X)HTML content without Skinning</title>
+        
+        <p>Prior to version 0.7, the raw un-processed content was stored in
+        the "<code>content/</code>" directory. In 0.7 onwards, raw
+        un-processed data is stored alongside the xdocs. In addition
+        in 0.6 and earlier, HTML files could be stored in the xdocs 
+        directory and they would be served without further processing.
+        As described above, this is not the case in 0.7 where HTML files
+        are, by default, skinned by Forrest.</p>
+        
+        <p>If you 
+        you wish to emulate the behaviour of 0.6 and earlier then you
+        must add the following to your project sitemap.</p>
+        
+        <source>
+&lt;map:match pattern="**.html"&gt;
+ &lt;map:select type="exists"&gt;
+  &lt;map:when test="{project:content}{0}"&gt;
+    &lt;map:read src="{project:content}/{0}" mime-type="text/html"/&gt;
+    &lt;!--
+      Use this instead if you want JTidy to clean up your HTML
+      &lt;map:generate type="html" src="{project:content}/{0}" /&gt;
+      &lt;map:serialize type="html"/&gt;
+    --&gt;
+  &lt;/map:when&gt;
+  &lt;map:when test="{project:content.xdocs}{0}"&gt;
+    &lt;map:read src="{project:content.xdocs}/{0}" mime-type="text/html"/&gt;
+    &lt;!--
+      Use this instead if you want JTidy to clean up your HTML
+      &lt;map:generate type="html" src="{project:content.xdocs}/{0}" /&gt;
+      &lt;map:serialize type="html"/&gt;
+    --&gt;
+  &lt;/map:when&gt;
+ &lt;/map:select&gt;
+&lt;/map:match&gt;
+        </source>
+        
+        <p>The above allows us to create links to un-processed skinned files stored
+        in the <code>{project:content}</code> or <code>{project:content.xdocs}</code> 
+        directory. For example:  
+        &lt;a href="/test1.html"&gt;HTML content&lt;/a&gt;. However, it will
+        break the 0.7 behaviour of skinning HTML content. For this reason the old
+        ".ehtml" extension can be used to embed HTML content in a Forrest skinned
+        site </p>
+                
+        <p>Note that you can change the matchers above to selectively serve some
+        content as raw un-processed content, whilst still serving other content
+        as skinned documents. For example, the following snippet would allow
+        you to serve the content of an old, deprecated site without processing
+        from Forrest, whilst still allowing all other content to be processed 
+        by Forrest in the normal way:</p>
+        
+        <source>
+&lt;map:match pattern="old_site/**.html"&gt;
+ &lt;map:select type="exists"&gt;
+  &lt;map:when test="{project:content}{1}.html"&gt;
+    &lt;map:read src="{project:content}/{1}.html" mime-type="text/html"/&gt;
+    &lt;!--
+      Use this instead if you want JTidy to clean up your HTML
+      &lt;map:generate type="html" src="{project:content}/{0}" /&gt;
+      &lt;map:serialize type="html"/&gt;
+    --&gt;
+  &lt;/map:when&gt;
+&lt;/map:match&gt;
+        </source>
+        
+        <p>For example, <a href="/old_site/test1.html">HTML content</a>.</p>
+      </section>
+    </section>
+
+    <section id="url">
+      <title>Full URL to external documents</title>
+      <p>A full URL ...</p>
+      <source><![CDATA[<a href="http://forrest.apache.org/">]]><a href="http://forrest.apache.org/">http://forrest.apache.org/</a><![CDATA[</a>]]></source>
+      <p>A full URL with a fragment identifier ...</p>
+      <source><![CDATA[<a href="http://forrest.apache.org/faq.html#link_raw">]]><a href="http://forrest.apache.org/faq.html#link_raw">http://forrest.apache.org/faq.html#link_raw</a><![CDATA[</a>]]></source>
+      <p>
+      Note that Forrest does not traverse external links to look for
+      other links.
+      </p>
+    </section>
+
+    <section id="site">
+      <title>Using site.xml to manage the links</title>
+      <p>As you will have discovered, using pathnames with ../../ etc. will
+      get very nasty. Real problems occur when you use a smart text editor
+      that tries to manage the links for you. For example, it will have
+      trouble linking to the raw content files which are not yet in their
+      final location.
+      </p>
+      <p>
+      Links and filenames are bound to change and re-arrange. It is
+      essential to only change those links in one central place, not in every
+      document.
+      </p>
+      <p>
+      The "<code>site.xml</code>" configuration file to the rescue. It maps
+      symbolic names to actual resources.
+      </p>
+
+      <section id="site-simple">
+        <title>Basic link to internal generated pages</title>
+        <p>This single entry ...</p>
+        <source><![CDATA[<index label="Index" href="index.html"/>]]></source>
+        <p>
+        enables a simple link to a generated document, which corresponds to 
+        <code>content/xdocs/index.xml</code> ...
+        </p>
+        <source><![CDATA[<a href="site:index">]]><a href="site:index">site:index</a><![CDATA[</a>]]></source>
+      </section>
+
+      <section id="site-compound">
+        <title>Group some items</title>
+        <p>This compound entry ...</p>
+        <source><![CDATA[
+  <samples label="Samples" href="samples/" tab="samples">
+    <faq label="FAQ" href="faq.html"/>
+    ...
+  </samples>
+]]></source>
+        <p>
+        enables a link to a generated document, which corresponds to 
+        <code>content/xdocs/samples/index.xml</code> ...
+        </p>
+        <source><![CDATA[<a href="site:samples">]]><a href="site:samples">site:samples</a><![CDATA[</a>]]></source>
+        <p>
+        and a link to a generated document, which corresponds to 
+        <code>content/xdocs/samples/faq.xml</code> ...
+        </p>
+        <source>
+<![CDATA[<a href="site:faq">]]><a href="site:faq">site:faq</a><![CDATA[</a>]]>
+which can also be a complete reference
+<![CDATA[<a href="site:samples/faq">]]><a href="site:samples/faq">site:samples/faq</a><![CDATA[</a>]]>
+        </source>
+      </section>
+
+      <section id="site-fragment">
+        <title>Fragment identifiers</title>
+        <p>This compound entry ...</p>
+        <source><![CDATA[
+  <samples label="Samples" href="samples/" tab="samples">
+    <sample label="Apache document" href="sample.html">
+      <top href="#top"/>
+      <section href="#section"/>
+    </sample>
+    ...
+  </samples>
+]]></source>
+        <p>
+        enables a link to a fragment identifier within the
+        <code>samples/sample.html</code> document ...
+        </p>
+        <source><![CDATA[<a href="site:samples/sample/section">]]><a href="site:samples/sample/section">site:samples/sample/section</a><![CDATA[</a>]]></source>
+      </section>
+
+      <section id="site-raw">
+        <title>Define items for raw content</title>
+        <p>This entry ...</p>
+        <source><![CDATA[<hello_print href="hello.pdf"/>]]></source>
+        <p>
+        enables a link to a raw document, which corresponds to 
+        <code>content/hello.pdf</code> ...
+        </p>
+        <source><![CDATA[<a href="site:hello_print">]]><a href="site:hello_print">site:hello_print</a><![CDATA[</a>]]></source>
+
+      </section>
+
+      <section id="site-ext">
+        <title>External links</title>
+        <p>This compound entry ...</p>
+        <source><![CDATA[
+  <external-refs>
+    <forrest href="http://forrest.apache.org/">
+      <linking href="docs/linking.html"/>
+      <webapp href="docs/your-project.html#webapp"/>
+    </forrest>
+  </external-refs>
+]]></source>
+        <p>
+        enables a link to an external URL ...
+        </p>
+        <source><![CDATA[<a href="ext:forrest">]]><a href="ext:forrest">ext:forrest</a><![CDATA[</a>]]></source>
+        <p>
+        and a link to another external URL ...
+        </p>
+        <source>
+<![CDATA[<a href="ext:linking">]]><a href="ext:linking">ext:linking</a><![CDATA[</a>]]>
+which can also be a complete reference
+<![CDATA[<a href="ext:forrest/linking">]]><a href="ext:forrest/linking">ext:forrest/linking</a><![CDATA[</a>]]>
+        </source>
+        <p>
+        and a link to another external URL with a fragment identifier ...
+        </p>
+        <source>
+<![CDATA[<a href="ext:webapp">]]><a href="ext:webapp">ext:webapp</a><![CDATA[</a>]]>
+which can also be a complete reference
+<![CDATA[<a href="ext:forrest/webapp">]]><a href="ext:forrest/webapp">ext:forrest/webapp</a><![CDATA[</a>]]>
+        </source>
+      </section>
+    </section>
+
+    <section id="images">
+      <title>Images</title>
+      <p>
+        Images (and other resources) are handled by the main/webapp/resource.xmap sitemap.
+        It uses the main/webapp/locationmap.xml to look in various locations for images.
+        As usual, the first match wins.
+      </p>
+      <p> Here is the locationmap snippet ... </p>
+      <source><![CDATA[
+    <match pattern="project.images.**.*">
+      <select>
+        <location src="{project:resources.images}{1}.{2}" />
+        <location src="{project:content}../resources/images/{1}.{2}" />
+        <location src="{project:content.xdocs}images/{1}.{2}" />
+        <location src="{project:content.xdocs}{1}.{2}" />
+      </select>
+    </match>
+]]></source>
+      <p>Which means look first in a project-defined images directory, then in the
+        default location (which is usually src/documentation/resources/images/),
+        then in the old default location (src/documentation/content/xdocs/images/),
+        then relative to the root of your xdocs.</p>
+      <p>
+        The document author specifies the final image locations with these various
+        "<code>src=</code>" links. Behind-the-scenes Cocoon handles the requests
+        using the sitemap and locationmap.
+      </p>
+      <p>This sample has the following image locations:</p>
+      <source><![CDATA[
+    src/documentation/resources/images/ellipse-2.svg
+    src/documentation/resources/images/icon-a.png
+    src/documentation/resources/images/icon-b.png
+    src/documentation/resources/images/sub-dir/icon-c.png
+    src/documentation/content/xdocs/images/icon-e.png
+    src/documentation/content/xdocs/samples/icon-d.png
+    src/documentation/content/xdocs/samples/ellipse.svg
+    src/documentation/content/xdocs/samples/cocoon-pyramid.aart
+]]></source>
+      <p>Here is the effect of the various image links ...</p>
+      <ol>
+        <li>
+          <img src="/images/icon-a.png" alt="Icon" />
+          <code>&lt;img src="/images/icon-a.png"</code>
+          ... The source file is found in src/documentation/resources/images/ directory.
+        </li>
+        <li>
+          <img src="/images/sub-dir/icon-c.png" alt="Icon" />
+          <code>&lt;img src="/images/sub-dir/icon-c.png"</code>
+          ... The source file is found in src/documentation/resources/images/sub-dir/ directory.
+        </li>
+        <li>
+          <img src="/images/icon-e.png" alt="Icon" />
+          <code>&lt;img src="/images/icon-e.png"</code>
+          ... The source file is not found in the normal src/documentation/resources/images/
+          so Cocoon looks in the next location and finds the source in
+          src/documentation/content/xdocs/images/ directory.
+          This supports backward-compatibility for this old default location.
+        </li>
+        <li>
+          <img src="images/icon-a.png" alt="Icon" />
+          <code>&lt;img src="images/icon-a.png"</code>
+          ... same as example 1 above. Except this time the generated image is relative to the document.
+        </li>
+        <li>
+          <img src="../images/icon-a.png" alt="Icon" />
+          <code>&lt;img src="../images/icon-a.png"</code>
+          ... Relative reference. Forrest "absolutizes" the URLs to be like the URLs
+          in examples 1 and 2 and 3. Then Cocoon looks in the normal locations as described above.
+          The source file is found in src/documentation/resources/images/ directory.
+        </li>
+        <li>
+          <img src="../../images/icon-b.png" alt="Icon" />
+          <code>&lt;img src="../../images/icon-b.png"</code>
+          ... Broken relative reference (it points up beyond the document root).
+          Never mind, Forrest "absolutizes" the URLs to be like the URLs in examples 1 and 2 and 3. 
+          The source file is found in src/documentation/resources/images/ directory.
+          However there is a problem here. When using Forrest in command-line mode,
+          the image will be generated outside the document directory.
+          It is better to use absolute /image/ URLs or be very careful about using
+          such relative links (Forrest will not repart an error).
+        </li>
+      <li>
+        <img src="/images/ellipse-2.png" alt="Icon" /><br />
+        <code>&lt;img src="/images/ellipse-2.png"</code>
+        ... Cocoon tried the various locations for a PNG image called
+        ellipse-2.png but did not find one anywhere. So the next sitemap match
+        looks for a corresponding
+        ellipse-2.svg and generates the PNG image on-the-fly.
+        The source file is found in src/documentation/resources/images/ directory.
+      </li>
+<!-- Remove this sample.
+  See: http://marc.theaimsgroup.com/?t=114925130200003
+        <li>
+          <img src="/icon-b.png" alt="Icon" />
+          <code>&lt;img src="/icon-b.png"</code>
+          ... Magic.
+          The source file is found in src/documentation/resources/images/ directory.
+        </li>
+-->
+      </ol>
+      <p>The image links shown above are handled by the resources.xmap using
+      special matches for the "images" directory in the URI.
+      </p>
+      <p>The main/webapp/resources.xmap has another section to deal specifically with PNG images. It looks first for an SVG source file which will be used to generate the PNG image. If that is not found then it looks for an ASCII art source file. Then looks for a pre-prepared PNG image.</p>
+      <ol>
+       <li>
+        <img src="ellipse.png" alt="Icon" /><br />
+        <code>&lt;img src="ellipse.png"</code>
+        ... Cocoon tried the various locations for a PNG image called
+        ellipse-2.png but did not find one anywhere. So the next sitemap match
+        looks for a corresponding
+        ellipse-2.svg and generates the PNG image on-the-fly.
+        The source file is found in the current directory src/documentation/content/xdocs/samples/
+      </li>
+      <li>
+        <img src="cocoon-pyramid.png" alt="Icon"/><br />
+        <code>&lt;img src="cocoon-pryamid.png"</code>
+        ... ASCII Art. Cocoon did not find a PNG image, nor an SVG file.
+        So the next sitemap match looks for a corresponding
+        cocoon-pryamid.aart and generates the PNG image on-the-fly.
+        The source file is found in the current directory src/documentation/content/xdocs/samples/
+        </li>
+        <li>
+          <img src="icon-d.png" alt="Icon" />
+          <code>&lt;img src="icon-d.png"</code>
+          ... Relative to this document.
+          The source file is found in the current directory src/documentation/content/xdocs/samples/
+        </li>
+      </ol>
+      <note>
+        You might wonder why the above images all show correctly in dynamic
+        'forrest run' mode, but some appear to be broken during static docs
+        generation 'forrest site' mode. The latter is for generating a set
+        of static docs for deployment to a server. If you used URLs beginning
+        with a slash, "/images/...", then that is their location. So the
+        generated docs on the
+        "<a href="ext:forrest-zone">forrest zone</a>" demos appear to be broken.
+      </note>
+    </section>
+  </body>
+</document>

Propchange: forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/linking.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Added: forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/sample.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/sample.xml?view=auto&rev=482028
==============================================================================
--- forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/sample.xml (added)
+++ forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/sample.xml Sun Dec  3 19:23:29 2006
@@ -0,0 +1,407 @@
+<?xml version="1.0"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document> 
+  <header> 
+    <title>The Apache Forrest xdocs document-v2.0 DTD</title> 
+    <notice>The content of this document doesn't make any sense at all.</notice>
+    <abstract>This is a demonstration document using all possible elements in
+      the current Apache Forrest xdocs <code>document-v20.dtd</code>
+    </abstract> 
+  </header> 
+  <body> 
+    <note>
+      This is a demonstration document using all possible elements in the
+      current Apache Forrest xdocs <code>document-v20.dtd</code>
+      (See the <a href="#changes">DTD changes</a> section at the bottom.)
+    </note>
+    <section id="sample">
+      <title>Sample Content</title>
+      <p><strong>Hint:</strong> See the xml source to see how the various
+      elements are used and see the
+<!-- FOR-321 workaround
+      <a href="ext:dtd-docs">DTD reference documentation</a>.
+-->
+      <a href="http://forrest.apache.org/docs/dtd-docs.html">DTD reference documentation</a>.
+      </p>
+      <section id="block-inline">
+        <title>Block and inline elements</title>
+      <p>This is a simple paragraph. Most documents contain a fair amount of
+        paragraphs. Paragraphs are called <code>&lt;p&gt;</code>.</p> 
+      <p xml:space="preserve"
+        >With the <code>&lt;p xml:space="preserve"&gt;</code> attribute, you can declare
+        that whitespace should    be   preserved, without implying it is in any other
+        way special.</p>
+      <p>
+        This next paragraph has a class attribute of 'quote'.  CSS can
+        be used to present this <code>&lt;p class='quote'&gt;</code> in
+        a different style than the other paragraphs.  The handling of
+        this quoted paragraph is defined in the &lt;extra-css&gt;
+        element in the skinconf.xml.
+      </p>
+      <p class="quote">
+        Anyway, like I was sayin', shrimp is the fruit of the sea. You can
+        barbecue it, boil it, broil it, bake it, sautee it. Dey's uh,
+        shrimp-kabobs, shrimp creole, shrimp gumbo. Pan fried, deep fried,
+        stir-fried. There's pineapple shrimp, lemon shrimp, coconut shrimp,
+        pepper shrimp, shrimp soup, shrimp stew, shrimp salad, shrimp and
+        potatoes, shrimp burger, shrimp sandwich. That- that's about it.
+      </p>
+      <p>A number of in-line elements are available in the DTD, we will show them
+        inside an unordered list (<code>&lt;ul&gt;</code>):</p> 
+      <ul> 
+        <li>Here is a simple list item (<code>&lt;li&gt;</code>).</li> 
+        <li>Have you seen the use of the <code>&lt;code&gt;</code> element in the
+          previous item?</li> 
+        <li>Also, we have <code>&lt;sub&gt;</code> and <code>&lt;sup&gt;</code>
+          elements to show content <sup>above</sup> or <sub>below</sub> the text
+          baseline.</li> 
+        <li>There is a facility to <em>emphasize</em> certain words using the
+          <code>&lt;em&gt;</code> <strong><code>&lt;strong&gt;</code></strong>
+          elements.</li> 
+        <li>We can use
+          <icon height="22" width="26" src="../images/icon.png" alt="feather"/>
+          <code>&lt;icon&gt;</code>s too.</li> 
+        <li>Another possibility is the <code>&lt;img&gt;</code> element:
+          <img src="../images/icon.png" alt="another feather" height="22" width="26"/>,
+          which offers the ability to refer to an image map.</li> 
+        <li>We have elements for hyperlinking: 
+          <dl> 
+            <dt><code>&lt;a href="faq.html"&gt;</code></dt> 
+            <dd>Use this to
+              <a href="faq.html" title="Example of a document via link">link</a>
+              to another document. As per normal, this will open the new document
+              in the same browser window.</dd> 
+
+            <dt><code>&lt;a href="#section"&gt;</code></dt> 
+            <dd>Use this to
+              <a href="#section" title="Example of a document via local anchor">link</a>
+              to the named anchor in the current document.
+            </dd> 
+
+            <dt><code>&lt;a href="faq.html#forrest"&gt;</code></dt> 
+            <dd>Use this to
+              <a href="faq.html#forrest" title="Example of a document via link and anchor">link</a>
+              to another document and go to the named anchor. This will open
+              the new document in the same browser window.
+            </dd> 
+            <dt>Targetted window control with jump and fork.</dt> 
+            <dd>See demonstration
+             <a href="#link-class">using class attribute on links</a>.
+            </dd> 
+        </dl></li> 
+
+        <li>Oh, by the way, a definition list <code>&lt;dl&gt;</code> was used inside
+          the previous list item. We could put another 
+          <ul> 
+            <li>unordered list</li> 
+            <li>inside the list item</li> 
+          </ul>
+          <table>
+            <caption>A sample nested table</caption>
+            <tr><td>Or even tables.. </td><td>
+                <table><tr><td>inside tables..</td></tr></table>
+            </td></tr>
+            <tr><td>or inside lists, but I believe this liberty gets quickly quite
+                hairy as you see.</td></tr>
+          </table>
+        </li>
+      </ul> 
+      <p>So far for the in-line elements, let's look at some paragraph-level
+        elements.</p> 
+      <fixme author="SN">The <code>&lt;fixme&gt;</code> element is used for stuff
+        which still needs work. Mind the <code>author</code> attribute!</fixme> 
+      <note>Use the <code>&lt;note&gt;</code> element to draw attention to something, e.g. ...The <code>&lt;code&gt;</code> element is used when the author can't
+        express himself clearly using normal sentences ;-)</note>
+      <warning>Sleep deprivation can be the result of being involved in an open
+        source project. (a.k.a. the <code>&lt;warning&gt;</code> element).
+      </warning>
+      <note label="Important">If you want your own labels for notes and
+        warnings, specify them using the <code>label</code> attribute.
+      </note>
+      <p>Apart from unordered lists, we have ordered lists too, of course.</p> 
+      <ol> 
+        <li>Item 1</li> 
+        <li>Item 2</li> 
+        <li>This should be 3 if my math is still OK.</li> 
+      </ol>
+      </section>
+
+      <section id="presentations">
+        <title>Various presentation formats</title>
+
+        <p>This sample document, written in document-v20 XML can be presented
+        via Forrest in a number of different formats. The links in the
+        following list show this document in each of the currently available
+        formats.</p>
+
+        <p>Each of the formats can be made available as a link near the top of
+        the page. Actual placement of those links depends on the skin
+        currently in use. Those links are enabled in the skinconf.xml via the
+        &#60;disable-XXX-link&#62; elements in the skinconf.xml</p>
+
+        <table>
+          <tr>
+            <th>Presentation Format</th>
+
+            <th>Description</th>
+
+            <th>skinconf.xml Element</th>
+          </tr>
+
+          <tr>
+            <td><a href="sample.html">HTML</a></td>
+
+            <td>This document in HTML format. </td>
+
+            <td>Always generated by default. Cannot be turned off.</td>
+          </tr>
+
+          <tr>
+            <td><a href="sample.xml">XML</a></td>
+
+            <td>This document in its raw XML format.</td>
+
+            <td>&#60;disable-xml-link&#62;. By default, set to true, meaning
+            that this link will not be shown.</td>
+          </tr>
+
+          <tr>
+            <td><a href="sample.pdf">PDF</a></td>
+
+            <td>This document as Adobe PDF</td>
+
+            <td>&#60;disable-pdf-link&#62;. By default, set to false, meaning
+            that this link will be shown.</td>
+          </tr>
+
+          <tr>
+            <td>Text</td>
+
+            <td><p>This document as straight text.</p>
+            <p>For additional information see the Forrest text-output
+            plugin.</p></td>
+
+            <td>&#60;disable-txt-link&#62;. By default, set to true, meaning
+            that this link will not be shown.</td>
+          </tr>
+
+          <tr>
+            <td>POD</td>
+
+            <td><p>This document as Perl POD (Plain Old Documentation). Text
+            with minimal formatting directives. If on a *nix system with perl
+            installed, see &#34;man perlpod&#34;.</p>
+            <p>For additional information see the Forrest pod-output
+            plugin.</p></td>
+
+            <td>&#60;disable-pod-link&#62;. By default, set to true, meaning
+            that this link will not be shown.</td>
+          </tr>
+        </table>
+      </section>
+      <section id="section"> 
+        <title>Using sections</title>
+        <p>You can use sections to put some structure in your document. For some
+          strange historical reason, the section title is an attribute of the
+          <code>&lt;section&gt;</code> element.</p> 
+      </section> 
+      <section id="sub-section">
+        <title>Sections, the sequel</title>
+        <p>Just some second section.</p> 
+        <section id="sub-sub-section">
+          <title>Section 2.1</title>
+          <p>Which contains a subsection (2.1).</p> 
+        </section> 
+      </section> 
+
+      <section id="source">
+        <title>Showing preformatted source code</title> 
+        <p>Enough about these sections. Let's have a look at more interesting
+          elements, <code>&lt;source&gt;</code> for instance:</p> 
+        <source>
+// This example is from the book _Java in a Nutshell_ by David Flanagan.
+// Written by David Flanagan.  Copyright (c) 1996 O'Reilly &amp; Associates.
+// You may study, use, modify, and distribute this example for any purpose.
+// This example is provided WITHOUT WARRANTY either expressed or implied.
+
+import java.applet.*;    // Don't forget these import statements!
+import java.awt.*;
+
+public class FirstApplet extends Applet {
+    // This method displays the applet.
+    // The Graphics class is how you do all drawing in Java.
+    public void paint(Graphics g) {
+        g.drawString("Hello World", 25, 50);
+    }
+}</source>
+        <p>CDATA sections are used within 
+          <code>&lt;source&gt;</code> elements so that you can write pointy
+           brackets without needing to escape them with messy
+          <code>&amp;lt;</code> entities ...
+        </p> 
+        <source><![CDATA[
+<pointy>
+  easy
+</pointy>
+]]></source>
+        <p>Please take care to still use a sensible line-length within your
+          source elements.</p>
+      </section>
+
+      <section id="table">
+        <title>Using tables</title>
+        <p>And now for a table:</p>
+        <table>
+          <caption>Table caption</caption>
+          <tr>
+            <th>heading cell 1</th>
+            <th>heading cell 2</th>
+            <th>heading cell 3</th>
+          </tr>
+          <tr>
+            <td>data cell</td>
+            <td colspan="2">this data cell spans two columns</td>
+          </tr>
+          <tr>
+            <td>
+              Tables can be nested:
+            </td>
+            <td>
+              <table>
+                <tr>
+                  <th>column 1</th>
+                  <th>column 2</th>
+                </tr> 
+                <tr>
+                  <td>cell A</td>
+                  <td>cell B</td>
+                </tr>
+              </table>
+            </td>
+            <td>
+              <ul><li>and can include most other elements</li><li>such as lists</li></ul>
+            </td>
+          </tr>
+        </table> 
+      </section>
+
+      <anchor id="second-figure-anchor"/>
+      <section id="figure"> 
+        <title>Using figures</title>
+        <p>And a <code>&lt;figure&gt;</code> to end all of this.
+          Note that this can also be implemented with an
+          <code>&lt;img&gt;</code> element.
+        </p>
+        <figure src="../images/project.png" alt="The fine Forrest logo" width="220" height="65"/>	
+      </section>
+      <section id="link-class">
+        <title>Using class attribute on links</title>
+
+        <p>The document-v13 had elements &lt;fork&gt; and &lt;jump&gt;. In
+        document-v20, those elements no longer exist but the functionality can
+        be duplicated by using the @class attribute.
+        Even though the opening of separate windows should be under the
+        control of the user, these techniques can still be employed.</p>
+
+        <table>
+          <tr>
+            <th><p>Document V1.3</p></th>
+
+            <th><p>Document V2.0</p></th>
+          </tr>
+
+          <tr>
+            <td><p>&lt;fork href="faq.html"&gt;</p></td>
+
+            <td><a class="fork" href="faq.html">&lt;a class="fork"
+            href="faq.html"&gt;</a></td>
+          </tr>
+
+          <tr>
+            <td><p>&lt;jump href="faq.html"&gt;</p></td>
+
+            <td><p><a class="jump" href="faq.html">&lt;a class="jump"
+            href="faq.html"&gt;</a></p></td>
+          </tr>
+        </table>
+      </section>
+    </section>
+
+    <section id="changes">
+      <title>DTD changes</title>
+      <p>See the generated
+<!-- FOR-321 workaround
+      <a href="ext:dtd-docs">DTD reference documentation</a>.
+-->
+      <a href="http://forrest.apache.org/docs/dtd-docs.html">DTD reference documentation</a>.
+      </p>
+      <section id="changes-20">
+        <title>Changes between document-v13 and document-v20</title>
+        <ul>
+          <li>Renamed <strong>&lt;link&gt;</strong>
+             to <strong>&lt;a&gt;</strong>
+          </li>
+          <li>Removed <strong>&lt;fork&gt;</strong>
+             and <strong>&lt;jump&gt;</strong> in favour of the
+             <strong>&lt;a&gt;</strong> element. See demonstration
+             <a href="#link-class">using class attribute on links</a>.
+          </li>
+        </ul>
+      </section>
+      <section id="changes-13">
+        <title>Changes between document-v12 and document-v13</title>
+        <p>
+          All v1.2 docs will work fine as v1.3 DTD. The main change is the
+          addition of a @class attribute to every element, which enables the
+          "extra-css" section in the skinconf to be put to good use.
+        </p>
+      </section>
+      <section id="changes-12">
+        <title>Changes between document-v11 and document-v12</title>
+        <p>
+          doc-v12 enhances doc-v11 by relaxing various restrictions that were
+          found to be unnecessary.
+        </p>
+        <ul>
+          <li>
+            Links ((link|jump|fork) and inline elements (br|img|icon|acronym) are
+            allowed inside title.
+          </li>
+          <li>
+            Paragraphs (p|source|note|warning|fixme), table and figure|anchor are
+            allowed inside li.
+          </li>
+          <li>
+            Paragraphs (p|source|note|warning|fixme), lists (ol|ul|dl), table,
+            figure|anchor are allowed inside definition lists (dd) and tables (td
+            and dh).
+          </li>
+          <li>
+            Inline content
+            (strong|em|code|sub|sup|br|img|icon|acronym|link|jump|fork) is
+            allowed in strong and em.
+          </li>
+        </ul>
+      </section>
+    </section>
+  </body> 
+  <footer> 
+    <legal>This is a legal notice, so it is <strong>important</strong>.</legal> 
+  </footer>
+</document>

Propchange: forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/sample.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Added: forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/static.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/static.xml?view=auto&rev=482028
==============================================================================
--- forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/static.xml (added)
+++ forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/static.xml Sun Dec  3 19:23:29 2006
@@ -0,0 +1,62 @@
+<?xml version="1.0"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document> 
+  <header> 
+    <title>Static content - including raw un-processed files and documents</title> 
+  </header> 
+  <body> 
+    <section>
+      <title>Linking to static content</title>
+      <p>
+        You can place some types of raw content into the xdocs directory. For example,
+        you can place a PDF file in <code>src/documentation/content/xdocs</code> and link
+        to it normally, 
+        <strong>&lt;a href="../hello.pdf"&gt;</strong><a href="../hello.pdf">hello.pdf</a><strong>&lt;/a&gt;</strong>
+        However, note that if the file is one that Forrest is able to process, for example
+        an HTML file, these files will be processed accordingly.</p>
+      
+      <p>
+        It is also worth noting that files in the xdocs directory will only be copied 
+        into your final site if there is a link to them somewhere in the site. See the next
+        section for details of how to include content that is not linked.</p>
+        
+      <p>
+        For more information see the
+        <a href="site:linking">Linking demonstration</a>.</p>
+    </section>
+    
+    <section>
+      <title>Including Static Content that is Not Linked</title>
+      
+      <p>
+        You can include raw HTML, PDFs, plain-text, and other files. In your final site by
+        placing them in the <code>src/documentation/content</code> directory. Files in this
+        directory will be copied over automatically but will not be processed in any way by
+        Forrest, that is they will be linked to as raw files.</p>
+        
+      <p>
+        You can also have sub-directories such as 
+        <code>src/documentation/content/samples/subdir/</code> which
+        reflects your main
+        <code>xdocs/</code> tree. The raw files will then end up
+        beside your documents.
+      </p>
+    </section>
+  </body>
+</document>

Propchange: forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/static.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Added: forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/subdir/book-sample.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/subdir/book-sample.xml?view=auto&rev=482028
==============================================================================
--- forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/subdir/book-sample.xml (added)
+++ forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/subdir/book-sample.xml Sun Dec  3 19:23:29 2006
@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "http://forrest.apache.org/dtd/book-cocoon-v10.dtd">
+
+<!-- Sample book.xml file.  If this file is renamed to 'book.xml', it will be
+used to define the menu in this subdirectory, instead of that generated from
+the usual site.xml mechanism. The normal relative and absolute hrefs are also
+available. -->
+
+<book software="MyProj"
+  title="MyProj"
+  copyright="@year@ The Apache Software Foundation"
+  xmlns:xlink="http://www.w3.org/1999/xlink">
+
+  <menu label="About">
+    <!-- using the normal site.xml linking mechanism -->
+    <menu-item label="Index" href="site:index"/>
+    <!-- using relative URIs with relative path -->
+    <menu-item label="Sample page" href="../sample.html"/>
+    <!-- using relative URIs with absolute path -->
+    <menu-item label="Sample ihtml page" href="/samples/ihtml-sample.html"/>
+    <!-- using the normal site.xml linking mechanism -->
+    <menu-item label="FAQ" href="site:faq"/>
+    <menu-item label="Changes" href="site:changes"/>
+    <menu-item label="Todo" href="site:todo"/>
+  </menu>
+
+  <menu label="Subdir">
+    <menu-item label="index" href="site:subdir/index"/>
+  </menu>
+
+</book>

Propchange: forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/subdir/book-sample.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Added: forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/subdir/index.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/subdir/index.xml?view=auto&rev=482028
==============================================================================
--- forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/subdir/index.xml (added)
+++ forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/subdir/index.xml Sun Dec  3 19:23:29 2006
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document>
+   <header>
+      <title>Page generated from a sub-directory</title>
+
+      <authors>
+        <person name="Joe Bloggs" email="joe@joescompany.org" />
+       </authors>
+   </header>
+
+   <body>
+     <section>
+       <title>A sub-directory</title>
+       <p>This was generated from a sub-directory.</p>
+       <p>When creating new subdirectories, remember that these <em>must</em>
+         be declared in site.xml or each directory must have a book.xml file.
+       </p>
+      </section>
+   </body>
+</document>
+

Propchange: forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/subdir/index.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Added: forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/svg.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/svg.xml?view=auto&rev=482028
==============================================================================
--- forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/svg.xml (added)
+++ forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/svg.xml Sun Dec  3 19:23:29 2006
@@ -0,0 +1,42 @@
+<?xml version="1.0"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document> 
+  <header> 
+    <title>Using Scalable Vector Graphics (SVG)</title> 
+  </header> 
+  <body> 
+    <p>
+      Forrest can deliver raw SVG files for capable browsers, e.g. Firefox.
+      See <a href="ellipse.svg">example</a>.
+    </p>
+    <p>
+      Forrest can convert SVG files into Portable Network Graphic (PNG).
+      See <a href="ellipse.png">example</a>. Note that Forrest will first
+      look for a pre-prepared PNG file, and if not found then it will
+      generate the PNG from the SVG.
+    </p>
+    <p>
+      Be careful. We only provide a local copy of the SVG 1.0 DTD
+      so if you use SVG 1.1 then there will be network trips
+      for the DTDs. 
+      <a href="http://forrest.apache.org/docs/dev/validation.html#catalog">Configure</a>
+      your local catalog entity resolver for your local DTD copies.
+    </p>
+  </body>
+</document>

Propchange: forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/svg.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Added: forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/usemap.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/usemap.xml?view=auto&rev=482028
==============================================================================
--- forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/usemap.xml (added)
+++ forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/usemap.xml Sun Dec  3 19:23:29 2006
@@ -0,0 +1,61 @@
+<?xml version="1.0"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document> 
+  <header> 
+    <title>Interactive client-side imagemaps - the usemap attribute</title> 
+  </header> 
+  <body> 
+    <section id="demo">
+      <title>Imagemap demo</title>
+      <p>
+        <img src="/images/usemap.gif" usemap="#my-map"
+          alt="usemap demo" width="256" height="256"/>
+      </p>
+      <p>
+        <map name="my-map">
+          <area shape="rect" coords="173,14,240,71"
+             alt="Rectangle" href="ext:forrest"/>
+          <area shape="circle" coords="53,172,28"
+             alt="Circle" href="../index.html"/>
+          <area shape="default" coords="0,0.256,256"
+             alt="Default" href="http://www.apache.org"/>
+        </map>
+      </p>
+    </section>
+    <section id="source">
+      <title>Source code</title>
+      <source><![CDATA[
+      <p>
+        <img src="/images/usemap.gif" usemap="#my-map"
+          alt="usemap demo" width="256" height="256"/>
+      </p>
+      <p>
+        <map name="my-map">
+          <area shape="rect" coords="173,14,240,71"
+             alt="Rectangle" href="ext:forrest"/>
+          <area shape="circle" coords="53,172,28"
+             alt="Circle" href="../index.html"/>
+          <area shape="default" coords="0,0.256,256"
+             alt="Default" href="http://www.apache.org"/>
+        </map>
+      </p>
+]]></source>
+    </section>
+  </body>
+</document>

Propchange: forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/usemap.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Added: forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/xml-entities.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/xml-entities.xml?view=auto&rev=482028
==============================================================================
--- forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/xml-entities.xml (added)
+++ forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/xml-entities.xml Sun Dec  3 19:23:29 2006
@@ -0,0 +1,82 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd" [
+<!ENTITY % symbols-project
+    PUBLIC "-//Apache Forrest//ENTITIES Symbols Project v1.0//EN"
+    "symbols-project-v10.ent"> 
+  %symbols-project;
+]>
+<document> 
+  <header> 
+    <title>Using XML entities for character replacements</title> 
+  </header> 
+  <body> 
+    <p>
+      All of the normal xml character entities are available for use
+      in your source documents.
+      So you can use "<code>&amp;trade;</code>"
+      for the trademark symbol (&trade;)
+      and use "<code>&amp;ouml;</code>"
+      for special accents (&ouml;).
+    </p>
+    <p>
+      Forrest also has some default sets of symbols. There is one set
+      for the core of Forrest. These are automatically available
+      for use in the "document-v*" series of document types.
+      (If you want to use them in another document type, then you
+      need to specify them in the document type declaration of your
+      xml instance documents or in your custom DTD. See below.)
+    </p>
+    <p>
+      For example,
+      use "<code>&amp;for-s;</code>" to represent the strong
+      text string "&for-s;". See the list of available symbols at
+      <code>main/webapp/resources/schema/entity/symbols-core-v10.ent</code>
+      which shows that that example entity was declared as
+      <code><![CDATA[<strong>Apache Forrest</strong>]]></code>.
+    </p>
+    <p>
+      You can supply lists of symbols for your own project too.
+      Create a fresh site with 'forrest seed' and see the set
+      <code>src/documentation/resources/schema/symbols-project-v10.ent</code>
+    </p>
+    <p>
+      For example,
+      use "<code>&amp;myp-t;</code>" to represent the project name
+      together with trademark symbol "&myp-t;".
+    </p>
+    <p>
+      The set of project symbols is already configured. To use the symbols
+      in your documents, add to the document type declaration. For example,
+      see the source for this document
+      (<code>src/documentation/content/xdocs/samples/xml-entites.xml</code>)
+      which declares the project symbol set ...
+    </p>
+    <source><![CDATA[
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd" [
+<!ENTITY % symbols-project
+    PUBLIC "-//Apache Forrest//ENTITIES Symbols Project v1.0//EN"
+    "symbols-project-v10.ent"> 
+  %symbols-project;
+]>
+<document> 
+  ...
+]]></source>
+  </body>
+</document>

Propchange: forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/samples/xml-entities.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Added: forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/tabs.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/tabs.xml?view=auto&rev=482028
==============================================================================
--- forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/tabs.xml (added)
+++ forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/tabs.xml Sun Dec  3 19:23:29 2006
@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!DOCTYPE tabs PUBLIC "-//APACHE//DTD Cocoon Documentation Tab V1.1//EN" "http://forrest.apache.org/dtd/tab-cocoon-v11.dtd">
+
+<tabs software="MyProj"
+  title="MyProj"
+  copyright="Foo"
+  xmlns:xlink="http://www.w3.org/1999/xlink">
+
+  <!-- The rules for tabs 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.
+
+   Tabs can be embedded to a depth of two. The second level of tabs will only 
+    be displayed when their parent tab is selected.    
+  -->
+
+  <tab id="" label="Home" dir="" indexfile="index.html"/>
+  <tab id="samples" label="Samples" dir="samples" indexfile="sample.html">
+    <tab id="samples-index" label="Index" dir="samples" indexfile="index.html"/>
+    <tab id="samples-sample2" label="Sample2" dir="samples" indexfile="static.html"/>
+  </tab>
+  <tab label="Apache XML Projects" href="http://xml.apache.org">
+    <tab label="Forrest" href="http://forrest.apache.org"/>
+    <tab label="Xerces" href="http://xml.apache.org/xerces"/>
+  </tab>
+  <tab id="plugins" label="Plugins" dir="pluginDocs/plugins_0_70" indexfile="index.html"/>
+  <!-- Add new tabs here, eg:
+  <tab label="How-Tos" dir="community/howto/"/>
+  <tab label="XML Site" dir="xml-site/"/>
+  -->
+
+</tabs>

Propchange: forrest/trunk/whiteboard/forrest2/core/src/examples/forrest1SeedSite/src/xdocs/tabs.xml
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message