You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by th...@apache.org on 2006/03/26 15:01:29 UTC
svn commit: r388905 -
/forrest/trunk/whiteboard/doco/content/authoring/index/xdoc/index_en.xml
Author: thorsten
Date: Sun Mar 26 05:01:29 2006
New Revision: 388905
URL: http://svn.apache.org/viewcvs?rev=388905&view=rev
Log:
Modified documentation with BXE.
Modified:
forrest/trunk/whiteboard/doco/content/authoring/index/xdoc/index_en.xml
Modified: forrest/trunk/whiteboard/doco/content/authoring/index/xdoc/index_en.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/doco/content/authoring/index/xdoc/index_en.xml?rev=388905&r1=388904&r2=388905&view=diff
==============================================================================
--- forrest/trunk/whiteboard/doco/content/authoring/index/xdoc/index_en.xml (original)
+++ forrest/trunk/whiteboard/doco/content/authoring/index/xdoc/index_en.xml Sun Mar 26 05:01:29 2006
@@ -1,30 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!--
- Copyright 2002-2005 The Apache Software Foundation or its licensors,
- as applicable.
-
- 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 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>
+ <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>text xxx</note>
<note>
This is a demonstration document using all possible elements in the
current Apache Forrest xdocs <code>document-v20.dtd</code>
@@ -33,34 +19,29 @@
<section id="sample">
<title>Sample Content</title>
<p>
-<strong>Hint:</strong> See the xml source to see how the various
+<strong>Hint:</strong> See the xml source to see how the various xxx
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><p></code>.</p>
- <p xml:space="preserve">With the <code><p xml:space="preserve"></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><p class='quote'></code> in
+ This next paragraph has a class attribute of 'quote'. CSS can
+ be used to present this <code><p class='quote'></code> in
a different style than the other paragraphs. The handling of
this quoted paragraph is defined in the <extra-css>
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,
+ <p>
+ 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,
+ 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.
+ 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><ul></code>):</p>
@@ -77,15 +58,15 @@
</strong>
elements.</li>
<li>We can use
- <icon alt="feather" height="22" src="../images/icon.png" width="26"/>
+ <icon alt="feather" height="22" src="../images/icon.png" width="26" />
<code><icon></code>s too.</li>
<li>Another possibility is the <code><img></code> element:
- <img alt="another feather" height="22" src="../images/icon.png" width="26"/>,
+ <img alt="another feather" height="22" src="../images/icon.png" width="26" />,
which offers the ability to refer to an image map.</li>
<li>We have elements for hyperlinking:
<dl>
<dt>
-<code><a href="faq.html"></code>
+<code><a href="faq.html"></code>
</dt>
<dd>Use this to
<a href="faq.html" title="Example of a document via link">link</a>
@@ -93,7 +74,7 @@
in the same browser window.</dd>
<dt>
-<code><a href="#section"></code>
+<code><a href="#section"></code>
</dt>
<dd>Use this to
<a href="#section" title="Example of a document via local anchor">link</a>
@@ -101,7 +82,7 @@
</dd>
<dt>
-<code><a href="faq.html#forrest"></code>
+<code><a href="faq.html#forrest"></code>
</dt>
<dd>Use this to
<a href="faq.html#forrest" title="Example of a document via link and anchor">link</a>
@@ -140,11 +121,11 @@
</table>
</li>
</ul>
- <p>So far for the in-line elements, let's look at some paragraph-level
+ <p>So far for the in-line elements, let's look at some paragraph-level
elements.</p>
<fixme author="SN">The <code><fixme></code> element is used for stuff
which still needs work. Mind the <code>author</code> attribute!</fixme>
- <note>Use the <code><note></code> element to draw attention to something, e.g. ...The <code><code></code> element is used when the author can't
+ <note>Use the <code><note></code> element to draw attention to something, e.g. ...The <code><code></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><warning></code> element).
@@ -233,7 +214,7 @@
<td colspan="1" rowspan="1">
<p>This document as Perl POD (Plain Old Documentation). Text
with minimal formatting directives. If on a *nix system with perl
- installed, see "man perlpod".</p>
+ installed, see "man perlpod".</p>
<p>For additional information see the Forrest pod-output
plugin.</p>
</td>
@@ -260,22 +241,22 @@
<section id="source">
<title>Showing preformatted source code</title>
- <p>Enough about these sections. Let's have a look at more interesting
+ <p>Enough about these sections. Let's have a look at more interesting
elements, <code><source></code> for instance:</p>
- <source xml:space="preserve">
+ <source>
// This example is from the book _Java in a Nutshell_ by David Flanagan.
-// Written by David Flanagan. Copyright (c) 1996 O'Reilly & Associates.
+// Written by David Flanagan. Copyright (c) 1996 O'Reilly & 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.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);
+ g.drawString("Hello World", 25, 50);
}
}</source>
<p>CDATA sections are used within
@@ -283,11 +264,11 @@
brackets without needing to escape them with messy
<code>&lt;</code> entities ...
</p>
- <source xml:space="preserve"><![CDATA[
-<pointy>
+ <source>
+<pointy>
easy
-</pointy>
-]]></source>
+</pointy>
+</source>
<p>Please take care to still use a sensible line-length within your
source elements.</p>
</section>
@@ -332,14 +313,14 @@
</table>
</section>
- <anchor id="second-figure-anchor"/>
+ <anchor id="second-figure-anchor" />
<section id="figure">
<title>Using figures</title>
<p>And a <code><figure></code> to end all of this.
Note that this can also be implemented with an
<code><img></code> element.
</p>
- <figure alt="The fine Forrest logo" height="65" src="../images/project.png" width="220"/>
+ <figure alt="The fine Forrest logo" height="65" src="../images/project.png" width="220" />
</section>
<section id="link-class">
<title>Using class attribute on links</title>
@@ -363,24 +344,24 @@
<tr>
<td colspan="1" rowspan="1">
-<p><fork href="faq.html"></p>
+<p><fork href="faq.html"></p>
</td>
<td colspan="1" rowspan="1">
-<a class="fork" href="faq.html"><a class="fork"
- href="faq.html"></a>
+<a href="faq.html"><a class="fork"
+ href="faq.html"></a>
</td>
</tr>
<tr>
<td colspan="1" rowspan="1">
-<p><jump href="faq.html"></p>
+<p><jump href="faq.html"></p>
</td>
<td colspan="1" rowspan="1">
<p>
-<a class="jump" href="faq.html"><a class="jump"
- href="faq.html"></a>
+<a href="faq.html"><a class="jump"
+ href="faq.html"></a>
</p>
</td>
</tr>
@@ -391,9 +372,7 @@
<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">
@@ -414,7 +393,7 @@
<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.
+ "extra-css" section in the skinconf to be put to good use.
</p>
</section>
<section id="changes-12">
@@ -447,6 +426,6 @@
</section>
</body>
<footer>
- <legal>This is a legal notice, so it is <strong>important</strong>.</legal>
+ <!--<legal>This is a legal notice, so it is.</legal>-->
</footer>
</document>