You are viewing a plain text version of this content. The canonical link for it is here.
Posted to alexandria-dev@jakarta.apache.org by ni...@apache.org on 2002/11/09 18:53:11 UTC
cvs commit: jakarta-alexandria/src/documentation/resources/images icon.png jakarta-alexandria-forrest.gif jakarta-logo-forrest.gif
nicolaken 2002/11/09 09:53:11
Added: . forrest-targets.ent forrest.properties status.xml
src/documentation README.txt skinconf.xml
src/documentation/content/xdocs book.xml index.xml tabs.xml
src/documentation/resources/images icon.png
jakarta-alexandria-forrest.gif
jakarta-logo-forrest.gif
Log:
New initial version of the alexandria website, made in Forrest,
with initial status.xml file.
Revision Changes Path
1.1 jakarta-alexandria/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 jakarta-alexandria/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=basic
#project.skin=forrest-site
##############
# layout properties
# Properties that must be set to override the default locations
#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=${project.content-dir}/skins
#project.skinconf=${project.content-dir}/skinconf.xml
#project.lib-dir=${project.content-dir}/lib
#project.classes-dir=${project.content-dir}/classes
##############
# 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.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.includes=**/*
#forrest.validate.excludes=
#
#forrest.validate.xdocs.failonerror=${forrest.validate.failonerror}
#
#forrest.validate.xdocs.includes=*.x*
#forrest.validate.xdocs.excludes=
#
#forrest.validate.skinconf.includes=${skinconf-file}
#forrest.validate.skinconf.excludes=
#forrest.validate.skinconf.failonerror=${forrest.validate.failonerror}
#
#forrest.validate.skinconf.includes=${skinconf-file}
#forrest.validate.skinconf.excludes=
#forrest.validate.skinconf.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 jakarta-alexandria/status.xml
Index: status.xml
===================================================================
<?xml version="1.0"?>
<status>
<developers>
<person name="Nicola Ken Barozzi" email="nicolaken@apache.org" id="nicolaken" />
<!-- Add more people here -->
</developers>
<todo>
<actions priority="high">
<action context="code" dev="nicolaken">
Contact the authors of xsldoc and javasrc to have them sign and send a paper that
grants rights to the ASF.
</action>
</actions>
</todo>
<changes>
<!-- Add new releases here -->
<release version="0.1" date="2002">
<!-- Some action types have associated images. By default, images are
defined for 'add', 'fix', 'remove' and 'update'. If you add
src/documentation/resources/images/<foo>.jpg images, these will
automatically be used for entries of type <foo>. -->
<action dev="nicolaken" type="add" context="admin">
Initial Import
</action>
<!-- Sample action:
<action dev="JB" type="fix" due-to="Joe Contributor"
due-to-email="joec@apache.org">
Fixed a bug in the Foo class.
</action>
-->
</release>
</changes>
</status>
1.1 jakarta-alexandria/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 jakarta-alexandria/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.
jefft@apache.org
-->
<!DOCTYPE skinconfig [
<!ENTITY % links.att 'name CDATA #REQUIRED'>
<!ENTITY % link.att 'name CDATA #REQUIRED href CDATA #REQUIRED'>
<!ELEMENT skinconfig (disable-search?, searchsite-domain?, searchsite-name?, project-name, project-url, project-logo, group-name?, group-url?, group-logo?, host-url?, host-logo?, year?, vendor?, trail?, credits?)*>
<!ELEMENT credits (credit*)>
<!ELEMENT credit (name, url, image, width?, height?)>
<!ELEMENT disable-search (#PCDATA)>
<!ELEMENT searchsite-domain (#PCDATA)>
<!ELEMENT searchsite-name (#PCDATA)>
<!ELEMENT project-name (#PCDATA)>
<!ELEMENT project-url (#PCDATA)>
<!ELEMENT project-logo (#PCDATA)>
<!ELEMENT group-name (#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)>
]>
<skinconfig>
<!-- Do we want to disable the Google search box? -->
<disable-search>true</disable-search>
<searchsite-domain>jakarta.apache.org</searchsite-domain>
<searchsite-name>Apache Jakarta</searchsite-name>
<!-- mandatory project logo
skin: forrest-site renders it at the top -->
<project-name>Jakarta Alexandria</project-name>
<project-url>http://jakarta.apache.org/alexandria/</project-url>
<project-logo>images/jakarta-alexandria-forrest.gif</project-logo>
<!-- optional group logo
skin: forrest-site renders it at the top-left corner -->
<group-name>Apache Jakarta</group-name>
<group-url>http://jakarta.apache.org/</group-url>
<group-logo>images/jakarta-logo-forrest.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>2002</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="jakarta" href="http://jakarta.apache.org/"/>
<link3 name="" href=""/>
</trail>
<!-- Credits are typically rendered as a set of small clickable images in the
page footer -->
<credits>
<credit>
<name>Built with Cocoon</name>
<url>http://xml.apache.org/cocoon/</url>
<image>skin/images/built-with-cocoon.gif</image>
<width>88</width>
<height>31</height>
</credit>
</credits>
</skinconfig>
1.1 jakarta-alexandria/src/documentation/content/xdocs/book.xml
Index: book.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "book-cocoon-v10.dtd">
<book software="Alexandria"
title="Alexandria"
copyright="2002 The Apache Software Foundation"
xmlns:xlink="http://www.w3.org/1999/xlink">
<menu label="About">
<menu-item label="Index" href="index.html"/>
<!-- Add new entries here, or in a new menu. Consult the DTD for valid elements-->
<menu-item label="Changes" href="changes.html"/>
<menu-item label="Todo" href="todo.html"/>
</menu>
</book>
1.1 jakarta-alexandria/src/documentation/content/xdocs/index.xml
Index: index.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
<document>
<header>
<title>Alexandria</title>
</header>
<body>
<section>
<title>Welcome</title>
<p>Alexandria is a CVS/Javadoc/Source code/Documentation management
system meant for use within Open Source projects.
It's goal is to create a global documentation and source organization
system to help people understand source code and to share code across projects.<br/>
Alexandria is a Java centric project, and the backend is implemented in all XML.
</p>
<warning>
Currently this project has been lying uncatered for a long time, and the
original codebase is obsolete. There have been code donations recently and interest
has resurged, but there is still a lot to do.<br/>
If you are interested, join the alexandria-dev@jakarta.apache.org mailing list by
sending an empty message to
<link href="mailto:alexandria-dev-subscribe@jakarta.apache.org">alexandria-dev-subscribe@jakarta.apache.org</link>,
and we will be happy to get some help.
</warning>
<note>
A proposal for a new Alexandria called <link href="http://jakarta.apache.org/gump/">Gump</link>
is present in the alexandria repository under <code>jakarta-alexandria/proposals/gump/**</code>.
It has overgrown its parent and has now its own
<link href="http://jakarta.apache.org/gump/">website</link>.<br/>
</note>
<section>
<title>Why the name Alexandria?</title>
<p>The library of Alexandria was an enormous Library in ancient Egypt that was destroyed
by fire. Many historians regards its destruction a major loss of knowledge
(although it is commonly regarded as Legend). We just thought it was appropriate
considering we have all this structured information on the Internet but it isn't being used.
</p>
</section>
</section>
<section>
<title>Goals</title>
<ul>
<li>Browse multiple and remote source repositories</li>
<li>Generate Javadoc across multiple java projects</li>
<li>Browse source code in an organized manner</li>
<li>The "use" tag can be use across all projects within Alexandria</li>
<li>Support multiple revisions of the same content</li>
<li>Be easily pluggable in other systems like Ant, Forrest, and Maven.</li>
</ul>
</section>
</body>
</document>
1.1 jakarta-alexandria/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" "tab-cocoon-v10.dtd">
<tabs software="Alexandria"
title="Alexandria"
copyright="2002 Apache Software Foundation"
xmlns:xlink="http://www.w3.org/1999/xlink">
<tab label="Home" dir=""/>
<tab label="Old Alexandria" href="index_old.html"/>
<!-- Add new tabs here, eg:
<tab label="How-Tos" dir="community/howto/"/>
<tab label="XML Site" dir="xml-site/"/>
-->
</tabs>
1.1 jakarta-alexandria/src/documentation/resources/images/icon.png
<<Binary file>>
1.1 jakarta-alexandria/src/documentation/resources/images/jakarta-alexandria-forrest.gif
<<Binary file>>
1.1 jakarta-alexandria/src/documentation/resources/images/jakarta-logo-forrest.gif
<<Binary file>>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>