Return-Path: Delivered-To: apmail-forrest-site-svn-archive@minotaur.apache.org Received: (qmail 35919 invoked from network); 20 Jan 2011 06:48:36 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.3) by minotaur.apache.org with SMTP; 20 Jan 2011 06:48:36 -0000 Received: (qmail 18175 invoked by uid 500); 20 Jan 2011 06:48:36 -0000 Delivered-To: apmail-forrest-site-svn-archive@forrest.apache.org Received: (qmail 18136 invoked by uid 500); 20 Jan 2011 06:48:35 -0000 Mailing-List: contact site-svn-help@forrest.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@forrest.apache.org Delivered-To: mailing list site-svn@forrest.apache.org Received: (qmail 18129 invoked by uid 99); 20 Jan 2011 06:48:35 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 20 Jan 2011 06:48:35 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 20 Jan 2011 06:48:30 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 83C5E2388C0F; Thu, 20 Jan 2011 06:47:31 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1061134 [7/10] - in /forrest/site: ./ docs_0_70/ docs_0_70/howto/ docs_0_70/howto/cvs-ssh/ docs_0_70/howto/multi/ docs_0_80/ docs_0_80/howto/ docs_0_80/howto/cvs-ssh/ docs_0_80/howto/multi/ docs_0_90/ docs_0_90/howto/ docs_0_90/howto/cvs-s... Date: Thu, 20 Jan 2011 06:47:28 -0000 To: site-svn@forrest.apache.org From: crossley@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20110120064757.83C5E2388C0F@eris.apache.org> Modified: forrest/site/docs_0_90/linking.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/linking.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/docs_0_90/linking.html (original) +++ forrest/site/docs_0_90/linking.html Thu Jan 20 06:47:23 2011 @@ -391,7 +391,7 @@ document.write("Last Published: " + docu - +

Introduction

@@ -410,7 +410,7 @@ document.write("Last Published: " + docu

- +

site.xml

@@ -555,7 +555,7 @@ document.write("Last Published: " + docu

- +

Generating Menus

@@ -598,7 +598,7 @@ document.write("Last Published: " + docu community/howto/index.html

- +

Tabs for External Resources

A tab can refer to an external resource by using the @@ -617,7 +617,7 @@ document.write("Last Published: " + docu root-relative and obviously specifies a directory (ends in '/'). In which case /index.html will be added.

- +

Selecting menu entries

Forrest decides which menu entries to display, by examining the @@ -676,14 +676,14 @@ document.write("Last Published: " + docu "home". Forrest will select all nodes with tab="home" and put them in the menu.

- +

Alternative menu selection mechanisms.

The "tab" attribute-based scheme for selecting a menu's entries is not the only one, although it is the most flexible. Here we describe a few alternatives.

- +

Directory-based selection

In this scheme, each tab corresponds to a directory within the site. @@ -710,7 +710,7 @@ document.write("Last Published: " + docu entries. - +

Specifying menus with book.xml

Historically, menus in Forrest have been generated from a @@ -722,7 +722,7 @@ document.write("Last Published: " + docu files. In general, however, we recommend that users avoid book.xml files.

- +

Selecting the current tab

The tab selection algorithm is quite simple: the tab with the @@ -730,7 +730,7 @@ document.write("Last Published: " + docu "selected". However the interaction of tabs.xml and site.xml while powerful, can be complex to establish.

- +

Configuring the interaction between tabs.xml and site.xml

This is a collection of tips to assist with getting your menus and @@ -800,7 +800,7 @@ document.write("Last Published: " + docu

- +

Table of Contents Generation

@@ -848,10 +848,10 @@ document.write("Last Published: " + docu

- +

Linking systems

- +

Direct linking

In earlier versions of Forrest (and in similar systems), there has @@ -870,7 +870,7 @@ document.write("Last Published: " + docu typically renders to multiple output formats (HTML and PDF), links in one of them (here, the PDF) are likely to break.

- +

Indirect linking

Forrest's solution is simple: instead of <a href="todo.html">, @@ -898,7 +898,7 @@ document.write("Last Published: " + docu "idea" of "the todo file". It doesn't matter where it physically lives; that will be sorted out by Forrest.

- +

Resolving site: URIs

So how does "site:todo" get resolved? A full answer is @@ -934,7 +934,7 @@ document.write("Last Published: " + docu make "new_content_type" its own XML file, or a node in another file, in another category.

- +

ext: URIs: linking to external URLs

The "ext:" scheme was created partly to demonstrate the @@ -973,7 +973,7 @@ document.write("Last Published: " + docu Specifically, the "@href" aggregation makes defining large numbers of related URLs easy.

- +

Theory: source URIs

The "site:" URIs like "site:todo" are @@ -990,7 +990,7 @@ document.write("Last Published: " + docu just like exotic XML source formats are translated into plain old HTML in the output.

- +

Future schemes

So far, the "site:" and "ext:" schemes are @@ -1071,7 +1071,7 @@ document.write("Last Published: " + docu

- +

Concept

@@ -1086,7 +1086,7 @@ document.write("Last Published: " + docu

- +

Implementation

Modified: forrest/site/docs_0_90/locationmap.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/locationmap.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/docs_0_90/locationmap.html (original) +++ forrest/site/docs_0_90/locationmap.html Thu Jan 20 06:47:23 2011 @@ -358,7 +358,7 @@ document.write("Last Published: " + docu

- +

About Locationmaps

@@ -419,7 +419,7 @@ document.write("Last Published: " + docu

- +

Naming Convention

@@ -492,7 +492,7 @@ projectInfo.transform.changes.rss

- +

Explanation of Locationmap processing

@@ -557,7 +557,7 @@ projectInfo.transform.changes.rss

- +

Multiple Location Selectors

@@ -580,10 +580,10 @@ projectInfo.transform.changes.rss

- +

Other Locationmap examples

- +

Retrieving an XDoc via HTTP

Normally files are generated from @@ -620,7 +620,7 @@ projectInfo.transform.changes.rss generated from the above example are broken.

- +

Retrieving HTML from a CMS

Using the locationmap you can use Forrest to retrieve data from a @@ -715,7 +715,7 @@ char-encoding=latin1 ensure that they are matched by the locationmap. - +

Enhanced PDF-output plugin

In order to change PDF rendered output, e.g. for your own skin it is necessary to enhance/change the @@ -775,7 +775,7 @@ char-encoding=latin1 src="{forrest:forrest.plugins}/org.apache.forrest.plugin.output.pdf/resources/stylesheets/{1}-to-{2}.xsl"/> </match> - +

Source Resolving

As well as being able to use the locationmap as a parameter in the @@ -788,7 +788,7 @@ char-encoding=latin1 <xsl:import src="lm://OOo.transform.write.xdoc"/> - +

Link Rewriting

The locationmap can be used to rewrite URLs when the page is @@ -805,7 +805,7 @@ char-encoding=latin1 off-site address at domain.org

- +

Debugging Locationmaps

Debugging the locationmap can be difficult because Cocoons error Modified: forrest/site/docs_0_90/primer.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/primer.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/docs_0_90/primer.html (original) +++ forrest/site/docs_0_90/primer.html Thu Jan 20 06:47:23 2011 @@ -385,7 +385,7 @@ document.write("Last Published: " + docu - +

History

@@ -417,7 +417,7 @@ document.write("Last Published: " + docu

- +

What is Forrest

@@ -494,7 +494,7 @@ document.write("Last Published: " + docu

- +

Forrest roles

@@ -560,10 +560,10 @@ document.write("Last Published: " + docu

- +

Getting your local copy of Forrest through CVS

- +

System requirements

Forrest requires the following systems to be already installed on your @@ -576,7 +576,7 @@ document.write("Last Published: " + docu present. Forrest has been tested against the latest Sun 1.3 JDK. - +

Getting Forrest

You can retrieve Forrest from its CVS repository or download @@ -585,7 +585,7 @@ document.write("Last Published: " + docu Some help with CVS follows (courtesy of our friends of the Cocoon project).

- +

Step-by-step cvs instructions for Windows

    @@ -629,7 +629,7 @@ document.write("Last Published: " + docu
  1. The Forrest source is now on your harddrive.
- +

Step-by-step cvs instructions for Unix

    @@ -660,7 +660,7 @@ document.write("Last Published: " + docu

- +

Forrest distribution

@@ -757,7 +757,7 @@ document.write("Last Published: " + docu

- +

The Forrest DTDs

@@ -820,7 +820,7 @@ document.write("Last Published: " + docu

- +

Forrest site generation using Cocoon

@@ -951,7 +951,7 @@ document.write("Last Published: " + docu

- +

Where we are heading to

@@ -1077,7 +1077,7 @@ document.write("Last Published: " + docu

- +

Where you can help

Modified: forrest/site/docs_0_90/project-sitemap.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/project-sitemap.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/docs_0_90/project-sitemap.html (original) +++ forrest/site/docs_0_90/project-sitemap.html Thu Jan 20 06:47:23 2011 @@ -337,7 +337,7 @@ document.write("Last Published: " + docu

- +

Introduction

@@ -360,7 +360,7 @@ document.write("Last Published: " + docu

- +

How does it work?

@@ -387,10 +387,10 @@ document.write("Last Published: " + docu

- +

Example uses of this technique

- +

Adding a new content type

See the section "Advanced customizations: sitemap.xmap" in the Modified: forrest/site/docs_0_90/properties.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/properties.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/docs_0_90/properties.html (original) +++ forrest/site/docs_0_90/properties.html Thu Jan 20 06:47:23 2011 @@ -329,7 +329,7 @@ document.write("Last Published: " + docu

- +

Properties

@@ -372,7 +372,7 @@ document.write("Last Published: " + docu

- +

ModuleGenerator

Modified: forrest/site/docs_0_90/searching.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/searching.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/docs_0_90/searching.html (original) +++ forrest/site/docs_0_90/searching.html Thu Jan 20 06:47:23 2011 @@ -352,7 +352,7 @@ document.write("Last Published: " + docu choose.

- +

Google SiteSearch

@@ -394,7 +394,7 @@ document.write("Last Published: " + docu

- +

Lucene search

@@ -453,7 +453,7 @@ document.write("Last Published: " + docu

- +

Disabling full-text search

Modified: forrest/site/docs_0_90/sitemap-ref.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/sitemap-ref.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/docs_0_90/sitemap-ref.html (original) +++ forrest/site/docs_0_90/sitemap-ref.html Thu Jan 20 06:47:23 2011 @@ -437,7 +437,7 @@ document.write("Last Published: " + docu

- +

Getting started

@@ -464,7 +464,7 @@ document.write("Last Published: " + docu

- +

Sitemap Overview

@@ -614,7 +614,7 @@ document.write("Last Published: " + docu --> - +

Source pipelines (**.xml)

@@ -653,7 +653,7 @@ FORMATS doc-v11 doc-v13 doc-v20 ... (*.xml) (in forrest.xmap, faq.xmap, etc) - +

forrest.xmap

Most of the usual Source pipelines are defined in @@ -681,7 +681,7 @@ FORMATS doc-v11 doc-v13 doc-v20 ... </map:when> - +

Other source pipelines

As mentioned above, all non-core Source pipelines are distributed in @@ -714,7 +714,7 @@ FORMATS doc-v11 doc-v13 doc-v20 ... </map:match> .... .... - +

Late-binding pipelines

One point of interest here is that the sub-sitemap is often not @@ -743,7 +743,7 @@ FORMATS doc-v11 doc-v13 doc-v20 ...

- +

Output pipelines

@@ -755,7 +755,7 @@ FORMATS doc-v11 doc-v13 doc-v20 ... We now wish to render the XML from these pipelines to output formats like HTML and PDF.

- +

PDF output

Note
@@ -866,7 +866,7 @@ FORMATS doc-v11 doc-v13 doc-v20 ... described above, i18n elements are processed for the current locale, and the result is serialized as PDF.

- +

HTML output

Generating HTML pages is more complicated, because we have to merge @@ -938,10 +938,10 @@ FORMATS doc-v11 doc-v13 doc-v20 ...

- +

Intermediate pipelines

- +

Page body

Here is the matcher which generates the page body: @@ -1016,7 +1016,7 @@ FORMATS doc-v11 doc-v13 doc-v20 ... <html> and <body>) suitable for merging with the menu and tabs. - +

Page menu

In the sitemap.xmap file, the matcher generating HTML for @@ -1046,7 +1046,7 @@ FORMATS doc-v11 doc-v13 doc-v20 ... sufficiently complex to require a section of its own.

- +

Page tabs

           
@@ -1092,7 +1092,7 @@ FORMATS    doc-v11  doc-v13  doc-v20 ...
         

- +

Resolving Resources

@@ -1105,7 +1105,7 @@ FORMATS doc-v11 doc-v13 doc-v20 ...

- +

Menu XML generation

@@ -1216,7 +1216,7 @@ FORMATS doc-v11 doc-v13 doc-v20 ...

- +

Link rewriting

@@ -1231,7 +1231,7 @@ FORMATS doc-v11 doc-v13 doc-v20 ... is provided in Menus and Linking. Here we describe the implementation of linking.

- +

Cocoon foundations: Input Modules

The implementation of site: linking is heavily based on @@ -1262,13 +1262,13 @@ FORMATS doc-v11 doc-v13 doc-v20 ... currently distributed as a "block" in Cocoon 2.1 (see API docs).

- +

Implementing "site:" rewriting

Using the above components, "site:" URI rewriting is accomplished as follows.

- +

cocoon.xconf

First, we declare all the input modules we will be needing: @@ -1316,7 +1316,7 @@ FORMATS doc-v11 doc-v13 doc-v20 ... will be configured in sitemap.xmap as described in the next section.

- +

sitemap.xmap

Now in the sitemap, we define the LinkRewriterTransformer, and @@ -1430,7 +1430,7 @@ FORMATS doc-v11 doc-v13 doc-v20 ... cocoon:/community/linkmap-index.html

- +

Dynamically generating a linkmap

Why do we need this "linkmap" pipeline generating dynamic XML from Modified: forrest/site/docs_0_90/skin-package.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/skin-package.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/docs_0_90/skin-package.html (original) +++ forrest/site/docs_0_90/skin-package.html Thu Jan 20 06:47:23 2011 @@ -330,7 +330,7 @@ document.write("Last Published: " + docu

- +

Overview

@@ -363,7 +363,7 @@ The skin package will be made in the ski

forrest available-skins
- +

Notes

Modified: forrest/site/docs_0_90/skins.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/skins.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/docs_0_90/skins.html (original) +++ forrest/site/docs_0_90/skins.html Thu Jan 20 06:47:23 2011 @@ -354,7 +354,7 @@ document.write("Last Published: " + docu

- +

Introduction

@@ -368,7 +368,7 @@ document.write("Last Published: " + docu

- +

Convention for choosing skin names

@@ -381,10 +381,10 @@ document.write("Last Published: " + docu

- +

Skin descriptions and examples

- +

pelt

Uses CSS "div" and no HTML tables. @@ -394,7 +394,7 @@ document.write("Last Published: " + docu Apache Lenya

- +

tigris

This skin is based on version 1.1 of the @@ -406,7 +406,7 @@ document.write("Last Published: " + docu Group

- +

plain-dev

This is a very minimal skin to produce plain HTML documents. Such @@ -419,14 +419,14 @@ document.write("Last Published: " + docu

- +

Old and deprecated skins

The following skins are retained for a little while longer, but are deprecated, so please move to one of the other skins.

- +

forrest-site

This is the old skin that we have been dragging around since early @@ -436,7 +436,7 @@ document.write("Last Published: " + docu Examples: Apache XML

- +

krysalis-site

Uses HTML tables. Modified: forrest/site/docs_0_90/status-themes.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/status-themes.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/docs_0_90/status-themes.html (original) +++ forrest/site/docs_0_90/status-themes.html Thu Jan 20 06:47:23 2011 @@ -332,7 +332,7 @@ document.write("Last Published: " + docu

- +

Skins

@@ -351,7 +351,7 @@ document.write("Last Published: " + docu

- +

Dispatcher

@@ -367,7 +367,7 @@ document.write("Last Published: " + docu

- +

Plan for future framework

Modified: forrest/site/docs_0_90/upgrading_09.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/upgrading_09.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/docs_0_90/upgrading_09.html (original) +++ forrest/site/docs_0_90/upgrading_09.html Thu Jan 20 06:47:23 2011 @@ -358,7 +358,7 @@ document.write("Last Published: " + docu

- +

Introduction

@@ -385,7 +385,7 @@ document.write("Last Published: " + docu

- +

New Features

@@ -416,7 +416,7 @@ document.write("Last Published: " + docu

- +

Java 1.5 (or newer) is required

@@ -426,7 +426,7 @@ document.write("Last Published: " + docu

- +

Notes about Cocoon version

@@ -463,7 +463,7 @@ document.write("Last Published: " + docu see the notes in the $FORREST_HOME/etc/cocoon_upgrade directory.

- +

Cocoon upgrade issues

There are only two minor issues for those upgrading from the previous @@ -490,7 +490,7 @@ document.write("Last Published: " + docu

- +

Missing project symbols file in some projects

Users of 0.8, and developers with older 0.9-dev, who based their sites on 'forrest seed-basic' rather than 'forrest seed-sample' will be affected by FOR-1075. There was a partially implemented xml catalog with missing symbols file. @@ -517,7 +517,7 @@ document.write("Last Published: " + docu

- +

Improved PDF output plugin

@@ -548,7 +548,7 @@ document.write("Last Published: " + docu

- +

Notes about documentation

@@ -564,7 +564,7 @@ document.write("Last Published: " + docu

- +

General upgrade tips

@@ -580,7 +580,7 @@ document.write("Last Published: " + docu

- +

Remove project sitemap if not necessary

@@ -595,7 +595,7 @@ document.write("Last Published: " + docu

- +

To be continued...

Modified: forrest/site/docs_0_90/validation.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/validation.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/docs_0_90/validation.html (original) +++ forrest/site/docs_0_90/validation.html Thu Jan 20 06:47:23 2011 @@ -356,7 +356,7 @@ document.write("Last Published: " + docu

- +

Introduction

@@ -385,7 +385,7 @@ document.write("Last Published: " + docu

- +

XML validation

@@ -449,7 +449,7 @@ document.write("Last Published: " + docu

- +

Validating new XML types

@@ -464,7 +464,7 @@ document.write("Last Published: " + docu ${project.schema-dir}/catalog.xcat file. This section describes the details of this process.

- +

Creating or extending a DTD

The main Forrest DTDs are designed to be modular and extensible, so it @@ -591,7 +591,7 @@ size CDATA #IMPLIED> customizing a DTD.

- +

Associating DTDs with document types

Recall that our DOCTYPE declaration for our download document type is: @@ -674,7 +674,7 @@ size CDATA #IMPLIED>

- +

Debugging the Catalog Entity Resolver

@@ -703,7 +703,7 @@ size CDATA #IMPLIED>

- +

Referring to entities

@@ -725,7 +725,7 @@ size CDATA #IMPLIED>

- +

Validating in an XML editor

@@ -737,7 +737,7 @@ size CDATA #IMPLIED>

- +

Validation using RELAX NG

@@ -755,7 +755,7 @@ size CDATA #IMPLIED>

- +

Validation using Cocoon sitemap and the Cocoon Validation block

Modified: forrest/site/docs_0_90/your-project.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/your-project.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/docs_0_90/your-project.html (original) +++ forrest/site/docs_0_90/your-project.html Thu Jan 20 06:47:23 2011 @@ -429,7 +429,7 @@ document.write("Last Published: " + docu

- +

Introduction

@@ -439,7 +439,7 @@ document.write("Last Published: " + docu

- +

Installing Forrest

@@ -449,7 +449,7 @@ document.write("Last Published: " + docu try the development version, then build Forrest from source.

- +

Setting up the Environment

After downloading and extracting Forrest, you need to add environment @@ -460,7 +460,7 @@ document.write("Last Published: " + docu message explains further and provides other tips about using Windows.

- +

In Unix/Linux:

change directory to the top-level of the forrest distribution and do @@ -472,7 +472,7 @@ document.write("Last Published: " + docu

~/apache-forrest$ export PATH=$PATH:$FORREST_HOME/bin

- +
Permanently Setting The Environment Variables for Linux/Unix

Export only changes the variables during that terminal session for @@ -488,7 +488,7 @@ document.write("Last Published: " + docu PATH=$PATH:$FORREST_HOME/bin export PATH - +

The Debian update-alternatives system

If your system uses the alternatives system to manage application binaries and their locations, you may use that to link Forrest into your system's binary directory, instead of explicitly exporting environment variables. To check if your system has the alternatives system installed, execute this command:

@@ -507,7 +507,7 @@ document.write("Last Published: " + docu

update-alternatives --help or man update-alternatives

- +

Windows 2000

Go to "My Computer", "Properties", "Advanced", "Environment @@ -522,7 +522,7 @@ document.write("Last Published: " + docu edit PATH as %PATH%;%FORREST_HOME%\bin

- +

In Windows XP:

Go to "My Computer", "Properties", "Advanced", "Environment @@ -536,7 +536,7 @@ document.write("Last Published: " + docu Edit PATH by adding ;%FORREST_HOME%\bin to the end of the current value.

- +

ForrestBar

Install the @@ -546,7 +546,7 @@ document.write("Last Published: " + docu

- +

The 'forrest' command

@@ -606,7 +606,7 @@ document.write("Last Published: " + docu

- +

Seeding a new project

@@ -777,7 +777,7 @@ Total time: 5 seconds

- +

Seeding an existing project

@@ -797,7 +797,7 @@ Total time: 5 seconds

- +

Customizing your project

@@ -805,7 +805,7 @@ Total time: 5 seconds customize it to your project's needs. Here we will deal with configuring the skin, and changing the project layout.

- +

Configuring the Forrest skin: skinconf.xml

Most Forrest skins can be customized through a single XML file, @@ -986,7 +986,7 @@ which will be used to configure the chos Having edited this file (and ensured it is valid XML), re-run the 'forrest' command in the site root, and the site would be updated.

- +

Changing the layout: forrest.properties

Forrest allows you to place files anywhere you want in your project, @@ -1066,7 +1066,7 @@ project.skinconf=${project.content-dir}/

- +

Adding content

@@ -1074,7 +1074,7 @@ project.skinconf=${project.content-dir}/ src/documentation/content/xdocs

- +

site.xml

When adding a new xml document, you would add an entry to the @@ -1084,7 +1084,7 @@ project.skinconf=${project.content-dir}/ about site.xml is provided in the document Menus and Linking.

- +

tabs.xml

The tabs.xml file is used to produce the 'tabs'. which @@ -1116,7 +1116,7 @@ project.skinconf=${project.content-dir}/ </tab> - +

Images

Images usually go in the resources/images/ directory. The @@ -1127,7 +1127,7 @@ project.skinconf=${project.content-dir}/

- +

Advanced customizations: sitemap.xmap

@@ -1198,7 +1198,7 @@ project.skinconf=${project.content-dir}/ for a tour of the default sitemap.

- +

Example: Adding a new content type

There are two methods for detecting types of documents and doing @@ -1356,7 +1356,7 @@ project.skinconf=${project.content-dir}/ will handle the aggregation with navigation menus etc. and will apply the normal skin.

- +

Registering a new DTD

By default, Forrest requires that all XML files be valid, i.e. they @@ -1387,7 +1387,7 @@ project.skinconf=${project.content-dir}/ the complete description for those steps. - +

Example: Adding a new content type (advanced)

The simple user sitemap in the previous example is fine for simple @@ -1470,7 +1470,7 @@ project.skinconf=${project.content-dir}/ used, because the project sitemap is the first sitemap to be consulted.

- +

Example: integrating external RSS content

Similar to the previous example, we can integrate RSS into our site @@ -1507,7 +1507,7 @@ project.skinconf=${project.content-dir}/

- +

Forrest skins

@@ -1530,7 +1530,7 @@ project.skinconf=${project.content-dir}/ are not needed.

- +

Configuration of skins

All configuration is done via your project @@ -1538,7 +1538,7 @@ project.skinconf=${project.content-dir}/ comments to describe each capability. Please read those, there is no point repeating here.

- +

Defining a new skin

Consider discussing your needs on the mailing lists. There may be @@ -1631,7 +1631,7 @@ project.skinconf=${project.content-dir}/ - +

Interactive Forrest: faster turnaround when developing your docs

@@ -1644,7 +1644,7 @@ project.skinconf=${project.content-dir}/ using a "live" Forrest webapp instance, the Forrest-based documentation development can be faster and easier than with comparable tools.

- +

Running as a webapp

Type 'forrest run' in your project root to start @@ -1659,7 +1659,7 @@ project.skinconf=${project.content-dir}/ servlet container, type forrest webapp to build an open webapp in build/webapp/)

- +

Using the webapp

You can now edit the XML content in @@ -1668,7 +1668,7 @@ project.skinconf=${project.content-dir}/

- +

Invoking Forrest from Ant

Modified: forrest/site/documentation_bestpractices.html URL: http://svn.apache.org/viewvc/forrest/site/documentation_bestpractices.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/documentation_bestpractices.html (original) +++ forrest/site/documentation_bestpractices.html Thu Jan 20 06:47:23 2011 @@ -243,7 +243,7 @@ document.write("Last Published: " + docu

- +

Golden Rules

Modified: forrest/site/dtdx/document-v12.html URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v12.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/dtdx/document-v12.html (original) +++ forrest/site/dtdx/document-v12.html Thu Jan 20 06:47:23 2011 @@ -358,7 +358,7 @@ document.write("Last Published: " + docu

- +

Changes since document-v11

@@ -392,7 +392,7 @@ document.write("Last Published: " + docu

- +

Sample Content

@@ -568,24 +568,24 @@ document.write("Last Published: " + docu

  • This should be 3 if my math is still OK.
  • - +

    Using sections

    You can use sections to put some structure in your document. For some strange historical reason, the section title is an attribute of the <section> element.

    - +

    Sections, the sequel

    Just some second section.

    - +

    Section 2.1

    Which contains a subsection (2.1).

    - +

    Showing preformatted source code

    Enough about these sections. Let's have a look at more interesting @@ -610,7 +610,7 @@ document.write("Last Published: " + docu Please take care to still use a sensible line-length within your source elements.

    - +

    Using tables

    And now for a table: @@ -654,7 +654,7 @@ document.write("Last Published: " + docu

    Not much of attributes with <table>, if you ask me.

    - +

    Using figures

    And a <figure> to end all of this. Note that this Modified: forrest/site/dtdx/document-v13.dtdx.html URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v13.dtdx.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/dtdx/document-v13.dtdx.html (original) +++ forrest/site/dtdx/document-v13.dtdx.html Thu Jan 20 06:47:23 2011 @@ -456,7 +456,7 @@ document.write("Last Published: " + docu

    - +

    Top-level element(s)

      @@ -465,10 +465,10 @@ document.write("Last Published: " + docu
    - +

    Element declarations

    - +

    abstract

    @@ -517,7 +517,7 @@ document.write("Last Published: " + docu
     
    - +

    acronym

    @@ -572,7 +572,7 @@ document.write("Last Published: " + docu
     
    - +

    anchor

    @@ -622,7 +622,7 @@ document.write("Last Published: " + docu
     
    - +

    authors

    @@ -669,7 +669,7 @@ document.write("Last Published: " + docu
     
    - +

    body

    @@ -716,7 +716,7 @@ document.write("Last Published: " + docu
     
    - +

    br

    @@ -765,7 +765,7 @@ document.write("Last Published: " + docu
     
    - +

    caption

    @@ -814,7 +814,7 @@ document.write("Last Published: " + docu
     
    - +

    code

    @@ -863,7 +863,7 @@ document.write("Last Published: " + docu
     
    - +

    dd

    @@ -912,7 +912,7 @@ document.write("Last Published: " + docu
     
    - +

    dl

    @@ -959,7 +959,7 @@ document.write("Last Published: " + docu
     
    - +

    document

    @@ -995,7 +995,7 @@ document.write("Last Published: " + docu
    - +

    dt

    @@ -1044,7 +1044,7 @@ document.write("Last Published: " + docu
     
    - +

    em

    @@ -1093,7 +1093,7 @@ document.write("Last Published: " + docu
     
    - +

    figure

    @@ -1179,7 +1179,7 @@ document.write("Last Published: " + docu
     
    - +

    fixme

    @@ -1234,7 +1234,7 @@ document.write("Last Published: " + docu
     
    - +

    footer

    @@ -1255,7 +1255,7 @@ document.write("Last Published: " + docu
     
    - +

    fork

    @@ -1325,7 +1325,7 @@ document.write("Last Published: " + docu
     
    - +

    header

    @@ -1372,7 +1372,7 @@ document.write("Last Published: " + docu
     
    - +

    icon

    @@ -1443,7 +1443,7 @@ document.write("Last Published: " + docu
     
    - +

    img

    @@ -1524,7 +1524,7 @@ document.write("Last Published: " + docu
     
    - +

    jump

    @@ -1594,7 +1594,7 @@ document.write("Last Published: " + docu
     
    - +

    legal

    @@ -1643,7 +1643,7 @@ document.write("Last Published: " + docu
     
    - +

    li

    @@ -1692,7 +1692,7 @@ document.write("Last Published: " + docu
     
    - +

    link

    @@ -1762,7 +1762,7 @@ document.write("Last Published: " + docu
     
    - +

    note

    @@ -1816,7 +1816,7 @@ document.write("Last Published: " + docu
     
    - +

    notice

    @@ -1865,7 +1865,7 @@ document.write("Last Published: " + docu
     
    - +

    ol

    @@ -1917,7 +1917,7 @@ document.write("Last Published: " + docu
     
    - +

    p

    @@ -1971,7 +1971,7 @@ document.write("Last Published: " + docu
     
    - +

    person

    @@ -2032,7 +2032,7 @@ document.write("Last Published: " + docu
     
    - +

    section

    @@ -2079,7 +2079,7 @@ document.write("Last Published: " + docu
     
    - +

    source

    @@ -2135,7 +2135,7 @@ document.write("Last Published: " + docu
     
    - +

    strong

    @@ -2184,7 +2184,7 @@ document.write("Last Published: " + docu
     
    - +

    sub

    @@ -2233,7 +2233,7 @@ document.write("Last Published: " + docu
     
    - +

    subtitle

    @@ -2282,7 +2282,7 @@ document.write("Last Published: " + docu
     
    - +

    sup

    @@ -2331,7 +2331,7 @@ document.write("Last Published: " + docu
     
    - +

    table

    @@ -2378,7 +2378,7 @@ document.write("Last Published: " + docu
     
    - +

    td

    @@ -2439,7 +2439,7 @@ document.write("Last Published: " + docu
     
    - +

    th

    @@ -2500,7 +2500,7 @@ document.write("Last Published: " + docu
     
    - +

    title

    @@ -2549,7 +2549,7 @@ document.write("Last Published: " + docu
     
    - +

    tr

    @@ -2596,7 +2596,7 @@ document.write("Last Published: " + docu
     
    - +

    type

    @@ -2645,7 +2645,7 @@ document.write("Last Published: " + docu
     
    - +

    ul

    @@ -2697,7 +2697,7 @@ document.write("Last Published: " + docu
     
    - +

    version

    @@ -2766,7 +2766,7 @@ document.write("Last Published: " + docu
     
    - +

    warning

    Modified: forrest/site/dtdx/document-v13.html URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v13.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/dtdx/document-v13.html (original) +++ forrest/site/dtdx/document-v13.html Thu Jan 20 06:47:23 2011 @@ -372,7 +372,7 @@ document.write("Last Published: " + docu - +

    Sample Content

    @@ -381,7 +381,7 @@ document.write("Last Published: " + docu 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 @@ -583,7 +583,7 @@ document.write("Last Published: " + docu

  • This should be 3 if my math is still OK.
  • - +

    Various presentation formats

    This sample document, written in document-v13 XML can be presented via @@ -657,24 +657,24 @@ document.write("Last Published: " + docu

    - +

    Using sections

    You can use sections to put some structure in your document. For some strange historical reason, the section title is an attribute of the <section> element.

    - +

    Sections, the sequel

    Just some second section.

    - +

    Section 2.1

    Which contains a subsection (2.1).

    - +

    Showing preformatted source code

    Enough about these sections. Let's have a look at more interesting @@ -712,7 +712,7 @@ public class FirstApplet extends Applet Please take care to still use a sensible line-length within your source elements.

    - +

    Using tables

    And now for a table: @@ -777,7 +777,7 @@ public class FirstApplet extends Applet - +

    Using figures

    And a <figure> to end all of this. Note that this @@ -787,21 +787,21 @@ public class FirstApplet extends Applet The fine Forrest logo

    - +

    DTD changes

    See the generated DTD reference documentation.

    - +

    Changes since document-v12

    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.

    - +

    Changes since document-v11

    doc-v12 enhances doc-v11 by relaxing various restrictions that were Modified: forrest/site/dtdx/document-v13.pdf URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v13.pdf?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== Binary files - no diff available. Modified: forrest/site/dtdx/document-v20.dtdx.html URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v20.dtdx.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/dtdx/document-v20.dtdx.html (original) +++ forrest/site/dtdx/document-v20.dtdx.html Thu Jan 20 06:47:23 2011 @@ -462,7 +462,7 @@ document.write("Last Published: " + docu

    - +

    Top-level element(s)

      @@ -471,10 +471,10 @@ document.write("Last Published: " + docu
    - +

    Element declarations

    - +

    a

    @@ -539,7 +539,7 @@ document.write("Last Published: " + docu
     
    - +

    abstract

    @@ -588,7 +588,7 @@ document.write("Last Published: " + docu
     
    - +

    acronym

    @@ -643,7 +643,7 @@ document.write("Last Published: " + docu
     
    - +

    anchor

    @@ -693,7 +693,7 @@ document.write("Last Published: " + docu
     
    - +

    area

    @@ -765,7 +765,7 @@ document.write("Last Published: " + docu
     
    - +

    authors

    @@ -812,7 +812,7 @@ document.write("Last Published: " + docu
     
    - +

    body

    @@ -859,7 +859,7 @@ document.write("Last Published: " + docu
     
    - +

    br

    @@ -908,7 +908,7 @@ document.write("Last Published: " + docu
     
    - +

    caption

    @@ -957,7 +957,7 @@ document.write("Last Published: " + docu
     
    - +

    code

    @@ -1006,7 +1006,7 @@ document.write("Last Published: " + docu
     
    - +

    dd

    @@ -1055,7 +1055,7 @@ document.write("Last Published: " + docu
     
    - +

    dl

    @@ -1102,7 +1102,7 @@ document.write("Last Published: " + docu
     
    - +

    document

    @@ -1145,7 +1145,7 @@ document.write("Last Published: " + docu
    - +

    dt

    @@ -1194,7 +1194,7 @@ document.write("Last Published: " + docu
     
    - +

    em

    @@ -1243,7 +1243,7 @@ document.write("Last Published: " + docu
     
    - +

    figure

    @@ -1329,7 +1329,7 @@ document.write("Last Published: " + docu
     
    - +

    fixme

    @@ -1384,7 +1384,7 @@ document.write("Last Published: " + docu
     
    - +

    footer

    @@ -1405,7 +1405,7 @@ document.write("Last Published: " + docu
     
    - +

    header

    @@ -1452,7 +1452,7 @@ document.write("Last Published: " + docu
     
    - +

    icon

    @@ -1523,7 +1523,7 @@ document.write("Last Published: " + docu
     
    - +

    img

    @@ -1609,7 +1609,7 @@ document.write("Last Published: " + docu
     
    - +

    legal

    @@ -1658,7 +1658,7 @@ document.write("Last Published: " + docu
     
    - +

    li

    @@ -1707,7 +1707,7 @@ document.write("Last Published: " + docu
     
    - +

    map

    @@ -1759,7 +1759,7 @@ document.write("Last Published: " + docu
     
    - +

    meta

    @@ -1814,7 +1814,7 @@ document.write("Last Published: " + docu
     
    - +

    note

    @@ -1868,7 +1868,7 @@ document.write("Last Published: " + docu
     
    - +

    notice

    @@ -1917,7 +1917,7 @@ document.write("Last Published: " + docu
     
    - +

    ol

    @@ -1969,7 +1969,7 @@ document.write("Last Published: " + docu
     
    - +

    p

    @@ -2023,7 +2023,7 @@ document.write("Last Published: " + docu
     
    - +

    person

    @@ -2084,7 +2084,7 @@ document.write("Last Published: " + docu
     
    - +

    section

    @@ -2131,7 +2131,7 @@ document.write("Last Published: " + docu
     
    - +

    source

    @@ -2187,7 +2187,7 @@ document.write("Last Published: " + docu
     
    - +

    strong

    @@ -2236,7 +2236,7 @@ document.write("Last Published: " + docu
     
    - +

    sub

    @@ -2285,7 +2285,7 @@ document.write("Last Published: " + docu
     
    - +

    subtitle

    @@ -2334,7 +2334,7 @@ document.write("Last Published: " + docu
     
    - +

    sup

    @@ -2383,7 +2383,7 @@ document.write("Last Published: " + docu
     
    - +

    table

    @@ -2430,7 +2430,7 @@ document.write("Last Published: " + docu
     
    - +

    td

    @@ -2491,7 +2491,7 @@ document.write("Last Published: " + docu
     
    - +

    th

    @@ -2552,7 +2552,7 @@ document.write("Last Published: " + docu
     
    - +

    title

    @@ -2601,7 +2601,7 @@ document.write("Last Published: " + docu
     
    - +

    tr

    @@ -2648,7 +2648,7 @@ document.write("Last Published: " + docu
     
    - +

    type

    @@ -2697,7 +2697,7 @@ document.write("Last Published: " + docu
     
    - +

    ul

    @@ -2749,7 +2749,7 @@ document.write("Last Published: " + docu
     
    - +

    version

    @@ -2818,7 +2818,7 @@ document.write("Last Published: " + docu
     
    - +

    warning

    @@ -2872,7 +2872,7 @@ document.write("Last Published: " + docu
     
    - +

    xi:include

    Modified: forrest/site/dtdx/document-v20.html URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v20.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/dtdx/document-v20.html (original) +++ forrest/site/dtdx/document-v20.html Thu Jan 20 06:47:23 2011 @@ -384,7 +384,7 @@ document.write("Last Published: " + docu - +

    Sample Content

    @@ -393,7 +393,7 @@ document.write("Last Published: " + docu 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 @@ -574,7 +574,7 @@ document.write("Last Published: " + docu

  • This should be 3 if my math is still OK.
  • - +

    Various presentation formats

    This sample document, written in document-v20 XML can be presented via @@ -669,22 +669,22 @@ document.write("Last Published: " + docu

    - +

    Using sections

    You can use sections to put some structure in your document.

    - +

    Sections, the sequel

    Just some second section.

    - +

    Section 2.1

    Which contains a subsection (2.1).

    - +

    Showing preformatted source code

    Enough about these sections. Let's have a look at more interesting @@ -722,7 +722,7 @@ public class FirstApplet extends Applet Please take care to still use a sensible line-length within your source elements.

    - +

    Using tables

    And now for a table: @@ -787,7 +787,7 @@ public class FirstApplet extends Applet - +

    Using figures

    And a <figure> to end all of this. Note that this @@ -796,7 +796,7 @@ public class FirstApplet extends Applet

    - +

    Using map and area

    @@ -816,7 +816,7 @@ public class FirstApplet extends Applet

    - +

    Using class attribute on links

    The document-v13 had elements <fork> and <jump>. In @@ -887,14 +887,14 @@ public class FirstApplet extends Applet

    - +

    DTD changes

    See the generated DTD reference documentation.

    - +

    Changes between document-v13 and document-v20

      @@ -913,14 +913,14 @@ public class FirstApplet extends Applet
    - +

    Changes between document-v12 and document-v13

    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.

    - +

    Changes between document-v11 and document-v12

    doc-v12 enhances doc-v11 by relaxing various restrictions that were Modified: forrest/site/dtdx/document-v20.pdf URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v20.pdf?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== Binary files - no diff available. Modified: forrest/site/dtdx/dtd-docs.html URL: http://svn.apache.org/viewvc/forrest/site/dtdx/dtd-docs.html?rev=1061134&r1=1061133&r2=1061134&view=diff ============================================================================== --- forrest/site/dtdx/dtd-docs.html (original) +++ forrest/site/dtdx/dtd-docs.html Thu Jan 20 06:47:23 2011 @@ -323,7 +323,7 @@ document.write("Last Published: " + docu

    - +

    Overview

    @@ -341,7 +341,7 @@ document.write("Last Published: " + docu

    - +

    The generated documentation