You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@forrest.apache.org by st...@apache.org on 2002/05/12 00:36:42 UTC

cvs commit: xml-forrest/src/documentation/content/xdocs document-v11.xml

stevenn     02/05/11 15:36:42

  Added:       src/documentation/skins/forrest-site/images icon.png
               src/documentation/content/xdocs document-v11.xml
  Log:
  added an example document and tweaked document2html.xsl accordingly
  
  Revision  Changes    Path
  1.1                  xml-forrest/src/documentation/skins/forrest-site/images/icon.png
  
  	<<Binary file>>
  
  
  1.1                  xml-forrest/src/documentation/content/xdocs/document-v11.xml
  
  Index: document-v11.xml
  ===================================================================
  <?xml version="1.0"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
  <document> 
    <header> 
      <title>The document-v1.1 DTD</title> 
      <authors><person name="Steven Noels" email="stevenn@apache.org"/> 
      </authors> 
      <notice>This document doesn't make any sense at all.</notice> 
      <abstract>A nonsense document using all possible elements in the current
        <code>document-v11.dtd</code>.</abstract> 
    </header> 
    <body> 
      <p>This is a simple paragraph. Most documents contain a fair amount of
        paragraphs. Paragraphs are called <code>&lt;p&gt;</code>.</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> element.</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&gt;</code></dt> 
            <dd>use this to
              <link href="document-v11.html"
    title="Example of a document-v11 doc">link</link> to another document.</dd> 
    <dt><code>&lt;jump&gt;</code></dt> 
    <dd>use this to
      <jump href="document-v11.html"
      title="Example of a document-v11 doc">jump</jump> to another document.</dd> 
    <dt><code>&lt;fork&gt;</code></dt> 
    <dd>and this one to
      <fork href="document-v11.html"
      title="Example of a document-v11 doc">fork</fork> your webbrowser to another
      document.</dd> 
    </dl></li> 
    <li>Oh, by the way, a definition list was used inside the previous list item.
      We could put another 
      <ul> 
        <li>unordered list</li> 
        <li>inside the list item</li> 
      </ul> too, but I believe this liberty gets quickly quite hairy as you
      see.</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>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> 
    <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 title="Using sections"> 
      <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 title="Sections, the sequel"> 
      <p>Just some second section.</p> 
      <section title="Section 2.1"> 
        <p>Which contains a subsection (2.1).</p> 
      </section> 
    </section> 
    <p>Enough about these section. 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>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> 
    </table> 
    <p>Not much of attributes with <code>&lt;table&gt;</code>, if you ask me.</p>
    
    <p>And a figure to end all of this.</p><figure src="images/project-logo.png"
    alt="The fine Forrest logo" width="220" height="65"/>	
    </body> 
    <footer> 
      <legal>© 2002 Apache Forrest</legal> 
    </footer>
  </document>