You are viewing a plain text version of this content. The canonical link for it is here.
Posted to fx-dev@ws.apache.org by di...@apache.org on 2004/02/19 18:32:05 UTC
cvs commit: ws-fx/src/documentation/resources/images group-logo.gif icon.png images.jpeg project-logo.gif project-logo.jpg wsfx.png
dims 2004/02/19 09:32:05
Added: . .cvsignore forrest-targets.ent forrest.properties
status.xml
src/documentation README.txt skinconf.xml
src/documentation/content hello.pdf test1.html test2.html
src/documentation/content/xdocs cvs.xml index.xml mail.xml
news.xml site.xml tabs.xml
src/documentation/content/xdocs/samples ehtml-sample.ehtml
faq.xml ihtml-sample.ihtml index.xml sample.xml
sample2.xml sdocbook.xml wiki-sample.cwiki
src/documentation/content/xdocs/samples/subdir
book-sample.xml index.xml
src/documentation/resources/images group-logo.gif icon.png
images.jpeg project-logo.gif project-logo.jpg
wsfx.png
Log:
remove unnecessary mailing lists and add some forrest files.
Revision Changes Path
1.1 ws-fx/.cvsignore
Index: .cvsignore
===================================================================
build
1.1 ws-fx/forrest-targets.ent
Index: forrest-targets.ent
===================================================================
<!--
This build.xml snippet contains Forrest targets for Ant 1.5+. It checks that
the user has set ${forrest.home}, either in one of:
build.properties
project.properties
ant.properties
.ant.properties
or with the FORREST_HOME environment variable, and prints an informative error
message if not found.
Usage:
1) Copy this file to somewhere in your project.
2) Add the following to the top of your project's Ant build.xml script
(adjusting the path):
<!DOCTYPE project [
<!ENTITY forrest-targets SYSTEM "file:./forrest-targets.ent">
]>
3) Before the closing '</project>' in your build.xml, add this:
&forrest-targets;
This is like expanding a macro: it pulls in the contents of this file.
A minimal build.xml would thus be:
<!DOCTYPE project [
<!ENTITY forrest-targets SYSTEM "file:./forrest-targets.ent">
]>
<project default="site">
&forrest-targets;
</project>
-->
<target name="site" depends="forrest.init" description="Generates static HTML documentation">
<ant antfile="${forrest.home}/forrest.antproxy.xml" target="site"/>
</target>
<target name="webapp" depends="forrest.init" description="Generates an unpackaged webapp of the website">
<ant antfile="${forrest.home}/forrest.antproxy.xml" target="webapp"/>
</target>
<target name="war" depends="forrest.init" description="Generates a .war file containing the website">
<ant antfile="${forrest.home}/forrest.antproxy.xml" target="war"/>
</target>
<target name="validate" depends="forrest.init" description="Validates XML documentation files">
<ant antfile="${forrest.home}/forrest.antproxy.xml" target="validate"/>
</target>
<target name="forrest.init" depends="forrest.sethome, forrest.home.defined"/>
<target name="forrest.sethome" depends="forrest.loadenv,
forrest.checkenv, forrest.checkhome, forrest.check-build.properties,
forrest.check-project.properties, forrest.check-ant.properties,
forrest.check-.ant.properties"/>
<target name="forrest.loadenv" unless="forrest.home.present">
<property environment="env"/>
<echo level="verbose">Forrest: Got ${env.FORREST_HOME}</echo>
</target>
<target name="forrest.checkenv" if="env.FORREST_HOME">
<echo level="verbose">Found $FORREST_HOME..</echo>
<property name="forrest.home" location="${env.FORREST_HOME}"/>
<echo level="verbose">forrest.home set to ${forrest.home}</echo>
<available file="${forrest.home}" type="dir" property="forrest.home.present"/>
</target>
<target name="forrest.checkhome">
<available file="${forrest.home}" type="dir" property="forrest.home.present"/>
<available file="build.properties" type="file" property="build.properties.present"/>
<available file="project.properties" type="file" property="project.properties.present"/>
<available file="ant.properties" type="file" property="ant.properties.present"/>
<available file=".ant.properties" type="file" property=".ant.properties.present"/>
</target>
<!-- No we can't extract the commonalities below into an antcall'ed target,
because it wouldn't be able to set forrest.home -->
<target name="forrest.check-build.properties" unless="forrest.home.present"
if="build.properties.present">
<echo level="verbose">Forrest: Checking build.properties..</echo>
<loadproperties srcfile="build.properties">
<filterchain>
<linecontains>
<contains value="forrest.home"/>
</linecontains>
</filterchain>
</loadproperties>
<available file="${forrest.home}" type="dir" property="forrest.home.present"/>
</target>
<target name="forrest.check-project.properties" unless="forrest.home.present"
if="project.properties.present">
<echo level="verbose">Forrest: Checking project.properties..</echo>
<loadproperties srcfile="project.properties">
<filterchain>
<linecontains>
<contains value="forrest.home"/>
</linecontains>
</filterchain>
</loadproperties>
<available file="${forrest.home}" type="dir" property="forrest.home.present"/>
</target>
<target name="forrest.check-ant.properties" unless="forrest.home.present"
if="ant.properties.present">
<echo level="verbose">Forrest: Checking ant.properties..</echo>
<loadproperties srcfile="ant.properties">
<filterchain>
<linecontains>
<contains value="forrest.home"/>
</linecontains>
</filterchain>
</loadproperties>
<available file="${forrest.home}" type="dir" property="forrest.home.present"/>
</target>
<target name="forrest.check-.ant.properties" unless="forrest.home.present"
if=".ant.properties.present">
<echo level="verbose">Forrest: Checking .ant.properties..</echo>
<loadproperties srcfile=".ant.properties">
<filterchain>
<linecontains>
<contains value="forrest.home"/>
</linecontains>
</filterchain>
</loadproperties>
<available file="${forrest.home}" type="dir" property="forrest.home.present"/>
</target>
<target name="forrest.home.defined" depends="forrest.sethome" unless="forrest.home.present">
<property name="path" value="${user.home}/xml-forrest/build/dist/shbat"/>
<pathconvert targetos="windows" property="winpath">
<path>
<pathelement location="${path}"/>
</path>
</pathconvert>
<pathconvert targetos="unix" property="unixpath">
<path>
<pathelement
location="${path}"/>
</path>
</pathconvert>
<echo>
----------------------------------------------
To run this target, you need Forrest installed.
Please do the following:
export CVSROOT=:pserver:anoncvs@cvs.apache.org:/home/cvspublic
cvs checkout xml-forrest
cd xml-forrest
build (Windows)
./build.sh (Unix)
Then either:
- Set FORREST_HOME as the Forrest build instructions describe
- Create a build.properties, with the forrest.home property pointing to
the forrest shbat directory, eg:
forrest.home=${winpath} (Windows)
forrest.home=${unixpath} (Unix)
(adjusting the path according to where your xml-forrest is)
----------------------------------------------
</echo>
<fail message="Need to define $${forrest.home}"/>
</target>
1.1 ws-fx/forrest.properties
Index: forrest.properties
===================================================================
##############
# Properties used by forrest.build.xml for building the website
##############
# Prints out a summary of Forrest settings for this project
#forrest.echo=true
# Project name (used to name .war file)
#project.name=my-project
# Specifies name of Forrest skin to use
#project.skin=forrest-site
#project.skin=avalon-tigris
project.skin=ws-site
##############
# layout properties
# Properties that must be set to override the default locations
#
# Parent properties must be set. This usually means uncommenting
# project.content-dir if any other property using it is uncommented
#project.status=status.xml
#project.content-dir=src/documentation
#project.conf-dir=${project.content-dir}/conf
#project.sitemap=${project.content-dir}/sitemap.xmap
#project.xdocs-dir=${project.content-dir}/content/xdocs
#project.stylesheets-dir=${project.content-dir}/resources/stylesheets
#project.images-dir=${project.content-dir}/resources/images
#project.schema-dir=${project.content-dir}/resources/schema
project.skins-dir=../ws-site/src/documentation/skins
#project.skinconf=${project.content-dir}/skinconf.xml
#project.lib-dir=${project.content-dir}/lib
#project.classes-dir=${project.content-dir}/classes
##############
# Cocoon catalog entity resolver properties
# A local catalog to supplement the default Forrest catalog
#project.catalog=${project.schema-dir}/catalog
# The verbosity level for the entity resolver (1..10)
#forrest.catalog.verbosity=1
##############
# validation properties
# These props determine if validation is performed at all
# Values are inherited unless overridden.
# Eg, if forrest.validate=false, then all others are false unless set to true.
#forrest.validate=true
#forrest.validate.xdocs=${forrest.validate}
#forrest.validate.skinconf=${forrest.validate}
#forrest.validate.sitemap=${forrest.validate}
#forrest.validate.stylesheets=${forrest.validate}
#forrest.validate.skins=${forrest.validate}
#forrest.validate.skins.stylesheets=${forrest.validate.skins}
# Key:
# *.failonerror=(true|false) stop when an XML file is invalid
# *.includes=(pattern) Comma-separated list of path patterns to validate
# *.excludes=(pattern) Comma-separated list of path patterns to not validate
#forrest.validate.failonerror=true
#forrest.validate.includes=**/*
#forrest.validate.excludes=
#
#forrest.validate.xdocs.failonerror=${forrest.validate.failonerror}
#
#forrest.validate.xdocs.includes=**/*.x*
#forrest.validate.xdocs.excludes=site.xml
#
#forrest.validate.skinconf.includes=${skinconf-file}
#forrest.validate.skinconf.excludes=
#forrest.validate.skinconf.failonerror=${forrest.validate.failonerror}
#
#forrest.validate.sitemap.includes=${sitemap-file}
#forrest.validate.sitemap.excludes=
#forrest.validate.sitemap.failonerror=${forrest.validate.failonerror}
#
#forrest.validate.stylesheets.includes=**/*.xsl
#forrest.validate.stylesheets.excludes=
#forrest.validate.stylesheets.failonerror=${forrest.validate.failonerror}
#
#forrest.validate.skins.includes=**/*
#forrest.validate.skins.excludes=**/*.xsl
#forrest.validate.skins.failonerror=${forrest.validate.failonerror}
#
#forrest.validate.skins.stylesheets.includes=**/*.xsl
#forrest.validate.skins.stylesheets.excludes=
#forrest.validate.skins.stylesheets.failonerror=${forrest.validate.skins.failonerror}
1.1 ws-fx/status.xml
Index: status.xml
===================================================================
<?xml version="1.0"?>
<status>
<developers>
<person name="Joe Bloggs" email="joe@joescompany.org" id="JB" />
<!-- Add more people here -->
</developers>
<changes>
<!-- Add new releases here -->
<release version="0.1" date="unreleased">
<!-- Some action types have associated images. By default, images are
defined for 'add', 'fix', 'remove', 'update' and 'hack'. If you add
src/documentation/resources/images/<foo>.jpg images, these will
automatically be used for entries of type <foo>. -->
<action dev="JB" type="add" context="admin">
Initial Import
</action>
<!-- Sample action:
<action dev="JB" type="fix" due-to="Joe Contributor"
due-to-email="joec@apache.org" fixes-bug="123">
Fixed a bug in the Foo class.
</action>
-->
</release>
</changes>
<todo>
<actions priority="high">
<action context="docs" dev="JB">
Customize this template project with your project's details. This
TODO list is generated from 'status.xml'.
</action>
<action context="docs" dev="JB">
Add lots of content. XML content goes in
<code>src/documentation/content/xdocs</code>, or wherever the
<code>${project.xdocs-dir}</code> property (set in
<code>forrest.properties</code>) points.
</action>
<action context="feedback" dev="JB">
Mail <link
href="mailto:forrest-dev@xml.apache.org">forrest-dev@xml.apache.org</link>
with feedback.
</action>
</actions>
<!-- Add todo items. @context is an arbitrary string. Eg:
<actions priority="high">
<action context="code" dev="SN">
</action>
</actions>
<actions priority="medium">
<action context="docs" dev="open">
</action>
</actions>
-->
</todo>
</status>
1.1 ws-fx/src/documentation/README.txt
Index: README.txt
===================================================================
This is the base documentation directory. It usually contains two files:
skinconf.xml # This file customizes Forrest for your project. In it, you
# tell forrest the project name, logo, copyright info, etc
sitemap.xmap # Optional. This sitemap overrides the default one bundled
# with Forrest. Typically, one would copy a sitemap from
# xml-forrest/src/resources/conf/sitemap.xmap, and customize
# it.
1.1 ws-fx/src/documentation/skinconf.xml
Index: skinconf.xml
===================================================================
<?xml version="1.0"?>
<!--
Skin configuration file. This file contains details of your project, which will
be used to configure the chosen Forrest skin.
-->
<!DOCTYPE skinconfig [
<!ENTITY % links.att 'name CDATA #REQUIRED'>
<!ENTITY % link.att 'name CDATA #REQUIRED href CDATA #REQUIRED'>
<!ELEMENT skinconfig (disable-lucene?, disable-search?, disable-print-link?, disable-pdf-link?,
disable-xml-link?, disable-compliance-links?, obfuscate-mail-links?, searchsite-domain?, searchsite-name?,
project-name, project-description?, project-url, project-logo, group-name?, group-description?, group-url?, group-logo?,
host-url?, host-logo?, year?, vendor?, trail?, toc?, credits?)*>
<!ELEMENT credits (credit*)>
<!ELEMENT credit (name, url, image?, width?, height?)>
<!-- id uniquely identifies the tool, and role indicates its function -->
<!ATTLIST credit id CDATA #IMPLIED
role CDATA #IMPLIED>
<!ELEMENT disable-lucene (#PCDATA)>
<!ELEMENT disable-search (#PCDATA)>
<!ELEMENT disable-print-link (#PCDATA)>
<!ELEMENT disable-pdf-link (#PCDATA)>
<!ELEMENT disable-xml-link (#PCDATA)>
<!ELEMENT disable-compliance-links (#PCDATA)>
<!ELEMENT obfuscate-mail-links (#PCDATA)>
<!ELEMENT searchsite-domain (#PCDATA)>
<!ELEMENT searchsite-name (#PCDATA)>
<!ELEMENT project-name (#PCDATA)>
<!ELEMENT project-description (#PCDATA)>
<!ELEMENT project-url (#PCDATA)>
<!ELEMENT project-logo (#PCDATA)>
<!ELEMENT group-name (#PCDATA)>
<!ELEMENT group-description (#PCDATA)>
<!ELEMENT group-url (#PCDATA)>
<!ELEMENT group-logo (#PCDATA)>
<!ELEMENT host-url (#PCDATA)>
<!ELEMENT host-logo (#PCDATA)>
<!ELEMENT year (#PCDATA)>
<!ELEMENT vendor (#PCDATA)>
<!ELEMENT trail (link1, link2, link3)>
<!ELEMENT link1 EMPTY>
<!-- Seems we can't use param entity refs until this is DTDified -->
<!ATTLIST link1 name CDATA #REQUIRED href CDATA #IMPLIED>
<!ELEMENT link2 EMPTY>
<!ATTLIST link2 name CDATA #REQUIRED href CDATA #IMPLIED>
<!ELEMENT link3 EMPTY>
<!ATTLIST link3 name CDATA #REQUIRED href CDATA #IMPLIED>
<!ELEMENT name (#PCDATA)>
<!ELEMENT url (#PCDATA)>
<!ELEMENT image (#PCDATA)>
<!ELEMENT width (#PCDATA)>
<!ELEMENT height (#PCDATA)>
<!ELEMENT toc EMPTY>
<!ATTLIST toc level CDATA #IMPLIED>
]>
<skinconfig>
<!-- Do we want to disable the Lucene search box? -->
<disable-lucene>true</disable-lucene>
<!-- Do we want to disable the Google search box? -->
<disable-search>false</disable-search>
<!-- Do we want to disable the print link? If enabled, invalid HTML 4.0.1 -->
<disable-print-link>false</disable-print-link>
<!-- Do we want to disable the PDF link? -->
<disable-pdf-link>false</disable-pdf-link>
<!-- Do we want to disable the xml source link? -->
<disable-xml-link>true</disable-xml-link>
<!-- Do we want to disable w3c compliance links? -->
<disable-compliance-links>false</disable-compliance-links>
<!-- Whether to render mailto: links unrecognisable by spam harvesters -->
<obfuscate-mail-links>false</obfuscate-mail-links>
<!-- Do we want to disable the Google search box? -->
<disable-search>false</disable-search>
<searchsite-domain>ws.apache.org</searchsite-domain>
<searchsite-name>Web Services</searchsite-name>
<!-- mandatory project logo
skin: forrest-site renders it at the top -->
<project-name>Web Services FX</project-name>
<project-url>http://ws.apache.org/ws-fx/</project-url>
<project-logo>images/wsfx.png</project-logo>
<!-- optional group logo
skin: forrest-site renders it at the top-left corner -->
<group-name>Web Services</group-name>
<group-url>http://ws.apache.org/</group-url>
<group-logo>images/group-logo.gif</group-logo>
<!-- optional host logo (e.g. sourceforge logo)
skin: forrest-site renders it at the bottom-left corner -->
<host-url></host-url>
<host-logo></host-logo>
<!-- The following are used to construct a copyright statement -->
<year>2003-2004</year>
<vendor>The Apache Software Foundation.</vendor>
<!-- Some skins use this to form a 'breadcrumb trail' of links. If you don't
want these, set the attributes to blank. The DTD purposefully requires them.
-->
<trail>
<link1 name="apache" href="http://www.apache.org/"/>
<link2 name="ws.apache" href="http://ws.apache.org/"/>
<link3 name="ws-fx" href="http://ws.apache.org/ws-fx/"/>
<link4 name="" href=""/>
</trail>
<!-- Credits are typically rendered as a set of small clickable images in the
page footer -->
<credits>
<credit>
<name>Built with Apache Forrest</name>
<url>http://xml.apache.org/forrest/</url>
<image>images/built-with-forrest-button.png</image>
<width>88</width>
<height>31</height>
</credit>
<!-- A credit with @role='pdf' will have its name and url displayed in the
PDF page's footer. -->
</credits>
</skinconfig>
1.1 ws-fx/src/documentation/content/hello.pdf
<<Binary file>>
1.1 ws-fx/src/documentation/content/test1.html
Index: test1.html
===================================================================
<html>
<body>
<h1>Test HTML page</h1>
<p>
This raw HTML page is linked to from xdocs/sample2.xml.
</p>
<p>All linked-to pages, like <a href="test2.html">this one</a>, are
also available.
<hr />
[<a href="index.html">Index</a>]
</body>
</html>
1.1 ws-fx/src/documentation/content/test2.html
Index: test2.html
===================================================================
<html>
<h1>Test 2</h1>
<p>
A linked-to-from-HTML page.
<hr />
[<a href="index.html">Index</a>] [<a href="test1.html">test1.html</a>]
</p>
</html>
1.1 ws-fx/src/documentation/content/xdocs/cvs.xml
Index: cvs.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
<document>
<header>
<title>CVS Repositories</title>
</header>
<body>
<section>
<title>Web Access to the Repository</title>
<p>You can browse the ws.apache.org workspaces via the web.
</p>
<ul>
<li>
<link href="ext:viewcvs/axis">ws-axis</link>
</li>
<li>
<link href="ext:viewcvs/wsfx">ws-fx</link>
</li>
<li>
<link href="ext:viewcvs/jaxme">ws-jaxme</link>
</li>
<li>
<link href="ext:viewcvs/juddi">ws-juddi</link>
</li>
<li>
<link href="ext:viewcvs/site">ws-site</link>
</li>
<li>
<link href="ext:viewcvs/soap">ws-soap</link>
</li>
<li>
<link href="ext:viewcvs/wsif">ws-wsif</link>
</li>
<li>
<link href="ext:viewcvs/wsil">ws-wsil</link>
</li>
<li>
<link href="ext:viewcvs/wsrp4j">ws-wsrp4j</link>
</li>
<li>
<link href="ext:viewcvs/xmlrpc">ws-xmlrpc</link>
</li>
</ul>
</section>
<section>
<title>Download the Source</title>
<p> Most users of the source code probably don't need to have day to day access to
the source code as it changes. For these users we provide easy to unpack source
code downloads via our download pages.
</p>
</section>
<section>
<title>Access the Source Tree</title>
<p>
So, you've decided that you need access to the source tree to see the latest and
greatest code. There's two different forms of CVS access. The first is anonymous
and anybody can use it. The second is not and you must have a login to the
development server. If you don't know what this means, join the mailing list and find
out.
</p>
<section>
<title>AnonCVS</title>
<p> Anyone can checkout source code from our anonymous CVS server. To do so,
simply use the following commands (if you are using a GUI CVS client, configure it
appropriately):
</p>
<source>cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic
login
password: anoncvs
cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic
checkout [module-name]</source>
<p>
Modules available for access are:
</p>
<ul>
<li>ws-site</li>
<li>ws-axis</li>
<li>ws-wsif</li>
<li>ws-wsil</li>
<li>ws-xmlrpc</li>
<li>ws-soap</li>
<li>ws-wsrp4j</li>
<li>ws-jaxme</li>
<li>ws-juddi</li>
</ul>
<p>(Old Module Names)</p>
<ul>
<li>xml-axis</li>
<li>xml-axis-wsif</li>
<li>xml-axis-wsil</li>
<li>xml-rpc</li>
<li>xml-soap</li>
</ul>
</section>
</section>
<section>
<title>Other Ways to Access the Source Code</title>
<p>
For some, using CVS pserver might not be enough. You can access the
ws.apache.org source modules via CVSup or Rsync. For more information about
how to use these tools with the Apache CVS tree,
see the <link href="http://www.apache.org/info/how-to-mirror.html">Apache Mirroring Document</link>.</p>
</section>
</body>
</document>
1.1 ws-fx/src/documentation/content/xdocs/index.xml
Index: index.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://apache.org/forrest/dtd/document-v12.dtd">
<document>
<header>
<title>Welcome to WSFX</title>
</header>
<body>
<section>
<title>Welcome</title>
<p>The Web services project currently targets the lower end of the
Web Services stack with SOAP, UDDI etc. We need to move up the chain
to provide toolkits that support additional functionality as specified
for example in the [WS-* specifications] .A Web Service FX (Functionality Extensions)
subproject is proposed to accelerate and guide this process.</p>
</section>
<section>
<title>Sub Projects</title>
<ul>
<li><link href="ext:addressing">Addressing</link> - An implementation of WS-Addressing Specification</li>
<li><link href="ext:sandesha">Sandesha</link> - An implementation of WS-ReliableMessaging Specification</li>
<li><link href="ext:wss4j">WSS4J</link> - An implementation of WS-Security Specification</li>
</ul>
</section>
<section>
<title>Scope of the WSFX</title>
<p>The subproject shall create and maintain implementations for web
services specifications written in various languages, including Java
and C/C++, intended for use in conjunction with one or more ws.apache.org
projects. These components will be designed to be used independently of
any larger product or framework, and will pertain directly to web services
standards. Each package will be managed in the same manner as a larger Web
services product. To further this goal, the subproject shall also host a
workplace for Web services committers and a master index of reusable packages
related to Web services products.</p>
</section>
<section>
<title>Members</title>
<ul>
<li><link href="mailto:gdaniels.at.apache.org">Glen Daniels</link></li>
<li><link href="mailto:susantha.at.opensource.lk">Susantha Kumara</link></li>
<li><link href="mailto:srinath.at.opensource.lk">Srinath Perera</link></li>
<li><link href="mailto:dims.at.yahoo.com">Davanum Srinivas</link></li>
<li><link href="mailto:sanjiva.at.opensource.lk">Sanjiva Weerawarana</link></li>
</ul>
</section>
</body>
</document>
1.1 ws-fx/src/documentation/content/xdocs/mail.xml
Index: mail.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
<document>
<header>
<title>Mailing Lists</title>
</header>
<body>
<p>
Every volunteer project obtains its strength from the people involved in
it. Mailing lists provide a simple and effective communication
mechanism.
</p>
<p>
You are welcome to join any of these mailing lists (or all of them if
you wish). You can choose to lurk, or actively participate. It's up to
you. Before you join these lists, you should look over the resources in
the Reference Library section. As with any mailing list, you should
probably read any FAQ postings or simply read a sampling of postings
on the list before posting your first question.
</p>
<section>
<title>Usage Notes</title>
<p>
Archives are generally named after the project they're about (duh!)
with a suffix that denotes the subjects covered. Common suffixes are:
<br/>
<code>*-dev</code> Developer list - for technical questions about
the product, code patches, bug submissions about advanced functionality, etc.
<br/>
<code>*-user, *-users</code> Users list - for general usage questions
about the product from an end-users perspective
<br/>
<code>*-cvs</code> CVS commit list - this is a read-only list that
sends out email with details of all checkins to that project's CVS repository
</p>
<p>
The ezmlm mailing list controller accepts commands by sending emails
to <code>listname-command</code>, generally like the following:
<br/>
<code>*-subscribe</code> Subscribe your current email address to the list
<br/>
<code>*-unsubscribe</code> UnSubscribe your *current* email address from the list
<br/>
<code>*-help</code> get Help on mailing list commands
</p>
</section>
<section>
<title>Public archives</title>
<p>
Archives of many of the most popular ws.apache.org mailing lists
are kept at <link href="http://marc.theaimsgroup.com/">http://marc.theaimsgroup.com/</link>,
which are organized by month and include search features for both subjects
and message text. Many lists are also archived by other large
mailing list archive sites as well.
</p>
<p>
All the mailing lists are also archived at
<link href="http://ws.apache.org/mail/">http://ws.apache.org/mail/</link>
</p>
</section>
<section>
<title>The WS-FX Developers List</title>
<p>
<em>Medium Traffic</em>
<link href="mailto:fx-dev-subscribe@ws.apache.org">Subscribe</link>
<link href="mailto:fx-dev-unsubscribe@ws.apache.org">Unsubscribe</link>
<link href="http://ws.apache.org/mail/fx-dev/">MBOX Archive</link>
</p>
<p>
This is the list for everyone interested and involved with the active
development of WS-FX and its sub projects.
</p>
</section>
</body>
</document>
1.1 ws-fx/src/documentation/content/xdocs/news.xml
Index: news.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
<document>
<header>
<title>News</title>
</header>
<body>
<section>
<title>Updated website with WS-FX, WSS4J, Addressing, Sandesha</title>
<p>19th February 2003 - See <link href="ext:wsfx">WSFX</link>, <link href="ext:addressing">WSFX/Addressing</link>,
<link href="ext:sandesha">WSFX/Sandesha (Under Incubation)</link>, <link href="ext:wss4j">WSFX/WSS4J</link></p>
</section>
</body>
</document>
1.1 ws-fx/src/documentation/content/xdocs/site.xml
Index: site.xml
===================================================================
<?xml version="1.0"?>
<!--
Forrest site.xml
This file contains an outline of the site's information content. It is used to:
- Generate the website menus (though these can be overridden - see docs)
- Provide semantic, location-independent aliases for internal 'site:' URIs, eg
<link href="site:changes"> links to changes.html (or ../changes.html if in
subdir).
- Provide aliases for external URLs in the external-refs section. Eg, <link
href="ext:cocoon"> links to http://xml.apache.org/cocoon/
See http://xml.apache.org/forrest/linking.html for more info
-->
<site label="MyProj" href="" xmlns="http://apache.org/forrest/linkmap/1.0" tab="">
<external-refs>
<xml.apache.org href="http://xml.apache.org/">
<forrest href="forrest/"/>
</xml.apache.org>
<cocoon href="http://cocoon.apache.org/"/>
<ant href="http://ant.apache.org/"/>
<incubator href="http://incubator.apache.org/"/>
<ws.apache.org href="http://ws.apache.org/">
<mirrors href="mirrors.cgi"/>
<axis href="axis/"/>
<wsfx href="ws-fx/"/>
<jaxme href="jaxme/"/>
<juddi href="juddi/"/>
<soap href="soap/"/>
<wsif href="wsif/"/>
<wsrp4j href="wsrp4j/"/>
<xmlrpc href="xmlrpc/"/>
<addressing href="ws-fx/addressing/"/>
<sandesha href="ws-fx/sandesha/index.htm"/>
<wss4j href="ws-fx/wss4j/"/>
<asl href="LICENSE.txt"/>
</ws.apache.org>
<cvs.apache.org href="http://cvs.apache.org/">
<wsil href="viewcvs/*checkout*/ws-wsil/java/README.htm"/>
<viewcvs href="viewcvs/">
<axis href="ws-axis/"/>
<wsfx href="ws-fx/"/>
<jaxme href="ws-jaxme/"/>
<juddi href="ws-juddi/"/>
<site href="ws-site/"/>
<soap href="ws-soap/"/>
<wsif href="ws-wsif/"/>
<wsil href="ws-wsil/"/>
<wsrp4j href="ws-wsrp4j/"/>
<xmlrpc href="ws-xmlrpc/"/>
</viewcvs>
</cvs.apache.org>
<www.apache.org href="http://www.apache.org/">
<foundation href="foundation/"/>
</www.apache.org>
<nagoya.apache.org href="http://nagoya.apache.org/">
<eyebrowse href="eyebrowse/"/>
<bugzilla href="bugzilla/"/>
<apachewiki href="wiki/apachewiki.cgi?HomePage"/>
</nagoya.apache.org>
<archive.apache.org href="http://archive.apache.org/">
<archive-ws href="dist/ws/"/>
</archive.apache.org>
<apachecon2003 href="http://apachecon.com/2003/US/"/>
</external-refs>
<about label="About">
<index label="Welcome" href="index.html" description="Welcome to WSFX"/>
<news label="News" href="news.html"/>
<ml label="Mailing Lists" href="mail.html"/>
</about>
<projects label="Projects">
<axis label="Addressing" href="ext:addressing"/>
<wsfx label="Sandesha" href="ext:sandesha"/>
<jaxme label="WSS4J" href="ext:wss4j"/>
</projects>
<all>
<whole_site_html label="Whole Site HTML" href="site.html"/>
<whole_site_html label="Whole Site PDF" href="site.pdf"/>
</all>
<external-refs>
<xml.apache.org href="http://xml.apache.org/">
<forrest href="forrest/">
<validation href="validation.html"/>
<webapp href="your-project.html#webapp"/>
<document-v11 href="document-v11.html"/>
</forrest>
<cocoon href="cocoon/"/>
</xml.apache.org>
</external-refs>
</site>
1.1 ws-fx/src/documentation/content/xdocs/tabs.xml
Index: tabs.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE tabs PUBLIC "-//APACHE//DTD Cocoon Documentation Tab V1.0//EN" "http://apache.org/forrest/dtd/tab-cocoon-v10.dtd">
<tabs software="MyProj"
title="MyProj"
copyright="Foo"
xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- The rules are:
@dir will always have '/@indexfile' added.
@indexfile gets appended to @dir if the tab is selected. Defaults to 'index.html'
@href is not modified unless it is root-relative and obviously specifies a
directory (ends in '/'), in which case /index.html will be added
If @id's are present, site.xml entries with a matching @tab will be in that tab.
-->
<tab id="" label="Home" dir="" indexfile="index.html"/>
<!-- Add new tabs here, eg:
<tab label="How-Tos" dir="community/howto/"/>
<tab label="XML Site" dir="xml-site/"/>
-->
</tabs>
1.1 ws-fx/src/documentation/content/xdocs/samples/ehtml-sample.ehtml
Index: ehtml-sample.ehtml
===================================================================
<?xml version="1.0"?>
<html>
<!-- Note: no head element or external CSS refs. Elements outside the body are ignored -->
<body>
<h1>Sample HTML page</h1>
<p>
This HTML page body is copied across directly from
<tt>src/documentation/content/xdocs</tt>. Only the menus and tabs are added
by Forrest.
</p>
<p>
Using raw HTML like this is not recommended, because the advantages of
separating content from presentation are lost. In particular, Forrest
can't generate PDFs of this page.
</p>
<p>
Still, there are many cases when the Forrest DTD isn't sufficient, such as
when you want to embed applets, <a href="javascript:alert('Opened with Javascript')">Javascript</a>,
<table cellpadding="5">
<tr bgcolor="#aaffff">
<td>Tables</td><td>
<table>
<tr>
<td bgcolor="#ffffaa">within</td>
<td bgcolor="ffaaff">tables</td>
</tr>
</table>
</td>
</tr>
</table>
HTML Forms:
<form>
<select name="skin">
<option value="krysalis-site">krysalis-site</option>
<option value="forrest-site">forrest-site</option>
</select>
<input type="submit" value="Change Skin (temporarily, in the webapp)"/>
</form>
and other HTML <blink>delights</blink>
</p>
<p>
You can still take advantage of Forrest's <a href="http://xml.apache.org/forrest/linking.html">site: linking</a>, eg
<a href="site:index"><a href="site:index"></a>
</p>
</body>
</html>
1.1 ws-fx/src/documentation/content/xdocs/samples/faq.xml
Index: faq.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE faqs PUBLIC "-//APACHE//DTD FAQ V1.2//EN" "http://apache.org/forrest/dtd/faq-v12.dtd">
<faqs title="Frequently Asked Questions">
<part id="docs">
<title>Documentation</title>
<faq id="forrest">
<question>
How can I help write documentation?
</question>
<answer>
<p>
This project uses <link href="ext:forrest">Apache Forrest</link> to
generate documentation from XML. Please download a copy of Forrest,
which can be used to <link
href="ext:forrest/validation">validate</link>, <link
href="ext:forrest/webapp">develop</link> and render a project site.
</p>
</answer>
</faq>
<!-- More faqs or parts here -->
</part>
<!-- More faqs or parts here -->
</faqs>
1.1 ws-fx/src/documentation/content/xdocs/samples/ihtml-sample.ihtml
Index: ihtml-sample.ihtml
===================================================================
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<h1>Test iHTML page</h1>
<p> This HTML is used to render the page instead of using the Forrest
XML DTD directly.</p>
<p>All linked-to pages, like <a href="../test2.html">this one</a>, are
also available. </p>
<hr> [<a href="index.html">Index</a>]
</body>
</html>
1.1 ws-fx/src/documentation/content/xdocs/samples/index.xml
Index: index.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://apache.org/forrest/dtd/document-v12.dtd">
<document>
<header>
<title>Samples</title>
</header>
<body>
<section>
<title>If something goes wrong..</title>
<p>Patches are welcome: <link href="http://xml.apache.org/forrest/faq.html">Forrest FAQ</link></p>
</section>
</body>
</document>
1.1 ws-fx/src/documentation/content/xdocs/samples/sample.xml
Index: sample.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://apache.org/forrest/dtd/document-v12.dtd">
<document>
<header>
<title>The document-v1.2 DTD</title>
<authors><person name="Jeff Turner" email="jefft@apache.org"/>
</authors>
<notice>This document doesn't make any sense at all.</notice>
<abstract>A nonsense document using all possible elements in the current
<code>document-v12.dtd</code>.</abstract>
</header>
<body>
<section>
<title>Sample Content</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>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><link href="faq.html"></code></dt>
<dd>Use this to
<link href="faq.html" title="Example of a document via link">link</link>
to another document. As per normal, this will open the new document
in the same browser window.</dd>
<dt><code><link href="#section"></code></dt>
<dd>Use this to
<link href="#section" title="Example of a document via local anchor">link</link>
to the named anchor in the current document.
</dd>
<dt><code><link href="faq.html#forrest"></code></dt>
<dd>Use this to
<link href="faq.html#forrest" title="Example of a document via link and anchor">link</link>
to another document and go to the named anchor. This will open
the new document in the same browser window.
</dd>
<dt><code><jump href="faq.html"></code></dt>
<dd>Use this to
<jump href="faq.html" title="Example of a document via jump">jump</jump>
to another document and optionally go to a named
<jump href="faq.html#forrest" title="Example of a document via jump to anchor">anchor</jump>
within that document. This will open the new document in the same
browser window. So what is the difference between link and jump?
The jump behaves differently, in that it will replace any frames
in the current window.
This is the equivalent of
<code><a ... target="_top"></code>
</dd>
<dt><code><fork href="faq.html"></code></dt>
<dd>Use this to
<fork href="faq.html" title="Example of a document via fork">fork</fork>
your webbrowser to another document. This will open the document
in a new, unnamed browser window.
This is the equivalent of
<code><a ... target="_blank"></code>
</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>
<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>
<anchor id="section"/>
<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>
<title>Sections, the sequel</title>
<p>Just some second section.</p>
<section>
<title>Section 2.1</title>
<p>Which contains a subsection (2.1).</p>
</section>
</section>
<anchor id="source"/>
<section>
<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>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</th>
<th>heading cell</th>
</tr>
<tr>
<td>data cell</td>
<td>data cell</td>
</tr>
</table>
<p>Not much of attributes with <code><table></code>, if you ask me.</p>
</section>
<anchor id="second-figure-anchor"/>
<section id="figure">
<title>Using figures</title>
<p>And a figure to end all of this.</p>
<figure src="images/project-logo.gif" alt="project logo" width="220" height="65"/>
</section>
</section>
<section>
<title>Changes since <link href="site:document-v11">document-v11</link></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>
</body>
<footer>
<legal>© 2002 Apache Forrest</legal>
</footer>
</document>
1.1 ws-fx/src/documentation/content/xdocs/samples/sample2.xml
Index: sample2.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://apache.org/forrest/dtd/document-v12.dtd">
<document>
<header>
<title>More samples</title>
<authors><person name="Steven Noels" email="stevenn@apache.org"/>
</authors>
</header>
<body>
<section>
<title>Miscellanea</title>
<p>
You can include raw HTML, PDFs, plain-text, and other files in Forrest
output by placing them in <code>src/documentation/content</code> and
they will be copied over automatically. You can then link to them as
normal, e.g.
<link href="../hello.pdf"><link href="hello.pdf"/></link> and
<link href="../test1.html"><link href="test1.html/></link>
</p>
<p>
You can also have sub-directories such as
<code>src/documentation/content/connectors</code> which reflects your
<code>xdocs/connectors</code> tree. The raw files will then end up
beside your documents.
</p>
</section>
</body>
</document>
1.1 ws-fx/src/documentation/content/xdocs/samples/sdocbook.xml
Index: sdocbook.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD Simplified DocBook XML V1.0//EN"
"http://www.oasis-open.org/docbook/xml/simple/1.0/sdocbook.dtd">
<article>
<title>Simplified DocBook title</title>
<subtitle>Sample Page subtitle</subtitle>
<titleabbrev>Title abbrev</titleabbrev>
<articleinfo>
<author>
<authorblurb>
<title>Author blurb Title</title>
<para>Author blurb paragraph</para>
</authorblurb>
<firstname>Juan</firstname>
<othername>Jose</othername>
<surname>Pablos</surname>
</author>
<date>01-August-2003</date>
</articleinfo>
<abstract>
<title>Abstract title</title>
<para>Abstract paragraph</para>
</abstract>
<epigraph>
<attribution>Epigraph Attribution</attribution>
<literallayout>Literal layout</literallayout>
<para>Epigraph paragraph</para>
</epigraph>
<example>
<title>Example title</title>
<para>Example paragraph</para>
</example>
<figure>
<title>Figure title</title>
<literallayout>Literal layout</literallayout>
</figure>
<figure>
<title>Figure Image</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/project-logo.gif" />
</imageobject>
</mediaobject>
</figure>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Informal Table head entry</entry>
</row>
</thead>
<tfoot>
<row>
<entry>Table foot entry</entry>
</row>
</tfoot>
<tbody>
<row>
<entry>1</entry>
<entry>2</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<itemizedlist>
<listitem>
<para>list item</para>
</listitem>
</itemizedlist>
<note>
<para>Note</para>
</note>
<orderedlist>
<listitem>
<para>Ordered list item</para>
</listitem>
</orderedlist>
<para>Article paragraph</para>
<programlisting>Program listing</programlisting>
<sidebar>
<para>Sidebar</para>
</sidebar>
<variablelist>
<varlistentry>
<term>Term</term>
<listitem>
<para>Definition</para>
</listitem>
</varlistentry>
</variablelist>
<table>
<title>Table</title>
<tgroup cols="2">
<colspec align="center" />
<thead>
<row>
<entry align="center">Head entry</entry>
<entry align="center">Head entry</entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>2</entry>
</row>
<row>
<entry>3</entry>
<entry>4</entry>
</row>
</tbody>
</tgroup>
</table>
<section>
<title>Section title</title>
<para>Section paragraph</para>
</section>
<appendix>
<title>Appendix title</title>
<para>Appendix paragraph</para>
</appendix>
<bibliography>
<bibliomixed>Bibliography</bibliomixed>
</bibliography>
</article>
1.1 ws-fx/src/documentation/content/xdocs/samples/wiki-sample.cwiki
Index: wiki-sample.cwiki
===================================================================
!!!Forrest's Wiki Support
Forrest now has partial support for documentation in Wiki format, thanks to the
[Chaperon parser|http://chaperon.sf.net]. Wiki is a simple text format that can
be learned in minutes. This page provides an overview of the syntax that
Forrest supports, namely a subset of that used by the [Cocoon
Wiki|http://wiki.cocoondev.org].
!Quick reference
{{{
---- = Make a horizontal ruler. Extra '-' is ignored.
\\ = force a line break, \\\=force line break and clear.
[link] = creates a hyperlink to an internal WikiPage called 'Link'.
[this is also a link] = creates a hyperlink to an internal WikiPage called
'ThisIsAlsoALink'.
[click here|link] = creates a hyperlink to an internal WikiPage called
'Link', but displays the text 'click here' to the
user instead of 'Link'.
[1] = Makes a reference to a footnote numbered 1.
[#1] = Marks the footnote number 1.
[[link] = creates text '[link]'.
!heading = small heading with text 'heading'
!!heading = medium heading with text 'heading'
!!!heading = large heading with text 'heading'
''text'' = prints 'text' in italic.
__text__ = prints 'text' in bold.
{{text}} = prints 'text' in monospaced font.
* text = makes a bulleted list item with 'text'
# text = makes a numbered list item with 'text'
;term:ex = makes a definition for 'term' with the explanation 'ex'
}}}
!Writing text
You don't need to know anything about the Wiki text formatting rules to use
Wiki. Just write normal text, and then use an empty line to mark a paragraph.
It's just like writing an email.
!Hyperlinks
The link can also be a direct URL starting with http:, ftp:, mailto:, https:, or news:, in which case the link points to
an external entity. For example, to point at the java.sun.com home page, use [[http://java.sun.com], which becomes
[http://java.sun.com/] or [[Java home page|http://java.sun.com], which becomes [Java home page|http://java.sun.com].
To add a new page you just create a link to it from somewhere else. After all, there isn't much point in having a page
if you can't access it! You'll then see a small question mark after the page name when you return to that page. Then
click on it and you have created a new page!
It's allowed to use almost any kind of characters inside a [[WikiName], as long
as they are letters or numbers.
Note also that this Wiki can be configured to support standard CamelCase linking (if it's supported, the word CamelCase
should be a link). It's off by default, but if your friendly administrator has turned it on, then well, CamelCase all
you want =).
!Adding pictures
For security reasons uploading images is not permitted, but you can embed
any image in the wiki code by putting the image available somewhere on the web in one of the allowed formats, and then
just linking to it.
For example, this is an inlined PNG image: [rss.png].
If you specify a link text ([[this one here|http://example.com/example.png]) it becomes
the ALT text for those who either can't or don't want to view images.
!Bulleted lists
Use an asterisk (*) in the first column to make bulleted lists. Use more asterisks for deeper indentation. For example:
{{{
* One
* Two
* Three
** Three.One
}}}
creates
* One
* Two
* Three
** Three.One
!Numbered lists
Just like with bulleted lists, but use a hash (#) instead of the asterisk. Like this:
{{{
# One
# Two
# Three
## Three.One
}}}
creates
# One
# Two
# Three
## Three.One
If you want to write the list item on multiple lines, just add one or more spaces on the next line and the line will be
automatically added to the
previous item. If this sounds complicated, edit this page for an example, below.
* This is a single-line item.
* This is actually a multi-line item.
We continue the second sentence on a line on a line of its own.
We might as well do a third line while we're at it...
Notice, however, as all these sentences get put inside a single item!
* The third line is again a single-line item for your convinience.
!Definition lists and comments
A simple way to make definition lists is to use the ';:' -construct:
;__Construct__:''Something you use to do something with''
Another nice use for the ';:' is that you can use it to comment shortly on other people's text, by having an empty
'term' in the definition, like this:
{{{
;:''Comment here.''
}}}
Which would be seen as
;:''Comment here.''
!Text effects
You may use __bold__ text or ''italic'' text, by using two underscores (_) and two single quotes ('), respectively. If
you're on a Windows computer, make sure that you are using the correct quote sign, as there is one that looks the same,
but really isn't.
!Preformatted text
If you want to add preformatted text (like code) just use three consecutive braces ({) to open a block, and three
consecutive braces (}) to close a block. Edit this page for an example.
!Tables
You can do simple tables by using using pipe signs ('|'). Use double pipe
signs to start the heading of a table, and single pipe signs to then
write the rows of the table. End with a line that is not a table.
For example:
{{{
|| Heading 1 || Heading 2
| ''Gobble'' | Bar
| [[Main] | [[SandBox]
}}}
gives you the following table. Note how you can use links also inside tables.
|| Heading 1 || Heading 2
| ''Gobble'' | Bar
| [[Main] | [[SandBox]
1.1 ws-fx/src/documentation/content/xdocs/samples/subdir/book-sample.xml
Index: book-sample.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "http://apache.org/forrest/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
site.xml. -->
<book software="MyProj"
title="MyProj"
copyright="@year@ The Apache Software Foundation"
xmlns:xlink="http://www.w3.org/1999/xlink">
<menu label="About">
<menu-item label="Index" href="site:index"/>
<menu-item label="Sample page" href="site:sample"/>
<menu-item label="Sample ihtml page" href="site:sample-ihtml"/>
<menu-item label="Sample ehtml page" href="site:sample-ehtml"/>
<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>
1.1 ws-fx/src/documentation/content/xdocs/samples/subdir/index.xml
Index: index.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://apache.org/forrest/dtd/document-v12.dtd">
<document>
<header>
<title>Page generated from a subdirectory</title>
<authors>
<person name="Joe Bloggs" email="joe@joescompany.org" />
</authors>
</header>
<body>
<section>
<title>A subdirectory</title>
<p>This was generated from a subdirectory.</p>
<p>When creating new subdirectories, remember that each <em>must</em>
have a book.xml file</p>
</section>
</body>
</document>
1.1 ws-fx/src/documentation/resources/images/group-logo.gif
<<Binary file>>
1.1 ws-fx/src/documentation/resources/images/icon.png
<<Binary file>>
1.1 ws-fx/src/documentation/resources/images/images.jpeg
<<Binary file>>
1.1 ws-fx/src/documentation/resources/images/project-logo.gif
<<Binary file>>
1.1 ws-fx/src/documentation/resources/images/project-logo.jpg
<<Binary file>>
1.1 ws-fx/src/documentation/resources/images/wsfx.png
<<Binary file>>