noel 2004/08/31 18:15:34
Modified: . README.txt forrest.properties
site skinconf.xml
Log:
David Crossley's patch for latest forrest
Revision Changes Path
1.4 +17 -19 incubator/README.txt
Index: README.txt
===================================================================
RCS file: /home/cvs/incubator/README.txt,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- README.txt 27 Oct 2003 13:18:24 -0000 1.3
+++ README.txt 1 Sep 2004 01:15:34 -0000 1.4
@@ -21,27 +21,25 @@
Website Howto
=============
-To generate the website one needs to get CVS forrest
-(http://xml.apache.org/forrest/) and install it.
+To generate the website one needs to install Apache Forrest
+http://forrest.apache.org/ (use the current development version from SVN).
Editors can edit the pages without generating the site, and just validate the
xml with a validating editor before committing. For the wiki pages it's plain
-text, so it's easier. Ones with Forrest installed (currently nicolaken) and
-after the Forrestbot will take care of doing builds, fixing eventual errors
-and updating the site.
-
-In any case, if someone wants to check the look of the pages, do this:
-
- get or update xml-forrest from CVS
- run the build script
- set FORREST_HOME to point to the build/dist/shbat
- add build/dist/shbat/bin to the PATH
-
- get or update "incubator" from CVS
- cd into the local "incubator" CVS dir
- execute "forrest run"
- point the browser to http://localhost:8888/ to see the site
- edit the docs *in place* and see changes in teh browser by reloading the
page
+text, so it's easier. People with Forrest installed can build and update
+the website. (Later the Forrestbot will take care of doing builds.)
+
+Anyway, do this ...
+
+ Follow the Forrest instructions to build it
+ and set the environment variables FORREST_HOME and PATH
+
+ Get or update "incubator" from CVS
+ cd into the local "incubator" top-level CVS dir
+ Do 'forrest run'
+ Point the browser to http://localhost:8888/ to see the site
+ Edit the docs *in place* and see changes in the browser by reloading.
+ To generate the full website use the command-line mode 'forrest'.
Subproject Website Howto
========================
@@ -50,7 +48,7 @@
the specific project.
Check-in the generated pages in the "incubator-site" CVS module under
-\incubator-site\build\site\projects\${project-name}\**.
+\incubator-site\build\site\projects\${project-name}\**
When the site is updated from CVS (it's once a day) it will be live.
1.4 +37 -9 incubator/forrest.properties
Index: forrest.properties
===================================================================
RCS file: /home/cvs/incubator/forrest.properties,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- forrest.properties 28 Nov 2003 15:35:18 -0000 1.3
+++ forrest.properties 1 Sep 2004 01:15:34 -0000 1.4
@@ -1,19 +1,35 @@
+# Copyright 2002-2004 The Apache Software Foundation
+#
+# 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.
+
##############
# Properties used by forrest.build.xml for building the website
+# These are the defaults, un-comment them if you need to change them.
##############
# Prints out a summary of Forrest settings for this project
-# forrest.echo=true
+#forrest.echo=true
# Project name (used to name .war file)
project.name=apache-incubator
# Specifies name of Forrest skin to use
-project.skin=forrest-site
-#project.skin=forrest-css
-#project.skin=avalon-tigris
-#project.skin=krysalis-site
+#project.skin=crust
+#project.skin=tigris
+#project.skin=pelt
+# comma seperated list, file:/// is supported
+#forrest.skins.descriptors=http://forrest.apache.org/skins/skins.xml,file:///c:/myskins/skins.xml
##############
# behavioural properties
@@ -50,12 +66,18 @@
# A local OASIS catalog file to supplement the default Forrest catalog
#project.catalog=${project.schema-dir}/catalog.xcat
-# The verbosity level for the entity resolver (1..10)
-#forrest.catalog.verbosity=1
-
##############
# validation properties
+# Determine if validation is performed
+#forrest.validate=true
+
+# *.failonerror=(true|false) stop when an XML file is invalid
+#forrest.validate.failonerror=true
+
+# *.excludes=(pattern) Comma-separated list of path patterns to not validate
+# e.g.
+#forrest.validate.xdocs.excludes=samples/subdir/**, samples/faq.xml
forrest.validate.xdocs.excludes=site.xml
##############
@@ -71,4 +93,10 @@
# Any other arguments to pass to the JVM. For example, to run on an X-less
# server, set to -Djava.awt.headless=true
#forrest.jvmargs=
-#project.bugtracking-url=http://nagoya.apache.org/bugzilla/show_bug.cgi?id=
+# The bugtracking URL - the issue number will be appended
+#project.bugtracking-url=http://issues.apache.org/bugzilla/show_bug.cgi?id=
+#project.bugtracking-url=http://issues.apace.org/jira/browse/
+# The issues list as rss
+#project.issues-rss-url=
+#I18n Property only works for the "forrest run" target.
+#project.i18n=true
1.4 +277 -68 incubator/site/skinconf.xml
Index: skinconf.xml
===================================================================
RCS file: /home/cvs/incubator/site/skinconf.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- skinconf.xml 18 Oct 2003 14:28:59 -0000 1.3
+++ skinconf.xml 1 Sep 2004 01:15:34 -0000 1.4
@@ -1,93 +1,101 @@
<?xml version="1.0"?>
-
<!--
-Skin configuration file. This file contains details of your project, which
will
-be used to configure the chosen Forrest skin.
--->
+ Copyright 2002-2004 The Apache Software Foundation
-<!DOCTYPE skinconfig [
+ 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.
+-->
- <!ENTITY % links.att 'name CDATA #REQUIRED'>
- <!ENTITY % link.att 'name CDATA #REQUIRED href CDATA #REQUIRED'>
- <!ELEMENT skinconfig (disable-search?, disable-print-link?,
disable-pdf-link?,
- disable-xml-link?, disable-compliance-links?, 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?)>
- <!-- id uniquely identifies the tool, and role indicates its function -->
- <!ATTLIST credit id CDATA #IMPLIED
- role CDATA #IMPLIED>
- <!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 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)>
- ]>
+<!--
+Skin configuration file. This file contains details of your project,
+which will be used to configure the chosen Forrest skin.
+-->
+<!-- See Forrest Issue FOR-255
+<!DOCTYPE skinconfig PUBLIC "-//APACHE//DTD Skin Configuration V0.6-3//EN"
"http://forrest.apache.org/dtd/skinconfig-v06-3.dtd";>
+-->
+<!DOCTYPE skinconfig PUBLIC "-//APACHE//DTD Skin Configuration V0.6-3//EN"
"skinconfig-v06-3.dtd">
<skinconfig>
- <!-- Do we want to disable the Google search box? -->
- <disable-search>false</disable-search>
- <!-- Do we want to disable the print link? -->
+ <!-- To enable lucene search add provider="lucene"
+ Add box-location="alt" to move the search box to an alternate location
+ (if the skin supports it) and box-location="all" to show it in all
+ available locations on the page. Remove the <search> element to show
+ no search box.
+ -->
+ <search name="Incubator" domain="incubator.apache.org"/>
+
+ <!-- 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 the PDF link? -->
<disable-pdf-link>false</disable-pdf-link>
- <!-- Do we want to disable the xml source link? -->
+ <!-- Disable the POD link? -->
+ <disable-pod-link>true</disable-pod-link>
+ <!-- Disable the xml source link? -->
+ <!-- The xml source link makes it possible to access the xml rendition
+ of the source frim the html page, and to have it generated statically.
+ This can be used to enable other sites and services to reuse the
+ xml format for their uses. Keep this disabled if you don't want other
+ sites to easily reuse your pages.-->
<disable-xml-link>true</disable-xml-link>
- <!-- Do we want to disable w3c compliance links? -->
+
+ <!-- Disable navigation icons on all external links? -->
+ <disable-external-link-image>false</disable-external-link-image>
+
+ <!-- Disable w3c compliance links?
+ Use e.g. align="center" to move the compliance links logos to
+ an alternate location default is left.
+ (if the skin supports it) -->
<disable-compliance-links>false</disable-compliance-links>
- <searchsite-domain>incubator.apache.org</searchsite-domain>
- <searchsite-name>Incubator</searchsite-name>
+ <!-- Render mailto: links unrecognisable by spam harvesters? -->
+ <obfuscate-mail-links>true</obfuscate-mail-links>
+
+ <!-- Disable the javascript facility to change the font size -->
+ <disable-font-script>false</disable-font-script>
<!-- mandatory project logo
- skin: forrest-site renders it at the top -->
+ default skin: renders it at the top -->
<project-name>Apache Incubator</project-name>
<project-url>http://incubator.apache.org/</project-url>
<project-logo>images/apache-incubator-logo.png</project-logo>
<!-- optional group logo
- skin: forrest-site renders it at the top-left corner -->
+ default skin: renders it at the top-left corner -->
<group-name>Apache</group-name>
<group-url>http://www.apache.org</group-url>
<group-logo>images/apache-incubator.png</group-logo>
<!-- optional host logo (e.g. sourceforge logo)
- skin: forrest-site renders it at the bottom-left corner -->
+ default skin: renders it at the bottom-left corner -->
<host-url></host-url>
<host-logo></host-logo>
+ <!-- relative url of a favicon file, normally favicon.ico -->
+ <favicon-url></favicon-url>
+
<!-- The following used to construct a copyright statement -->
- <year>2002-2003</year>
+ <year>2002-2004</year>
<vendor>The Apache Software Foundation.</vendor>
+ <!-- The optional copyright-link URL will be used as a link in the
+ copyright statement
+ -->
+ <copyright-link>http://www.apache.org/licenses/</copyright-link>
- <!-- 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.
+ <!-- Some skins use this to form a 'breadcrumb trail' of links.
+ Use location="alt" to move the trail to an alternate location
+ (if the skin supports it).
+ Omit the location attribute to display the trail in the default
location.
+ Use location="none" to not display the trail (if the skin supports
it).
+ For some skins just set the attributes to blank.
-->
<trail>
<link1 name="apache" href="http://www.apache.org/"/>
@@ -95,18 +103,219 @@
<link3 name="" href=""/>
</trail>
- <!-- Credits are typically rendered as a set of small clickable images in
the
- page footer -->
+ <!-- Configure the TOC, i.e. the Table of Contents.
+ @max-depth
+ how many "section" levels need to be included in the
+ generated Table of Contents (TOC).
+ @min-sections
+ Minimum required to create a TOC.
+ @location ("page","menu","page,menu", "none")
+ Where to show the TOC.
+ -->
+ <toc max-depth="2" min-sections="1" location="page"/>
+
+ <!-- Heading types can be clean|underlined|boxed -->
+ <headings type="underlined"/>
+
+ <!-- The optional feedback element will be used to construct a
+ feedback link in the footer with the page pathname appended:
+ <a href="@href">[EMAIL PROTECTED]</a>
+ <feedback to="[EMAIL PROTECTED]"
+ href="mailto:[EMAIL PROTECTED] " >
+ Send feedback about the website to:
+ </feedback>
+ -->
+
+ <extra-css>
+ <!-- A sample to show how the class attribute can be used -->
+ p.quote {
+ margin-left: 2em;
+ padding: .5em;
+ background-color: #f0f0f0;
+ font-family: monospace;
+ }
+ </extra-css>
+
+ <colors>
+ <!-- These values are used for the generated CSS files. -->
+
+ <!-- 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 -->
+ <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="navstrip" value="#cedfef" font="#0F3660" link="#0F3660"
vlink="#0F3660" hlink="#000066"/>
+ <color name="toolbox" value="#4a6d8c"/>
+ <color name="border" value="#294563"/>
+
+ <color name="menu" value="#4a6d8c" font="#cedfef" link="#ffffff"
vlink="#ffffff" hlink="#ffcf00"/>
+ <color name="dialog" value="#4a6d8c"/>
+
+ <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"/>
+
+ <!-- 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"/>
+-->
+ <!-- Lenya using pelt-->
+<!--
+ <color name="header" value="#ffffff"/>
+
+ <color name="tab-selected" value="#4C6C8F" link="#ffffff"
vlink="#ffffff" hlink="#ffffff"/>
+ <color name="tab-unselected" value="#E5E4D9" link="#000000"
vlink="#000000" hlink="#000000"/>
+ <color name="subtab-selected" value="#000000" link="#000000"
vlink="#000000" hlink="#000000"/>
+ <color name="subtab-unselected" value="#E5E4D9" link="#000000"
vlink="#000000" hlink="#000000"/>
+
+ <color name="heading" value="#E5E4D9"/>
+ <color name="subheading" value="#000000"/>
+ <color name="published" value="#4C6C8F" font="#FFFFFF"/>
+ <color name="feedback" value="#4C6C8F" font="#FFFFFF" align="center"/>
+ <color name="navstrip" value="#E5E4D9" font="#000000"/>
+
+ <color name="toolbox" value="#CFDCED" font="#000000"/>
+
+ <color name="border" value="#999999"/>
+ <color name="menu" value="#4C6C8F" font="#ffffff" link="#ffffff"
vlink="#ffffff" hlink="#ffffff" current="#FFCC33" />
+ <color name="menuheading" value="#cfdced" font="#000000" />
+ <color name="searchbox" value="#E5E4D9" font="#000000"/>
+
+ <color name="dialog" value="#CFDCED"/>
+ <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="#E5E4D9"/>
+-->
+ </colors>
+
+ <!-- Settings specific to PDF output. -->
+ <pdf>
+ <!--
+ Supported page sizes are a0, a1, a2, a3, a4, a5, executive,
+ folio, legal, ledger, letter, quarto, tabloid (default letter).
+ Supported page orientations are portrait, landscape (default
+ portrait).
+ Supported text alignments are left, right, justify (default left).
+ -->
+ <page size="letter" orientation="portrait" text-align="left"/>
+
+ <!--
+ Margins can be specified for top, bottom, inner, and outer
+ edges. If double-sided="false", the inner edge is always left
+ and the outer is always right. If double-sided="true", the
+ inner edge will be left on odd pages, right on even pages,
+ the outer edge vice versa.
+ Specified below are the default settings.
+ -->
+ <margins double-sided="false">
+ <top>1in</top>
+ <bottom>1in</bottom>
+ <inner>1.25in</inner>
+ <outer>1in</outer>
+ </margins>
+
+ <!--
+ Print the URL text next to all links going outside the file
+ -->
+ <show-external-urls>false</show-external-urls>
+ </pdf>
+
+ <!-- Credits are typically rendered as a set of small clickable
+ images in the page footer.
+ Use box-location="alt" to move the credit to an alternate location
+ (if the skin supports it).
+ -->
<credits>
- <credit>
+ <credit box-location="alt">
<name>Built with Apache Forrest</name>
- <url>http://xml.apache.org/forrest/</url>
+ <url>http://forrest.apache.org/</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. -->
+ <!-- A credit with @role='pdf' will have its name and url
+ displayed in the PDF page's footer. -->
</credits>
-
+
</skinconfig>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
