The Apache Forrest xdocs document-v2.0 DTD

Sample Content

-Hint: See the xml source to see how the various +Hint: See the xml source to see how the various xxx elements are used and see the - + DTD reference documentation.

Block and inline elements

This is a simple paragraph. Most documents contain a fair amount of paragraphs. Paragraphs are called <p>.

With the <p xml:space="preserve"> attribute, you can declare - that whitespace should be preserved, without implying it is in any other - way special.

- This next paragraph has a class attribute of 'quote'. CSS can - be used to present this <p class='quote'> in + This next paragraph has a class attribute of 'quote'. CSS can + be used to present this <p class='quote'> 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.

- 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, +

+ 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.

A number of in-line elements are available in the DTD, we will show them inside an unordered list (<ul>):

@@ -77,15 +58,15 @@ elements.

We can use - + <icon>s too.

Another possibility is the <img> element: -

, +

, which offers the ability to refer to an image map.

We have elements for hyperlinking:

-<a href="faq.html"> +<a href="faq.html">: Use this to link @@ -93,7 +74,7 @@ in the same browser window.
-<a href="#section"> +<a href="#section">: Use this to link @@ -101,7 +82,7 @@
-<a href="faq.html#forrest"> +<a href="faq.html#forrest">: Use this to link @@ -140,11 +121,11 @@

So far for the in-line elements, let's look at some paragraph-level +

So far for the in-line elements, let's look at some paragraph-level elements.

The <fixme> element is used for stuff which still needs work. Mind the author attribute! - Use the <note> element to draw attention to something, e.g. ...The <code> element is used when the author can't + Use the <note> element to draw attention to something, e.g. ...The <code> element is used when the author can't express himself clearly using normal sentences ;-) Sleep deprivation can be the result of being involved in an open source project. (a.k.a. the <warning> element). @@ -233,7 +214,7 @@

This document as Perl POD (Plain Old Documentation). Text with minimal formatting directives. If on a *nix system with perl - installed, see "man perlpod".

+ installed, see "man perlpod".

For additional information see the Forrest pod-output plugin.

@@ -260,22 +241,22 @@

Showing preformatted source code -

Enough about these sections. Let's have a look at more interesting +

Enough about these sections. Let's have a look at more interesting elements, <source> for instance:

- + // 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); } }

CDATA sections are used within @@ -283,11 +264,11 @@ brackets without needing to escape them with messy < entities ...

- + +<pointy> easy - -]]> +</pointy> +

Please take care to still use a sensible line-length within your source elements.

@@ -332,14 +313,14 @@

- +

Using figures

And a <figure> to end all of this. Note that this can also be implemented with an <img> element.

Using class attribute on links @@ -363,24 +344,24 @@ -

-<a class="fork" - href="faq.html"> +<a class="fork" + href="faq.html"> -

-<a class="jump" - href="faq.html"> +<a class="jump" + href="faq.html">

@@ -391,9 +372,7 @@

DTD changes

See the generated - + DTD reference documentation.

@@ -414,7 +393,7 @@

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.

@@ -447,6 +426,6 @@