You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by cr...@apache.org on 2004/09/26 16:25:38 UTC
svn commit: rev 47255 - forrest/trunk/src/documentation/content/xdocs/docs
Author: crossley
Date: Sun Sep 26 07:25:37 2004
New Revision: 47255
Modified:
forrest/trunk/src/documentation/content/xdocs/docs/document-v13.xml
Log:
Sync the demo document in the seed site.
Modified: forrest/trunk/src/documentation/content/xdocs/docs/document-v13.xml
==============================================================================
--- forrest/trunk/src/documentation/content/xdocs/docs/document-v13.xml (original)
+++ forrest/trunk/src/documentation/content/xdocs/docs/document-v13.xml Sun Sep 26 07:25:37 2004
@@ -33,7 +33,9 @@
<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>
+ <link href="site:dtd-docs">DTD reference documentation</link>.</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><p></code>.</p>
<p xml:space="preserve"
@@ -75,9 +77,9 @@
which offers the ability to refer to an image map.</li>
<li>We have elements for hyperlinking:
<dl>
- <dt><code><link href="your-project.html"></code></dt>
+ <dt><code><link href="../faq.html"></code></dt>
<dd>Use this to
- <link href="your-project.html" title="Example of a document via link">link</link>
+ <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>
@@ -87,18 +89,18 @@
to the named anchor in the current document.
</dd>
- <dt><code><link href="your-project.html#images"></code></dt>
+ <dt><code><link href="faq.html#forrest"></code></dt>
<dd>Use this to
- <link href="your-project.html#images" title="Example of a document via link and anchor">link</link>
+ <link href="../faq.html#overview" 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><jump href="your-project.html"></code></dt>
+ <dt><code><jump href="../faq.html"></code></dt>
<dd>Use this to
- <jump href="your-project.html" title="Example of a document via jump">jump</jump>
+ <jump href="../faq.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>
+ <jump href="../faq.html#overview" 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
@@ -107,9 +109,9 @@
<code><a ... target="_top"></code>
</dd>
- <dt><code><fork href="your-project.html"></code></dt>
+ <dt><code><fork href="../faq.html"></code></dt>
<dd>Use this to
- <fork href="your-project.html" title="Example of a document via fork">fork</fork>
+ <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
@@ -150,8 +152,78 @@
<li>Item 1</li>
<li>Item 2</li>
<li>This should be 3 if my math is still OK.</li>
- </ol>
+ </ol>
+ </section>
+
+ <section id="presentations">
+ <title>Various presentation formats</title>
+
+ <p>This sample document, written in document-v13 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
+ <disable-XXX-link> elements in the skinconf.xml</p>
+
+ <table>
+ <tr>
+ <th>Presentation Format</th>
+
+ <th>Description</th>
+
+ <th>skinconf.xml Element</th>
+ </tr>
+
+ <tr>
+ <td><link href="document-v13.html">HTML</link></td>
+
+ <td>This document in HTML format. </td>
+
+ <td>Always generated by default. Cannot be turned off.</td>
+ </tr>
+
+ <tr>
+ <td><link href="document-v13.xml">XML</link></td>
+
+ <td>This document in its raw XML format.</td>
+
+ <td><disable-xml-link>. By default, set to true, meaning
+ that this link will not be shown.</td>
+ </tr>
+
+ <tr>
+ <td><link href="document-v13.pdf">PDF</link></td>
+ <td>This document as Adobe PDF</td>
+
+ <td><disable-pdf-link>. By default, set to false, meaning
+ that this link will be shown.</td>
+ </tr>
+
+ <tr>
+ <td>Text</td>
+
+ <td>This document as straight text.</td>
+
+ <td><disable-txt-link>. By default, set to true, meaning
+ that this link will not be shown. NOT YET IMPLEMENTED.</td>
+ </tr>
+
+ <tr>
+ <td><link href="document-v13.pod">POD</link></td>
+
+ <td>This document as Perl POD (Plain Old Documentation). Text with
+ minimal formatting directives. If on a *nix system with perl
+ installed, see "man perlpod".</td>
+
+ <td><disable-pod-link>. 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
@@ -204,26 +276,38 @@
<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>
+ <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>
- Tables can be nested
+ <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, like lists</li></ul>
+ <ul><li>and can include most other elements</li><li>such as lists</li></ul>
</td>
</tr>
</table>
- <p>Not much of attributes with <code><table></code>, if you ask me.</p>
</section>
<anchor id="second-figure-anchor"/>
@@ -240,7 +324,7 @@
<section id="changes">
<title>DTD changes</title>
<p>See the generated
- <link href="site:dtd-docs">DTD documentation</link>.
+ <link href="site:dtd-docs">DTD reference documentation</link>.
</p>
<section id="changes-13">
<title>Changes since document-v12</title>