forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: rev 35726 - in forrest/trunk/src: core/fresh-site/src/documentation/content/xdocs/samples documentation/content/xdocs documentation/content/xdocs/docs
Date Thu, 05 Aug 2004 06:06:15 GMT
Author: crossley
Date: Wed Aug  4 23:06:14 2004
New Revision: 35726

Added:
   forrest/trunk/src/documentation/content/xdocs/docs/document-v13.xml   (contents, props
changed)
Modified:
   forrest/trunk/src/core/fresh-site/src/documentation/content/xdocs/samples/sample.xml
   forrest/trunk/src/documentation/content/xdocs/site.xml
Log:
Add the new demo document for document-v13 DTD.
It is a copy of the old document-v12 demo and enhanced.
Also synchronise with the similar sample.xml document in the seed site.


Modified: forrest/trunk/src/core/fresh-site/src/documentation/content/xdocs/samples/sample.xml
==============================================================================
--- forrest/trunk/src/core/fresh-site/src/documentation/content/xdocs/samples/sample.xml	(original)
+++ forrest/trunk/src/core/fresh-site/src/documentation/content/xdocs/samples/sample.xml	Wed
Aug  4 23:06:14 2004
@@ -14,17 +14,26 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://apache.org/forrest/dtd/document-v13.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
 <document> 
   <header> 
-    <title>The document-v1.3 DTD</title> 
-    <notice>This document doesn't make any sense at all.</notice> 
-    <abstract>A nonsense document using all possible elements in the current
-      <code>document-v13.dtd</code>.</abstract> 
+    <title>The Apache Forrest xdocs document-v1.3 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-v13.dtd</code>
+    </abstract> 
   </header> 
   <body> 
-    <section>
+    <note>
+      This is a demonstration document using all possible elements in the
+      current Apache Forrest xdocs <code>document-v13.dtd</code>
+      (See the <link href="#changes">DTD changes</link> 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
+      <link href="site:dtd-docs">DTD documentation</link>.</p>
       <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"
@@ -60,7 +69,7 @@
           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> 
+          <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> 
@@ -131,7 +140,11 @@
       <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>

+        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> 
@@ -139,24 +152,22 @@
         <li>This should be 3 if my math is still OK.</li> 
       </ol> 
 
-      <anchor id="section"/>
-      <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>
+      <section id="sub-section">
         <title>Sections, the sequel</title>
         <p>Just some second section.</p> 
-        <section>
+        <section id="sub-sub-section">
           <title>Section 2.1</title>
           <p>Which contains a subsection (2.1).</p> 
         </section> 
       </section> 
 
-      <anchor id="source"/>
-      <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>

@@ -192,6 +203,14 @@
             <td>data cell</td> 
             <td>data cell</td> 
           </tr> 
+          <tr>
+            <td>
+              Tables can be nested
+            </td>
+            <td>
+              <ul><li>and can include most other elements, like lists</li></ul>
+            </td>
+          </tr>
         </table> 
         <p>Not much of attributes with <code>&lt;table&gt;</code>,
if you ask me.</p>
       </section>
@@ -199,46 +218,57 @@
       <anchor id="second-figure-anchor"/>
       <section id="figure"> 
         <title>Using figures</title>
-
-        <p>And a figure to end all of this.</p>
-        <figure src="../images/project-logo.gif" alt="project logo" width="220" height="65"/>
+        <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-logo.png" alt="The fine Forrest logo" width="220"
height="65"/>	
       </section>
     </section>
-    <section>
-      <title>Changes since <link href="site:document-v12">document-v12</link></title>
-      <p>
-        class attribute now allowed on all elements.
-      </p>
-    </section>
-    <section>
-      <title>Changes since <link href="site:document-v11">document-v11</link></title>
-      <p>
-        doc-v12 enhances doc-v11 by relaxing various restrictions that were
-        found to be unnecessary.
+
+    <section id="changes">
+      <title>DTD changes</title>
+      <p>See the generated
+        <link href="site:dtd-docs">DTD documentation</link>.
       </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>
+      <section id="changes-13">
+        <title>Changes since <link href="site:document-v12">document-v12</link></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 since <link href="site:document-v11">document-v11</link></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>
+          </li>
+        </ul>
+      </section>
     </section>
   </body> 
   <footer> 
-    <legal>Copyright 2002-2004 The Apache Software Foundation</legal> 
+    <legal>This is a legal notice, so it is <strong>important</strong>.</legal>

   </footer>
 </document>

Added: forrest/trunk/src/documentation/content/xdocs/docs/document-v13.xml
==============================================================================
--- (empty file)
+++ forrest/trunk/src/documentation/content/xdocs/docs/document-v13.xml	Wed Aug  4 23:06:14
2004
@@ -0,0 +1,274 @@
+<?xml version="1.0"?>
+<!--
+  Copyright 2002-2004 The Apache Software Foundation
+
+  Licensed 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 V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
+<document> 
+  <header> 
+    <title>The Apache Forrest xdocs document-v1.3 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-v13.dtd</code>
+    </abstract> 
+  </header> 
+  <body> 
+    <note>
+      This is a demonstration document using all possible elements in the
+      current Apache Forrest xdocs <code>document-v13.dtd</code>
+      (See the <link href="#changes">DTD changes</link> 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
+      <link href="site:dtd-docs">DTD documentation</link>.</p>
+      <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;link href="your-project.html"&gt;</code></dt>

+            <dd>Use this to
+              <link href="your-project.html" title="Example of a document via link">link</link>
+              to another document. As per normal, this will open the new document
+              in the same browser window.</dd> 
+
+            <dt><code>&lt;link href="#section"&gt;</code></dt>

+            <dd>Use this to
+              <link href="#section" title="Example of a document via local anchor">link</link>
+              to the named anchor in the current document.
+            </dd> 
+
+            <dt><code>&lt;link href="your-project.html#images"&gt;</code></dt>

+            <dd>Use this to
+              <link href="your-project.html#images" title="Example of a document via link
and anchor">link</link>
+              to another document and go to the named anchor. This will open
+              the new document in the same browser window.
+            </dd> 
+
+            <dt><code>&lt;jump href="your-project.html"&gt;</code></dt>

+            <dd>Use this to
+              <jump href="your-project.html" title="Example of a document via jump">jump</jump>
+              to another document and optionally go to a named
+              <jump href="your-project.html#images" title="Example of a document via jump
to anchor">anchor</jump>
+              within that document. This will open the new document in the same
+              browser window. So what is the difference between link and jump?
+              The jump behaves differently, in that it will replace any frames
+              in the current window.
+              This is the equivalent of
+              <code>&lt;a ... target="_top"&gt;</code>
+            </dd>
+
+            <dt><code>&lt;fork href="your-project.html"&gt;</code></dt>

+            <dd>Use this to
+              <fork href="your-project.html" title="Example of a document via fork">fork</fork>
+              your webbrowser to another document. This will open the document
+              in a new, unnamed browser window.
+              This is the equivalent of
+              <code>&lt;a ... target="_blank"&gt;</code>
+            </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 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>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</th> 
+            <th>heading cell</th> 
+          </tr> 
+          <tr> 
+            <td>data cell</td> 
+            <td>data cell</td> 
+          </tr> 
+          <tr>
+            <td>
+              Tables can be nested
+            </td>
+            <td>
+              <ul><li>and can include most other elements, like lists</li></ul>
+            </td>
+          </tr>
+        </table> 
+        <p>Not much of attributes with <code>&lt;table&gt;</code>,
if you ask me.</p>
+      </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-logo.png" alt="The fine Forrest logo" width="220"
height="65"/>	
+      </section>
+    </section>
+
+    <section id="changes">
+      <title>DTD changes</title>
+      <p>See the generated
+        <link href="site:dtd-docs">DTD documentation</link>.
+      </p>
+      <section id="changes-13">
+        <title>Changes since <link href="site:document-v12">document-v12</link></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 since <link href="site:document-v11">document-v11</link></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>

Modified: forrest/trunk/src/documentation/content/xdocs/site.xml
==============================================================================
--- forrest/trunk/src/documentation/content/xdocs/site.xml	(original)
+++ forrest/trunk/src/documentation/content/xdocs/site.xml	Wed Aug  4 23:06:14 2004
@@ -85,7 +85,9 @@
       <howto-v13-dtd label="howto-v13" href="howto-v13.dtdx.html"/>
       <faq-v13-dtd label="faq-v13" href="faq-v13.dtdx.html"/>
     </dtd-docs-container>
-    <document-v12 label="document-v12" href="document-v12.html"/>
+    <document-v11 href="document-v11.html"/>
+    <document-v12 href="document-v12.html"/>
+    <document-v13 label="document-v13" href="document-v13.html"/>
     <wiki label="Wiki Reference" href="wiki-sample.html"/>
     <oowriter label="OpenOffice Writer" href="oowriter.html"/>    
  </samples>

Mime
View raw message