You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by rg...@apache.org on 2006/01/03 01:59:28 UTC
svn commit: r365503 [2/4] - in
/forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat: ./ src/
src/documentation/ src/documentation/classes/ src/documentation/conf/
src/documentation/content/ src/documentation/content/xdocs/
src/documentation/...
Added: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/index.fv
URL: http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/index.fv?rev=365503&view=auto
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/index.fv (added)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/index.fv Mon Jan 2 16:58:27 2006
@@ -0,0 +1,433 @@
+<?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.
+-->
+
+<forrest:views
+ xmlns:forrest="http://apache.org/forrest/templates/1.0"
+ xmlns:jx="http://apache.org/cocoon/templates/jx/1.0">
+ <forrest:view type="html">
+ <forrest:css url="pelt.basic.css" media="screen" theme="Pelt"/>
+ <forrest:css url="pelt.screen.css" media="screen" theme="Pelt"/>
+ <forrest:css url="pelt.print.css" media="print"/>
+ <forrest:css url="common.css" media="screen" rel="alternate stylesheet" theme="common"/>
+ <forrest:css url="leather-dev.css" media="screen" rel="alternate stylesheet" theme="common"/>
+ <forrest:css >
+/* Extra css */
+ .example {
+ border: 1px solid #ddd;
+ }
+ </forrest:css>
+ <forrest:contract name="siteinfo-meta">
+ <forrest:properties contract="siteinfo-meta">
+ <forrest:property name="siteinfo-meta" nugget="get.build.info">
+ <jx:import uri="cocoon://build-info"/>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <!-- FIXME - Cocoon problem with favicon.ico -->
+ <!--<forrest:contract name="siteinfo-meta-icon">
+ <forrest:properties contract="siteinfo-meta-icon">
+ <forrest:property name="siteinfo-meta-icon">
+ <favicon-url></favicon-url>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>-->
+ <forrest:contract name="branding-theme-profiler">
+ <forrest:properties contract="branding-theme-profiler">
+ <forrest:property name="branding-theme-profiler-theme">Pelt-Forrest</forrest:property>
+ <forrest:property name="branding-theme-profiler">
+ <color name="breadtrail" value="#cedfef" font="#0F3660"
+ link="#0F3660" vlink="#0F3660" hlink="#000066"/>
+ <color name="header" value="#294563"/>
+ <color name="tab-selected" value="#4a6d8c" link="#0F3660"
+ vlink="#0F3660" hlink="#000066"/>
+ <color name="tab-unselected" value="#b5c7e7" link="#0F3660"
+ vlink="#0F3660" hlink="#000066"/>
+ <color name="subtab-selected" value="#4a6d8c" link="#0F3660"
+ vlink="#0F3660" hlink="#000066"/>
+ <color name="subtab-unselected" value="#4a6d8c" link="#0F3660"
+ vlink="#0F3660" hlink="#000066"/>
+ <color name="heading" value="#294563"/>
+ <color name="subheading" value="#4a6d8c"/>
+ <color name="published" value="#4C6C8F" font="#FFFFFF"/>
+ <color name="feedback" value="#4C6C8F" font="#FFFFFF" align="center"/>
+ <color name="navstrip" value="#4a6d8c" font="#ffffff" link="#0F3660"
+ vlink="#0F3660" hlink="#000066"/>
+ <color name="menu" value="#4a6d8c" font="#cedfef" link="#ffffff"
+ vlink="#ffffff" hlink="#ffcf00"/>
+ <color name="toolbox" value="#4a6d8c"/>
+ <color name="border" value="#294563"/>
+ <color name="dialog" value="#4a6d8c"/>
+ <color name="searchbox" value="#4a6d8c" font="#000000"/>
+ <color name="body" value="#ffffff" link="#0F3660" vlink="#009999"
+ hlink="#000066"/>
+ <color name="table" value="#7099C5"/>
+ <color name="table-cell" value="#f0f0ff"/>
+ <color name="highlight" value="#ffff00"/>
+ <color name="fixme" value="#cc6600"/>
+ <color name="note" value="#006699"/>
+ <color name="warning" value="#990000"/>
+ <color name="code" value="#CFDCED"/>
+ <color name="footer" value="#cedfef"/>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:contract name="branding-theme-profiler">
+ <forrest:properties contract="branding-theme-profiler">
+ <forrest:property name="branding-theme-profiler-theme">Pelt-Krysalis</forrest:property>
+ <forrest:property name="branding-theme-profiler">
+ <!-- Color group: Krysalis -->
+ <color name="header" value="#FFFFFF"/>
+ <color name="tab-selected" value="#a5b6c6" link="#000000"
+ vlink="#000000" hlink="#000000"/>
+ <color name="tab-unselected" value="#F7F7F7" link="#000000"
+ vlink="#000000" hlink="#000000"/>
+ <color name="subtab-selected" value="#a5b6c6" link="#000000"
+ vlink="#000000" hlink="#000000"/>
+ <color name="subtab-unselected" value="#a5b6c6" link="#000000"
+ vlink="#000000" hlink="#000000"/>
+ <color name="heading" value="#a5b6c6"/>
+ <color name="subheading" value="#CFDCED"/>
+ <color name="navstrip" value="#CFDCED" font="#000000" link="#000000"
+ vlink="#000000" hlink="#000000"/>
+ <color name="toolbox" value="#a5b6c6"/>
+ <color name="border" value="#a5b6c6"/>
+ <color name="menu" value="#F7F7F7" link="#000000" vlink="#000000"
+ hlink="#000000"/>
+ <color name="dialog" value="#F7F7F7"/>
+ <color name="body" value="#ffffff" link="#0F3660" vlink="#009999"
+ hlink="#000066"/>
+ <color name="table" value="#a5b6c6"/>
+ <color name="table-cell" value="#ffffff"/>
+ <color name="highlight" value="#ffff00"/>
+ <color name="fixme" value="#cc6600"/>
+ <color name="note" value="#006699"/>
+ <color name="warning" value="#990000"/>
+ <color name="code" value="#a5b6c6"/>
+ <color name="footer" value="#a5b6c6"/>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:contract name="branding-theme-profiler">
+ <forrest:properties contract="branding-theme-profiler">
+ <forrest:property name="branding-theme-profiler-theme">Pelt-Collabnet</forrest:property>
+ <forrest:property name="branding-theme-profiler">
+ <!-- Color group: Collabnet -->
+ <color name="header" value="#003366"/>
+ <color name="tab-selected" value="#dddddd" link="#555555"
+ vlink="#555555" hlink="#555555"/>
+ <color name="tab-unselected" value="#999999" link="#ffffff"
+ vlink="#ffffff" hlink="#ffffff"/>
+ <color name="subtab-selected" value="#cccccc" link="#000000"
+ vlink="#000000" hlink="#000000"/>
+ <color name="subtab-unselected" value="#cccccc" link="#555555"
+ vlink="#555555" hlink="#555555"/>
+ <color name="heading" value="#003366"/>
+ <color name="subheading" value="#888888"/>
+ <color name="navstrip" value="#dddddd" font="#555555"/>
+ <color name="toolbox" value="#dddddd" font="#555555"/>
+ <color name="border" value="#999999"/>
+ <color name="menu" value="#ffffff"/>
+ <color name="dialog" value="#eeeeee"/>
+ <color name="body" value="#ffffff"/>
+ <color name="table" value="#ccc"/>
+ <color name="table-cell" value="#ffffff"/>
+ <color name="highlight" value="#ffff00"/>
+ <color name="fixme" value="#cc6600"/>
+ <color name="note" value="#006699"/>
+ <color name="warning" value="#990000"/>
+ <color name="code" value="#003366"/>
+ <color name="footer" value="#ffffff"/>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:hook name="container">
+ <forrest:contract name="helper-prototype-ajax"/>
+ <forrest:contract name="branding-breadcrumbs">
+ <forrest:properties contract="branding-breadcrumbs">
+ <forrest:property name="branding-breadcrumbs">
+ <trail>
+ <link1 name="Apache Forrest" href="http://forrest.apache.org/"/>
+ <link2 name="Plugins" href="http://forrest.apache.org/docs/plugins/"/>
+ <link3 name="org.apache.forrest.plugin.output.themer" href="http://forrest.apache.org/docs/plugins/org.apache.forrest.plugin.output.themer/"/>
+ </trail>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:hook name="header">
+ <forrest:contract name="branding-tagline">
+ <forrest:properties contract="branding-tagline">
+ <forrest:property name="branding-tagline-name">new
+ seed v2</forrest:property>
+ <forrest:property name="branding-tagline-tagline">powered by
+ forrest:views v2</forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:hook class="logo">
+ <forrest:contract name="branding-logo">
+ <forrest:properties contract="branding-logo">
+ <forrest:property name="branding-logo-name">
+ MyGroup</forrest:property>
+ <forrest:property name="branding-logo-description">MyGroup
+ Description</forrest:property>
+ <forrest:property name="branding-logo-url">
+ http://mygroup.org/</forrest:property>
+ <forrest:property name="branding-logo-logo">
+ images/group.png</forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ </forrest:hook>
+ <forrest:hook class="logo">
+ <forrest:contract name="branding-logo">
+ <forrest:properties contract="branding-logo">
+ <forrest:property name="branding-logo-name">
+ MyProject</forrest:property>
+ <forrest:property name="branding-logo-description">MyProject
+ Description</forrest:property>
+ <forrest:property name="branding-logo-url">
+ http://myproj.mygroup.org/</forrest:property>
+ <forrest:property name="branding-logo-logo">
+ images/project.png</forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ </forrest:hook>
+ <forrest:contract name="search-input">
+ <forrest:properties contract="search-input">
+ <forrest:property name="input-size">25</forrest:property>
+ <forrest:property name="search-input">
+ <search name="MyProject" domain="mydomain" provider="google"/>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:hook name="nav-main-hook">
+ <forrest:contract name="nav-main">
+ <forrest:properties contract="nav-main">
+ <forrest:property name="nav-main" nugget="get.navigation">
+ <jx:import uri="cocoon://${cocoon.parameters.getRequest}.navigation.xml"/>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:hook name="publishedStrip">
+ <forrest:contract name="nav-main-sub">
+ <forrest:properties contract="nav-main-sub">
+ <forrest:property name="nav-main-sub" nugget="get.navigation">
+ <jx:import uri="cocoon://#{$cocoon/parameters/getRequest}.navigation.xml"/>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:contract name="siteinfo-current-time"/>
+ </forrest:hook>
+ </forrest:hook>
+ </forrest:hook>
+ <forrest:hook name="page">
+ <forrest:contract name="branding-breadcrumbs">
+ <forrest:properties contract="branding-breadcrumbs">
+ <forrest:property name="branding-breadcrumbs">
+ <trail>
+ <link1 name="myGroup" href="http://www.apache.org/"/>
+ <link2 name="myProject" href="http://forrest.apache.org/"/>
+ <link3 name="" href=""/>
+ </trail>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:hook name="leftbar">
+ <forrest:contract name="nav-section">
+ <forrest:properties contract="nav-section">
+ <forrest:property name="nav-section" nugget="get.navigation">
+ <jx:import uri="cocoon://#{$cocoon/parameters/getRequest}.navigation.xml"/>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:contract name="genericMarkup">
+ <forrest:properties contract="genericMarkup">
+ <forrest:property name="genericMarkup">
+ <hr/>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:contract name="search-input">
+ <forrest:properties contract="search-input">
+ <forrest:property name="input-size">18</forrest:property>
+ <forrest:property name="search-input">
+ <search name="MyProject" domain="mydomain" provider="google"/>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:contract name="siteinfo-credits">
+ <forrest:properties contract="siteinfo-credits">
+ <forrest:property name="box-location">credit</forrest:property>
+ <forrest:property name="top-separator">true</forrest:property>
+ <forrest:property name="siteinfo-credits">
+ <credits>
+ <credit>
+ <name>Built with Apache Forrest</name>
+ <url>http://forrest.apache.org/</url>
+ <image>images/built-with-forrest-button.png</image>
+ <width>88</width>
+ <height>31</height>
+ </credit>
+ </credits>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:contract name="genericMarkup">
+ <forrest:properties contract="genericMarkup">
+ <forrest:property name="genericMarkup">
+ <hr/>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:contract name="content-motd-page">
+ <forrest:properties contract="content-motd-page">
+ <forrest:property name="content-motd-page">
+ <motd>
+ <motd-option pattern="index.html">
+ <motd-title>sample</motd-title>
+ <motd-page location="both">
+ This is an example of a Message of the day (MOTD).
+ </motd-page>
+ <motd-page-url>index.html</motd-page-url>
+ </motd-option>
+ <motd-option pattern="samples/faq.html">
+ <motd-title></motd-title>
+ <motd-page location="both">
+ How to enable this MOTD is on this page.
+ </motd-page>
+ <motd-page-url>#motd</motd-page-url>
+ </motd-option>
+ </motd>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:contract name="nav-section-round-bottom"/>
+ </forrest:hook>
+ <jx:import uri="cocoon://prepare.tiles.export-link"/>
+ <forrest:hook name="content">
+ <!-- FIXME - Problem with ndeSetTextSize() script from fontsize.js not compliant between Pelt and Leather-dev... -->
+ <!--<forrest:hook class="trail">
+ <forrest:contract name="branding-fontsize"/>
+ </forrest:hook>-->
+ <forrest:contract name="content-title">
+ <forrest:properties contract="content-title">
+ <forrest:property name="content-title" nugget="get.title">
+ <jx:import uri="cocoon://#{$cocoon/parameters/getRequest}.title.xml"/>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:contract name="content-abstract">
+ <forrest:properties contract="content-abstract">
+ <forrest:property name="content-abstract" nugget="get.abstract">
+ <jx:import uri="cocoon://#{$cocoon/parameters/getRequest}.abstract.xml"/>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:contract name="content-minitoc">
+ <forrest:properties contract="content-minitoc">
+ <forrest:property name="content-minitoc-toc" nugget="get.toc">
+ <jx:import uri="cocoon://#{$cocoon/parameters/getRequest}.toc.xml"/>
+ </forrest:property>
+ <forrest:property name="content-minitoc-conf" >
+ <toc max-depth="2"
+ min-sections="1" location="page"/>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:contract name="content-main">
+ <forrest:properties contract="content-main">
+ <forrest:property name="content-main" nugget="get.body">
+ <jx:import uri="cocoon://#{$cocoon/parameters/getRequest}.body.xml"/>
+ </forrest:property>
+ <forrest:property name="content-main-conf">
+ <headings type="underlined"/>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:hook name="example" class="example">
+ <forrest:contract name="branding-theme-switcher">
+ <forrest:properties contract="branding-theme-switcher">
+ <!-- branding-theme-switcher-profiler and branding-theme-switcher-defaultTheme are required -->
+ <!-- branding-theme-switcher-profiler {true|false} only works on the defaultTheme -->
+ <forrest:property name="branding-theme-switcher-profiler" activated="true"/>
+ <forrest:property name="branding-theme-switcher-defaultTheme" defaultTheme="Pelt"/>
+ <!-- normally you are not using an "a link" switcher and a "selectbox" switcher at the same time
+ in the same position, so uncomment the one you want. -->
+ <!--<forrest:property name="branding-theme-switcher-a" seperator="|" caption="Theme switcher: "/>-->
+ <forrest:property name="branding-theme-switcher-select" caption="Theme switcher: "/>
+ </forrest:properties>
+ </forrest:contract>
+ </forrest:hook>
+ <forrest:hook name="example" class="example">
+ <forrest:contract name="ajax-example"/>
+ </forrest:hook>
+ <forrest:contract name="content-authors">
+ <forrest:properties contract="content-authors">
+ <forrest:property name="content-authors" nugget="get.authors">
+ <jx:import uri="cocoon://#{$cocoon/parameters/getRequest}.authors.xml"/>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ </forrest:hook>
+ </forrest:hook>
+ <forrest:hook name="footer">
+ <forrest:hook class="lastmodified">
+ <forrest:contract name="siteinfo-last-published"/>
+ </forrest:hook>
+ <forrest:hook class="copyright">
+ <forrest:contract name="siteinfo-copyright">
+ <forrest:properties contract="siteinfo-copyright">
+ <forrest:property name="siteinfo-copyright">
+ <copyright>
+ <year>2005</year>
+ <vendor>The Acme Software Foundation.</vendor>
+ </copyright>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ </forrest:hook>
+ <!--FIXME thorsten turned this off while developing (no internet connection)
+ <forrest:contract name="siteinfo-compliance-links"/>-->
+ <forrest:contract name="siteinfo-credits">
+ <forrest:properties contract="siteinfo-credits">
+ <forrest:property name="box-location">credit</forrest:property>
+ <forrest:property name="top-separator">true</forrest:property>
+ <forrest:property name="siteinfo-credits">
+ <credits>
+ <credit>
+ <name>Built with Apache Forrest</name>
+ <url>http://forrest.apache.org/</url>
+ <image>images/built-with-forrest-button.png</image>
+ <width>88</width>
+ <height>31</height>
+ </credit>
+ </credits>
+ </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ <forrest:contract name="siteinfo-feedback-dyn">
+ <forrest:properties contract="siteinfo-feedback-dyn">
+ <forrest:property name="siteinfo-feedback-dyn-config"
+ to="webmaster@foo.com"
+ href="mailto:webmaster@foo.com?subject=Feedback "> Send
+ feedback about the website to: </forrest:property>
+ </forrest:properties>
+ </forrest:contract>
+ </forrest:hook>
+ </forrest:hook>
+ </forrest:view>
+</forrest:views>
+
Added: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/index.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/index.xml?rev=365503&view=auto
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/index.xml (added)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/index.xml Mon Jan 2 16:58:27 2006
@@ -0,0 +1,29 @@
+<?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>Samples</title>
+ </header>
+ <body>
+ <section id="please-contribute">
+ <title>If something goes wrong..</title>
+ <p>Patches are welcome: <a href="http://forrest.apache.org/docs/faq.html">Forrest FAQ</a></p>
+ </section>
+ </body>
+</document>
Propchange: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/index.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/linking.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/linking.xml?rev=365503&view=auto
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/linking.xml (added)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/linking.xml Mon Jan 2 16:58:27 2006
@@ -0,0 +1,353 @@
+<?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://apache.org/forrest/dtd/document-v20.dtd">
+<document>
+ <header>
+ <title>Demonstration of linking</title>
+ </header>
+
+ <body>
+ <section id="overview">
+ <title>Overview</title>
+ <p>Forrest has many powerful techniques for linking between documents
+ and for managing the site navigation. This document demonstrates those
+ techniques.
+ The document "<a href="ext:linking">Menus and Linking</a>"
+ has the full details.
+ </p>
+ </section>
+
+ <section id="uri-space">
+ <title>Building and maintaining consistent URI space</title>
+ <p>
+ When Forrest builds your site, it starts from the front page. Like
+ a robot, it traverses all of the links that it finds in the documents
+ and builds the corresponding pages. Any new links are further traversed.
+ </p>
+ <p>
+ Sometimes those links lead to documents that are generated directly
+ from xml source files, sometimes they are generated from other source
+ via an intermediate xml format. Other times the links lead to raw
+ un-processed content.
+ </p>
+ <p>
+ The site navigation configuration file "<code>site.xml</code>" provides
+ a way to manage this URI space. In the future, when documents are
+ re-arranged and renamed, the site.xml configuration will enable this
+ smoothly.
+ </p>
+ </section>
+
+ <section id="resource-space">
+ <title>Mapping the local resource space to the final URI space</title>
+ <p>
+ For both generated and raw (un-processed) files, the top-level of the
+ URI space corresponds to the "<code>content/xdocs/</code>" directory,
+ i.e. the location of the "<code>site.xml</code>" configuration file.
+ </p>
+ <note>
+ In versions prior to 0.7 raw un-processed content was stored in
+ the "<code>content/</code>" directory. In 0.7 onwards, raw
+ un-processed data is stored alongside the xdocs. In addition,
+ in 0.6 and earlier, HTML documents could be stored in the xdocs
+ directory and served without processing. If you
+ you wish to emulate the behaviour of 0.6 and earlier see the
+ next section.
+ </note>
+ <p>
+ A diagram will help.
+ </p>
+ <source><![CDATA[
+The resource space ==============> The final URI space
+------------------ -------------------
+Generated content ...
+ content/xdocs/index.xml index.html
+ content/xdocs/samples/index.xml samples/index.html
+ content/xdocs/samples/faq.xml samples/faq.html
+ content/xdocs/test1.html test1.html
+ content/xdocs/samples/test3.html samples/test3.html
+ content/xdocs/samples/subdir/test4.html samples/subdir/test4.html
+
+Raw un-processed content ...
+ content/xdocs/hello.pdf hello.pdf
+ content/xdocs/hello.sxw hello.sxw
+ content/xdocs/subdir/hello.sxw subdir/hello.sxw
+]]></source>
+
+ <section>
+ <title>How Plugins May Affect The URI Space</title>
+ <p>By using <a href="site:plugins">Forrest Input Plugins</a>
+ you can process some file formats, such as
+ OpenOffice.org documents and produce processed content from them. For example,
+ the file <code>content/xdocs/hello.sxw</code> can be used to produce a
+ skinned version of the document at with the name <code>hello.html</code>.
+ Similarly, you can use <a href="site:plugins">Forrest Output
+ Plugins</a> to create different output formats such as PDF, in this
+ case <code>content/xdocs/hello.sxw</code> can produce
+ <code>hello.pdf</code>.</p>
+
+ <p>However, this does not affect the handling of raw content. That is, you
+ can still retrieve the raw un-processed version with, for example,
+ <code>hello.sxw</code>. If you want to prevent the user retrieving the
+ un-processed version you will have to create matchers that intercept
+ these requests within your project sitemap.</p>
+ </section>
+
+ </section>
+
+ <section id="generated">
+ <title>Basic link to internal generated pages</title>
+ <p>
+ When this type of link is encountered, Forrest will look for a
+ corresponding xml file, relative to this document (i.e. in
+ <code>content/xdocs/samples/</code>).
+ </p>
+ <p>A generated document in the current directory, which corresponds to
+ <code>content/xdocs/samples/sample.html</code> ...
+ </p>
+ <source><![CDATA[<a href="sample.html">]]><a href="sample.html">sample.html</a><![CDATA[</a>]]></source>
+ <p>In a sub-directory, which corresponds to
+ <code>content/xdocs/samples/subdir/index.html</code> ...
+ </p>
+ <source><![CDATA[<a href="subdir/index.html">]]><a href="subdir/index.html">subdir/index.html</a><![CDATA[</a>]]></source>
+ </section>
+
+ <section id="raw">
+ <title>Basic link to raw un-processed content</title>
+ <p>
+ Raw content files are not intended for any processing, they are just
+ linked to (e.g. pre-prepared PDFs, zip archives).
+ These files are placed alongside your normal content in the
+ "<code>content/xdocs</code>" directory.
+ </p>
+ <p>A raw document in the current directory, which corresponds to
+ <code>content/xdocs/samples/helloAgain.pdf</code> ...
+ </p>
+ <source><![CDATA[<a href="helloAgain.pdf">]]><a href="helloAgain.pdf">helloAgain.pdf</a><![CDATA[</a>]]></source>
+ <p>A raw document in a sub-directory, which corresponds to
+ <code>content/xdocs/samples/subdir/hello.zip</code> ...
+ </p>
+ <source><![CDATA[<a href="subdir/hello.zip">]]><a href="subdir/hello.zip">subdir/hello.zip</a><![CDATA[</a>]]></source>
+ <p>A raw document at the next level up, which corresponds to
+ <code>content/hello.pdf</code> ...
+ </p>
+ <source><![CDATA[<a href="../hello.pdf">]]><a href="../hello.pdf">../hello.pdf</a><![CDATA[</a>]]></source>
+
+ <section id="no-decoration">
+ <title>Serving (X)HTML content without Skinning</title>
+
+ <p>Prior to version 0.7, the raw un-processed content was stored in
+ the "<code>content/</code>" directory. In 0.7 onwards, raw
+ un-processed data is stored alongside the xdocs. In addition
+ in 0.6 and earlier, HTML files could be stored in the xdocs
+ directory and they would be served without further processing.
+ As described above, this is not the case in 0.7 where HTML files
+ are, by default, skinned by Forrest.</p>
+
+ <p>If you
+ you wish to emulate the behaviour of 0.6 and earlier then you
+ must add the following to your project sitemap.</p>
+
+ <source>
+<map:match pattern="**.html">
+ <map:select type="exists">
+ <map:when test="{project:content}{0}">
+ <map:read src="{project:content}/{0}" mime-type="text/html"/>
+ <!--
+ Use this instead if you want JTidy to clean up your HTML
+ <map:generate type="html" src="{project:content}/{0}" />
+ <map:serialize type="html"/>
+ -->
+ </map:when>
+ <map:when test="{project:content.xdocs}{0}">
+ <map:read src="{project:content.xdocs}/{0}" mime-type="text/html"/>
+ <!--
+ Use this instead if you want JTidy to clean up your HTML
+ <map:generate type="html" src="{project:content.xdocs}/{0}" />
+ <map:serialize type="html"/>
+ -->
+ </map:when>
+ </map:select>
+</map:match>
+ </source>
+
+ <p>The above allows us to create links to un-processed skinned files stored
+ in the <code>{project:content}</code> or <code>{project:content.xdocs}</code>
+ directory. For example:
+ <a href="/test1.html">HTML content</a>. However, it will
+ break the 0.7 behaviour of skinning HTML content. For this reason the old
+ ".ehtml" extension can be used to embed HTML content in a Forrest skinned
+ site </p>
+
+ <p>Note that you can change the matchers above to selectively serve some
+ content as raw un-processed content, whilst still serving other content
+ as skinned documents. For example, the following snippet would allow
+ you to serve the content of an old, deprecated site without processing
+ from Forrest, whilst still allowing all other content to be processed
+ by Forrest in the normal way:</p>
+
+ <source>
+<map:match pattern="old_site/**.html">
+ <map:select type="exists">
+ <map:when test="{project:content}{1}.html">
+ <map:read src="{project:content}/{1}.html" mime-type="text/html"/>
+ <!--
+ Use this instead if you want JTidy to clean up your HTML
+ <map:generate type="html" src="{project:content}/{0}" />
+ <map:serialize type="html"/>
+ -->
+ </map:when>
+</map:match>
+ </source>
+
+ <p>For example, <a href="/old_site/test1.html">HTML content</a>.</p>
+ </section>
+ </section>
+
+ <section id="url">
+ <title>Full URL to external documents</title>
+ <p>A full URL ...</p>
+ <source><![CDATA[<a href="http://forrest.apache.org/">]]><a href="http://forrest.apache.org/">http://forrest.apache.org/</a><![CDATA[</a>]]></source>
+ <p>A full URL with a fragment identifier ...</p>
+ <source><![CDATA[<a href="http://forrest.apache.org/faq.html#link_raw">]]><a href="http://forrest.apache.org/faq.html#link_raw">http://forrest.apache.org/faq.html#link_raw</a><![CDATA[</a>]]></source>
+ <p>
+ Note that Forrest does not traverse external links to look for
+ other links.
+ </p>
+ </section>
+
+ <section id="site">
+ <title>Using site.xml to manage the links</title>
+ <p>As you will have discovered, using pathnames with ../../ etc. will
+ get very nasty. Real problems occur when you use a smart text editor
+ that tries to manage the links for you. For example, it will have
+ trouble linking to the raw content files which are not yet in their
+ final location.
+ </p>
+ <p>
+ Links and filenames are bound to change and re-arrange. It is
+ essential to only change those links in one central place, not in every
+ document.
+ </p>
+ <p>
+ The "<code>site.xml</code>" configuration file to the rescue. It maps
+ symbolic names to actual resources.
+ </p>
+
+ <section id="site-simple">
+ <title>Basic link to internal generated pages</title>
+ <p>This single entry ...</p>
+ <source><![CDATA[<index label="Index" href="index.html"/>]]></source>
+ <p>
+ enables a simple link to a generated document, which corresponds to
+ <code>content/xdocs/index.xml</code> ...
+ </p>
+ <source><![CDATA[<a href="site:index">]]><a href="site:index">site:index</a><![CDATA[</a>]]></source>
+ </section>
+
+ <section id="site-compound">
+ <title>Group some items</title>
+ <p>This compound entry ...</p>
+ <source><![CDATA[
+ <samples label="Samples" href="samples/" tab="samples">
+ <faq label="FAQ" href="faq.html"/>
+ ...
+ </samples>
+]]></source>
+ <p>
+ enables a link to a generated document, which corresponds to
+ <code>content/xdocs/samples/index.xml</code> ...
+ </p>
+ <source><![CDATA[<a href="site:samples">]]><a href="site:samples">site:samples</a><![CDATA[</a>]]></source>
+ <p>
+ and a link to a generated document, which corresponds to
+ <code>content/xdocs/samples/faq.xml</code> ...
+ </p>
+ <source>
+<![CDATA[<a href="site:faq">]]><a href="site:faq">site:faq</a><![CDATA[</a>]]>
+which can also be a complete reference
+<![CDATA[<a href="site:samples/faq">]]><a href="site:samples/faq">site:samples/faq</a><![CDATA[</a>]]>
+ </source>
+ </section>
+
+ <section id="site-fragment">
+ <title>Fragment identifiers</title>
+ <p>This compound entry ...</p>
+ <source><![CDATA[
+ <samples label="Samples" href="samples/" tab="samples">
+ <sample label="Apache document" href="sample.html">
+ <top href="#top"/>
+ <section href="#section"/>
+ </sample>
+ ...
+ </samples>
+]]></source>
+ <p>
+ enables a link to a fragment identifier within the
+ <code>samples/sample.html</code> document ...
+ </p>
+ <source><![CDATA[<a href="site:samples/sample/section">]]><a href="site:samples/sample/section">site:samples/sample/section</a><![CDATA[</a>]]></source>
+ </section>
+
+ <section id="site-raw">
+ <title>Define items for raw content</title>
+ <p>This entry ...</p>
+ <source><![CDATA[<hello_print href="hello.pdf"/>]]></source>
+ <p>
+ enables a link to a raw document, which corresponds to
+ <code>content/hello.pdf</code> ...
+ </p>
+ <source><![CDATA[<a href="site:hello_print">]]><a href="site:hello_print">site:hello_print</a><![CDATA[</a>]]></source>
+
+ </section>
+
+ <section id="site-ext">
+ <title>External links</title>
+ <p>This compound entry ...</p>
+ <source><![CDATA[
+ <external-refs>
+ <forrest href="http://forrest.apache.org/">
+ <linking href="docs/linking.html"/>
+ <webapp href="docs/your-project.html#webapp"/>
+ </forrest>
+ </external-refs>
+]]></source>
+ <p>
+ enables a link to an external URL ...
+ </p>
+ <source><![CDATA[<a href="ext:forrest">]]><a href="ext:forrest">ext:forrest</a><![CDATA[</a>]]></source>
+ <p>
+ and a link to another external URL ...
+ </p>
+ <source>
+<![CDATA[<a href="ext:linking">]]><a href="ext:linking">ext:linking</a><![CDATA[</a>]]>
+which can also be a complete reference
+<![CDATA[<a href="ext:forrest/linking">]]><a href="ext:forrest/linking">ext:forrest/linking</a><![CDATA[</a>]]>
+ </source>
+ <p>
+ and a link to another external URL with a fragment identifier ...
+ </p>
+ <source>
+<![CDATA[<a href="ext:webapp">]]><a href="ext:webapp">ext:webapp</a><![CDATA[</a>]]>
+which can also be a complete reference
+<![CDATA[<a href="ext:forrest/webapp">]]><a href="ext:forrest/webapp">ext:forrest/webapp</a><![CDATA[</a>]]>
+ </source>
+ </section>
+ </section>
+ </body>
+</document>
Propchange: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/linking.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/locationmap/index.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/locationmap/index.xml?rev=365503&view=auto
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/locationmap/index.xml (added)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/locationmap/index.xml Mon Jan 2 16:58:27 2006
@@ -0,0 +1,101 @@
+<?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>Locationmaps</title>
+ </header>
+ <body>
+ <section id="overview">
+ <title>About Locationmaps</title>
+ <p>A locationmap defines a mapping from requests to location strings.</p>
+
+ <p>It was conceived to:</p>
+
+ <ul>
+ <li>Provide a more powerful means for semantic linking.</li>
+ <li>Enable Forrest with a standard configuration override mechanism.</li>
+ <li>decouple the conceptual source space used by Cocoon from
+ the concrete source space, so that a change in the concrete sources
+ does not impact on the sitemap</li>
+ </ul>
+
+ <p>The syntax of a locationmap resembles that of the sitemap in that it also makes use
+ of Matchers and Selectors to traverse a tree of nodes towards a leaf. In the case of
+ the locationmap however the leaf does not identify a pipeline but instead identifies
+ a location string.</p>
+ </section>
+
+ <section id="examples">
+ <title>Locationmap Examples</title>
+ <section>
+ <title>Retrieving an XDoc via HTTP</title>
+
+
+ <p>Normally files are generated from <code>{project:content.xdocs}</code>.
+ Using the Locationmap it is possible to make these files come from elsewhere.
+ This is useful if you want to pull files from different directory structures,
+ oe even remote repositories.</p>
+
+ <p>The target of "/remoteDemo/*.html"
+ is generated from a source retrieved from the Forrest SVN.</p>
+
+ <note>Because the above URL retrieves the source file from SVN it will
+ only work if you are online. For this reason we have not enabled this link
+ as it would stop you building this site offline. However, if you are online
+ you can enter the URL into the browser and it will work (however, note the
+ issue described below, regarding the site: and ext: protocols).</note>
+
+ <p>The locationmap matcher for the link above is:</p>
+
+ <source>
+ <match pattern="remoteDemo/**.xml">
+ <location src="http://svn.apache.org/repos/asf/forrest/trunk/main/fresh-site/src/documentation/content/xdocs/{1}.xml" />
+ </match>
+ </source>
+
+ <p>Note that because this is a wildcard matcher you can request any page
+ from SVN simply by requesting
+ <code>/remoteDemo/PATH/TO/FILE/FILENAME.html</code>. In addition, we
+ can request any other output format available via Forrest plugins.</p>
+
+ <p>When including resources from remote repositories one has to
+ be careful about things like <code>site:</code> and <code>ext:</code>
+ linking. If the targets are not defined in the local
+ <code>site.xml</code> file then these links will be broken, which
+ is the normal situation.</p>
+
+ </section>
+
+ <section>
+ <title>Link Rewriting</title>
+ <p>The locationmap can be used to rewrite URLs when the page is generated.
+ For example, when the locationmap has:</p>
+ <source>
+ <match pattern="rewriteDemo/**">
+ <location src="http://www.burrokeet.org/{1}.html" />
+ </match>
+ </source>
+ <p><a href="lm:rewriteDemo/index">This link is rewritten to
+ an offsite address</a> not
+ specified in the link, which has <code>href="lm:rewriteDemo/index"</code>.</p>
+ </section>
+
+ </section>
+ </body>
+</document>
Propchange: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/locationmap/index.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/sample.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/sample.xml?rev=365503&view=auto
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/sample.xml (added)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/sample.xml Mon Jan 2 16:58:27 2006
@@ -0,0 +1,407 @@
+<?xml version="1.0"?>
+<!--
+ 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>
+ <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>
+ This is a demonstration document using all possible elements in the
+ current Apache Forrest xdocs <code>document-v20.dtd</code>
+ (See the <a href="#changes">DTD changes</a> section at the bottom.)
+ </note>
+ <section id="sample">
+ <title>Sample Content</title>
+ <p><strong>Hint:</strong> See the xml source to see how the various
+ 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
+ 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,
+ shrimp-kabobs, shrimp creole, shrimp gumbo. Pan fried, deep fried,
+ 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.
+ </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>
+ <ul>
+ <li>Here is a simple list item (<code><li></code>).</li>
+ <li>Have you seen the use of the <code><code></code> element in the
+ previous item?</li>
+ <li>Also, we have <code><sub></code> and <code><sup></code>
+ elements to show content <sup>above</sup> or <sub>below</sub> the text
+ baseline.</li>
+ <li>There is a facility to <em>emphasize</em> certain words using the
+ <code><em></code> <strong><code><strong></code></strong>
+ elements.</li>
+ <li>We can use
+ <icon height="22" width="26" src="../images/icon.png" alt="feather"/>
+ <code><icon></code>s too.</li>
+ <li>Another possibility is the <code><img></code> element:
+ <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:
+ <dl>
+ <dt><code><a href="faq.html"></code></dt>
+ <dd>Use this to
+ <a href="faq.html" title="Example of a document via link">link</a>
+ to another document. As per normal, this will open the new document
+ in the same browser window.</dd>
+
+ <dt><code><a href="#section"></code></dt>
+ <dd>Use this to
+ <a href="#section" title="Example of a document via local anchor">link</a>
+ to the named anchor in the current document.
+ </dd>
+
+ <dt><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>
+ to another document and go to the named anchor. This will open
+ the new document in the same browser window.
+ </dd>
+ <dt>Targetted window control with jump and fork.</dt>
+ <dd>See demonstration
+ <a href="#link-class">using class attribute on links</a>.
+ </dd>
+ </dl></li>
+
+ <li>Oh, by the way, a definition list <code><dl></code> was used inside
+ the previous list item. We could put another
+ <ul>
+ <li>unordered list</li>
+ <li>inside the list item</li>
+ </ul>
+ <table>
+ <caption>A sample nested table</caption>
+ <tr><td>Or even tables.. </td><td>
+ <table><tr><td>inside tables..</td></tr></table>
+ </td></tr>
+ <tr><td>or inside lists, but I believe this liberty gets quickly quite
+ hairy as you see.</td></tr>
+ </table>
+ </li>
+ </ul>
+ <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
+ 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).
+ </warning>
+ <note label="Important">If you want your own labels for notes and
+ warnings, specify them using the <code>label</code> attribute.
+ </note>
+ <p>Apart from unordered lists, we have ordered lists too, of course.</p>
+ <ol>
+ <li>Item 1</li>
+ <li>Item 2</li>
+ <li>This should be 3 if my math is still OK.</li>
+ </ol>
+ </section>
+
+ <section id="presentations">
+ <title>Various presentation formats</title>
+
+ <p>This sample document, written in document-v20 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><a href="sample.html">HTML</a></td>
+
+ <td>This document in HTML format. </td>
+
+ <td>Always generated by default. Cannot be turned off.</td>
+ </tr>
+
+ <tr>
+ <td><a href="sample.xml">XML</a></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><a href="sample.pdf">PDF</a></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><p>This document as straight text.</p>
+ <p>For additional information see the Forrest text-output
+ plugin.</p></td>
+
+ <td><disable-txt-link>. By default, set to true, meaning
+ that this link will not be shown.</td>
+ </tr>
+
+ <tr>
+ <td>POD</td>
+
+ <td><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>
+ <p>For additional information see the Forrest pod-output
+ plugin.</p></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
+ strange historical reason, the section title is an attribute of the
+ <code><section></code> element.</p>
+ </section>
+ <section id="sub-section">
+ <title>Sections, the sequel</title>
+ <p>Just some second section.</p>
+ <section id="sub-sub-section">
+ <title>Section 2.1</title>
+ <p>Which contains a subsection (2.1).</p>
+ </section>
+ </section>
+
+ <section id="source">
+ <title>Showing preformatted source code</title>
+ <p>Enough about these sections. Let's have a look at more interesting
+ elements, <code><source></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 & 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);
+ }
+}</source>
+ <p>CDATA sections are used within
+ <code><source></code> elements so that you can write pointy
+ brackets without needing to escape them with messy
+ <code>&lt;</code> entities ...
+ </p>
+ <source><![CDATA[
+<pointy>
+ easy
+</pointy>
+]]></source>
+ <p>Please take care to still use a sensible line-length within your
+ source elements.</p>
+ </section>
+
+ <section id="table">
+ <title>Using tables</title>
+ <p>And now for a table:</p>
+ <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>
+ <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</li><li>such as lists</li></ul>
+ </td>
+ </tr>
+ </table>
+ </section>
+
+ <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 src="../images/project.png" alt="The fine Forrest logo" width="220" height="65"/>
+ </section>
+ <section id="link-class">
+ <title>Using class attribute on links</title>
+
+ <p>The document-v13 had elements <fork> and <jump>. In
+ document-v20, those elements no longer exist but the functionality can
+ be duplicated by using the @class attribute.
+ Even though the opening of separate windows should be under the
+ control of the user, these techniques can still be employed.</p>
+
+ <table>
+ <tr>
+ <th><p>Document V1.3</p></th>
+
+ <th><p>Document V2.0</p></th>
+ </tr>
+
+ <tr>
+ <td><p><fork href="faq.html"></p></td>
+
+ <td><a class="fork" href="faq.html"><a class="fork"
+ href="faq.html"></a></td>
+ </tr>
+
+ <tr>
+ <td><p><jump href="faq.html"></p></td>
+
+ <td><p><a class="jump" href="faq.html"><a class="jump"
+ href="faq.html"></a></p></td>
+ </tr>
+ </table>
+ </section>
+ </section>
+
+ <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">
+ <title>Changes between document-v13 and document-v20</title>
+ <ul>
+ <li>Renamed <strong><link></strong>
+ to <strong><a></strong>
+ </li>
+ <li>Removed <strong><fork></strong>
+ and <strong><jump></strong> in favour of the
+ <strong><a></strong> element. See demonstration
+ <a href="#link-class">using class attribute on links</a>.
+ </li>
+ </ul>
+ </section>
+ <section id="changes-13">
+ <title>Changes between document-v12 and document-v13</title>
+ <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.
+ </p>
+ </section>
+ <section id="changes-12">
+ <title>Changes between document-v11 and document-v12</title>
+ <p>
+ doc-v12 enhances doc-v11 by relaxing various restrictions that were
+ found to be unnecessary.
+ </p>
+ <ul>
+ <li>
+ Links ((link|jump|fork) and inline elements (br|img|icon|acronym) are
+ allowed inside title.
+ </li>
+ <li>
+ Paragraphs (p|source|note|warning|fixme), table and figure|anchor are
+ allowed inside li.
+ </li>
+ <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).
+ </li>
+ <li>
+ Inline content
+ (strong|em|code|sub|sup|br|img|icon|acronym|link|jump|fork) is
+ allowed in strong and em.
+ </li>
+ </ul>
+ </section>
+ </section>
+ </body>
+ <footer>
+ <legal>This is a legal notice, so it is <strong>important</strong>.</legal>
+ </footer>
+</document>
Propchange: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/sample.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/showonlywhenselected/page1.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/showonlywhenselected/page1.xml?rev=365503&view=auto
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/showonlywhenselected/page1.xml (added)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/showonlywhenselected/page1.xml Mon Jan 2 16:58:27 2006
@@ -0,0 +1,34 @@
+<?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>ShowWhenSelected-Demo, Startpage</title>
+ </header>
+ <body>
+ <section>
+ <title>Always Visible</title>
+ <note>This feature requires the use of the 'scales'-skin. Used in any other skin, both pages will show normally.</note>
+
+ <p>This page is always visible and just another Forrest document.</p>
+ <p>The link below (please read on!) opens the second page of this demo.</p>
+ <p>It is also referenced in site.xml, but, because if the type-attribute "showWhenSelected", it will not
+ normally appear on the menu. Unless you follow the <a href="page2.html">link</a> and select it.</p>
+ </section>
+ </body>
+</document>
Propchange: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/showonlywhenselected/page1.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/showonlywhenselected/page2.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/showonlywhenselected/page2.xml?rev=365503&view=auto
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/showonlywhenselected/page2.xml (added)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/showonlywhenselected/page2.xml Mon Jan 2 16:58:27 2006
@@ -0,0 +1,32 @@
+<?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>ShowWhenSelected-Demo, Linked Page</title>
+ </header>
+ <body>
+ <section>
+ <title>Conditionally visible</title>
+ <note>This feature requires the use of the 'scales'-skin. Used in any other skin, both pages will show normally.</note>
+ <p>This page will only become visible on the menu when it is already the current page. Since it doesn't normally
+ appear on the menu, this can only happen, if you link to it from another page or from another site.</p>
+ <p>Open another page by menu-selection or follwing a <a href="page1.html">link</a> to make this page disappear from this menu.</p>
+ </section>
+ </body>
+</document>
Propchange: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/showonlywhenselected/page2.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/static.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/static.xml?rev=365503&view=auto
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/static.xml (added)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/static.xml Mon Jan 2 16:58:27 2006
@@ -0,0 +1,62 @@
+<?xml version="1.0"?>
+<!--
+ 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>Static content - including raw un-processed files and documents</title>
+ </header>
+ <body>
+ <section>
+ <title>Linking to static content</title>
+ <p>
+ You can place some types of raw content into the xdocs directory. For example,
+ you can place a PDF file in <code>src/documentation/content/xdocs</code> and link
+ to it normally,
+ <strong><a href="../hello.pdf"></strong><a href="../hello.pdf">hello.pdf</a><strong></a></strong>
+ However, note that if the file is one that Forrest is able to process, for example
+ an HTML file, these files will be processed accordingly.</p>
+
+ <p>
+ It is also worth noting that files in the xdocs directory will only be copied
+ into your final site if there is a link to them somewhere in the site. See the next
+ section for details of how to include content that is not linked.</p>
+
+ <p>
+ For more information see the
+ <a href="site:linking">Linking demonstration</a>.</p>
+ </section>
+
+ <section>
+ <title>Including Static Content that is Not Linked</title>
+
+ <p>
+ You can include raw HTML, PDFs, plain-text, and other files. In your final site by
+ placing them in the <code>src/documentation/content</code> directory. Files in this
+ directory will be copied over automatically but will not be processed in any way by
+ Forrest, that is they will be linked to as raw files.</p>
+
+ <p>
+ You can also have sub-directories such as
+ <code>src/documentation/content/samples/subdir/</code> which
+ reflects your main
+ <code>xdocs/</code> tree. The raw files will then end up
+ beside your documents.
+ </p>
+ </section>
+ </body>
+</document>
Propchange: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/static.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/subdir/book-sample.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/subdir/book-sample.xml?rev=365503&view=auto
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/subdir/book-sample.xml (added)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/subdir/book-sample.xml Mon Jan 2 16:58:27 2006
@@ -0,0 +1,47 @@
+<?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 book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "http://forrest.apache.org/dtd/book-cocoon-v10.dtd">
+
+<!-- Sample book.xml file. If this file is renamed to 'book.xml', it will be
+used to define the menu in this subdirectory, instead of that generated from
+the usual site.xml mechanism. The normal relative and absolute hrefs are also
+available. -->
+
+<book software="MyProj"
+ title="MyProj"
+ copyright="@year@ The Apache Software Foundation"
+ xmlns:xlink="http://www.w3.org/1999/xlink">
+
+ <menu label="About">
+ <!-- using the normal site.xml linking mechanism -->
+ <menu-item label="Index" href="site:index"/>
+ <!-- using relative URIs with relative path -->
+ <menu-item label="Sample page" href="../sample.html"/>
+ <!-- using relative URIs with absolute path -->
+ <menu-item label="Sample ihtml page" href="/samples/ihtml-sample.html"/>
+ <!-- using the normal site.xml linking mechanism -->
+ <menu-item label="FAQ" href="site:faq"/>
+ <menu-item label="Changes" href="site:changes"/>
+ <menu-item label="Todo" href="site:todo"/>
+ </menu>
+
+ <menu label="Subdir">
+ <menu-item label="index" href="site:subdir/index"/>
+ </menu>
+
+</book>
Propchange: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/subdir/book-sample.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/subdir/hello.zip
URL: http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/subdir/hello.zip?rev=365503&view=auto
==============================================================================
Binary file - no diff available.
Propchange: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/subdir/hello.zip
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/subdir/index.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/subdir/index.xml?rev=365503&view=auto
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/subdir/index.xml (added)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/subdir/index.xml Mon Jan 2 16:58:27 2006
@@ -0,0 +1,38 @@
+<?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>Page generated from a sub-directory</title>
+
+ <authors>
+ <person name="Joe Bloggs" email="joe@joescompany.org" />
+ </authors>
+ </header>
+
+ <body>
+ <section>
+ <title>A sub-directory</title>
+ <p>This was generated from a sub-directory.</p>
+ <p>When creating new subdirectories, remember that these <em>must</em>
+ be declared in site.xml or each directory must have a book.xml file.
+ </p>
+ </section>
+ </body>
+</document>
+
Propchange: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/subdir/index.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/test-toc.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/test-toc.xml?rev=365503&view=auto
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/test-toc.xml (added)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/test-toc.xml Mon Jan 2 16:58:27 2006
@@ -0,0 +1,41 @@
+<?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>test-toc page</title>
+ </header>
+ <body>
+ <section id="overview">
+ <title>test-toc</title>
+ <p>This page shows the test-toc.</p>
+ </section>
+ <section>
+ <title>test1 space</title>
+ <p>just a test1</p>
+ </section>
+ <section >
+ <title>test2</title>
+ <p>just a test2a</p>
+ </section>
+ <section >
+ <title>test2</title>
+ <p>just a test2b</p>
+ </section>
+ </body>
+</document>
Propchange: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/test-toc.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/usemap.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/usemap.xml?rev=365503&view=auto
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/usemap.xml (added)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/usemap.xml Mon Jan 2 16:58:27 2006
@@ -0,0 +1,61 @@
+<?xml version="1.0"?>
+<!--
+ 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>Interactive client-side imagemaps - the usemap attribute</title>
+ </header>
+ <body>
+ <section id="demo">
+ <title>Imagemap demo</title>
+ <p>
+ <img src="/images/usemap.gif" usemap="#my-map"
+ alt="usemap demo" width="256" height="256"/>
+ </p>
+ <p>
+ <map name="my-map">
+ <area shape="rect" coords="173,14,240,71"
+ alt="Rectangle" href="ext:forrest"/>
+ <area shape="circle" coords="53,172,28"
+ alt="Circle" href="../index.html"/>
+ <area shape="default" coords="0,0.256,256"
+ alt="Default" href="http://www.apache.org"/>
+ </map>
+ </p>
+ </section>
+ <section id="source">
+ <title>Source code</title>
+ <source><![CDATA[
+ <p>
+ <img src="/images/usemap.gif" usemap="#my-map"
+ alt="usemap demo" width="256" height="256"/>
+ </p>
+ <p>
+ <map name="my-map">
+ <area shape="rect" coords="173,14,240,71"
+ alt="Rectangle" href="ext:forrest"/>
+ <area shape="circle" coords="53,172,28"
+ alt="Circle" href="../index.html"/>
+ <area shape="default" coords="0,0.256,256"
+ alt="Default" href="http://www.apache.org"/>
+ </map>
+ </p>
+]]></source>
+ </section>
+ </body>
+</document>
Propchange: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/usemap.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/xml-entities.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/xml-entities.xml?rev=365503&view=auto
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/xml-entities.xml (added)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/xml-entities.xml Mon Jan 2 16:58:27 2006
@@ -0,0 +1,82 @@
+<?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" [
+<!ENTITY % symbols-project
+ PUBLIC "-//Apache Forrest//ENTITIES Symbols Project v1.0//EN"
+ "symbols-project-v10.ent">
+ %symbols-project;
+]>
+<document>
+ <header>
+ <title>Using XML entities for character replacements</title>
+ </header>
+ <body>
+ <p>
+ All of the normal xml character entities are available for use
+ in your source documents.
+ So you can use "<code>&trade;</code>"
+ for the trademark symbol (™)
+ and use "<code>&ouml;</code>"
+ for special accents (ö).
+ </p>
+ <p>
+ Forrest also has some default sets of symbols. There is one set
+ for the core of Forrest. These are automatically available
+ for use in the "document-v*" series of document types.
+ (If you want to use them in another document type, then you
+ need to specify them in the document type declaration of your
+ xml instance documents or in your custom DTD. See below.)
+ </p>
+ <p>
+ For example,
+ use "<code>&for-s;</code>" to represent the strong
+ text string "&for-s;". See the list of available symbols at
+ <code>main/webapp/resources/schema/entity/symbols-core-v10.ent</code>
+ which shows that that example entity was declared as
+ <code><![CDATA[<strong>Apache Forrest</strong>]]></code>.
+ </p>
+ <p>
+ You can supply lists of symbols for your own project too.
+ Create a fresh site with 'forrest seed' and see the set
+ <code>src/documentation/resources/schema/symbols-project-v10.ent</code>
+ </p>
+ <p>
+ For example,
+ use "<code>&myp-t;</code>" to represent the project name
+ together with trademark symbol "&myp-t;".
+ </p>
+ <p>
+ The set of project symbols is already configured. To use the symbols
+ in your documents, add to the document type declaration. For example,
+ see the source for this document
+ (<code>src/documentation/content/xdocs/samples/xml-entites.xml</code>)
+ which declares the project symbol set ...
+ </p>
+ <source><![CDATA[
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd" [
+<!ENTITY % symbols-project
+ PUBLIC "-//Apache Forrest//ENTITIES Symbols Project v1.0//EN"
+ "symbols-project-v10.ent">
+ %symbols-project;
+]>
+<document>
+ ...
+]]></source>
+ </body>
+</document>
Propchange: forrest/trunk/whiteboard/plugins/org.apache.forrest.theme.Coat/src/documentation/content/xdocs/samples/xml-entities.xml
------------------------------------------------------------------------------
svn:eol-style = native