forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject cvs commit: xml-forrest/src/documentation/content/xdocs document-v12.xml site.xml
Date Thu, 24 Apr 2003 09:07:42 GMT
jefft       2003/04/24 02:07:42

  Modified:    src/documentation/content/xdocs site.xml
  Added:       src/documentation/content/xdocs document-v12.xml
  Add a doc-v12 sample page, listing changes since v11
  Revision  Changes    Path
  1.10      +1 -0      xml-forrest/src/documentation/content/xdocs/site.xml
  Index: site.xml
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/site.xml,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- site.xml	9 Apr 2003 16:14:53 -0000	1.9
  +++ site.xml	24 Apr 2003 09:07:42 -0000	1.10
  @@ -46,6 +46,7 @@
     <samples label="Some Samples">
       <document-v11 label="document-v11" href="document-v11.html"/>
  +    <document-v12 label="document-v12" href="document-v12.html"/>
       <how-tos label="How-Tos" href="community/howto/index.html"/>
  1.1                  xml-forrest/src/documentation/content/xdocs/document-v12.xml
  Index: document-v12.xml
  <?xml version="1.0"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "document-v12.dtd">
      <title>The document-v1.2 DTD</title> 
      <authors><person name="Jeff Turner" email=""/> 
      <notice>This document doesn't make any sense at all.</notice> 
      <abstract>A nonsense document using all possible elements in the current
        <title>Changes since <link href="site:document-v11">document-v11</link></title>
          doc-v12 enhances doc-v11 by relaxing various restrictions that were
          found to be unnecessary.
            Links (link,jump,fork) and inline elements (br,img,icon,acronym) are
            allowed inside title.
            Paragraphs (p,source,note,warning,fixme), table and figure,anchor are
            allowed inside 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).
              Inline content
              (strong,em,code,sub,sup,br,img,icon,acronym,link,jump,fork) is
              allowed in strong and em.
        <title>Sample Content</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>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>

          <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
          <li>There is a facility to <em>emphasize</em> certain words using
            <code>&lt;em&gt;</code> <strong><code>&lt;strong&gt;</code></strong>
          <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>
            <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: 
              <dt><code>&lt;link href="faq.html"&gt;</code></dt>

              <dd>Use this to
                <link href="faq.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.
              <dt><code>&lt;link href="contrib.html#cvshowto"&gt;</code></dt>

              <dd>Use this to
                <link href="contrib.html#cvshowto" 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.
              <dt><code>&lt;jump href="contrib.html"&gt;</code></dt>

              <dd>Use this to
                <jump href="contrib.html" title="Example of a document via jump">jump</jump>
                to another document and optionally go to a named
                <jump href="contrib.html#cvshowto" 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>
              <dt><code>&lt;fork href="faq.html"&gt;</code></dt>

              <dd>Use this to
                <fork href="faq.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>
          <li>Oh, by the way, a definition list <code>&lt;dl&gt;</code>
was used inside
            the previous list item. We could put another 
              <li>unordered list</li> 
              <li>inside the list item</li> 
              <caption>A sample nested table</caption>
              <tr><td>Or even tables</td><td>inside lists</td></tr>
        <p>So far for the in-line elements, let's look at some paragraph-level
        <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>

        <p>Apart from unordered lists, we have ordered lists too, of course.</p>

          <li>Item 1</li> 
          <li>Item 2</li> 
          <li>This should be 3 if my math is still OK.</li> 
        <anchor 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> 
          <title>Sections, the sequel</title>
          <p>Just some second section.</p> 
            <title>Section 2.1</title>
            <p>Which contains a subsection (2.1).</p> 
        <anchor 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);
          <p>Please take care to still use a sensible line-length within your
            source elements.</p>
        <section id="table">
          <title>Using tables</title>
          <p>And now for a table:</p>
            <caption>Table caption</caption> 
              <th>heading cell</th> 
              <th>heading cell</th> 
              <td>data cell</td> 
              <td>data cell</td> 
                Tables can be nested
                <ul><li>and can include most other elements, like lists</li></ul>
          <p>Not much of attributes with <code>&lt;table&gt;</code>,
if you ask me.</p>
        <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.png" alt="The fine Forrest logo" width="220"
      <legal>© 2002 Apache Forrest</legal> 

View raw message