You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@santuario.apache.org by bl...@apache.org on 2005/05/15 12:09:53 UTC
cvs commit: xml-security/doc/site/src/documentation/conf cli.xconf
blautenb 2005/05/15 03:09:53
Modified: doc/site forrest.properties
doc/site/src/documentation/conf cli.xconf
Log:
Moving cli.xconf around to get a clean compile under Forrest 0.6
Revision Changes Path
1.3 +51 -57 xml-security/doc/site/forrest.properties
Index: forrest.properties
===================================================================
RCS file: /home/cvs/xml-security/doc/site/forrest.properties,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- forrest.properties 10 Mar 2004 11:39:36 -0000 1.2
+++ forrest.properties 15 May 2005 10:09:53 -0000 1.3
@@ -1,20 +1,20 @@
-# Copyright 2003-2004 The Apache Software Foundation
+# 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
@@ -24,49 +24,48 @@
#project.name=my-project
# Specifies name of Forrest skin to use
-#project.skin=forrest-site
-#project.skin=avalon-tigris
-#project.skin=krysalis-site
+#project.skin=tigris
+#project.skin=pelt
+# comma separated list, file:// is supported
+#forrest.skins.descriptors=http://forrest.apache.org/skins/skins.xml,file:///c:/myskins/skins.xml
+
+##############
+# behavioural properties
+#project.menu-scheme=tab_attributes
+#project.menu-scheme=directories
##############
# layout properties
-# Properties that must be set to override the default locations
+# Properties that can 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.configfile=${project.home}/src/documentation/conf/cli.xconf
+#project.raw-content-dir=${project.content-dir}/content
#project.conf-dir=${project.content-dir}/conf
-#project.sitemap=${project.content-dir}/sitemap.xmap
+#project.sitemap-dir=${project.content-dir}
#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.resources-dir=${project.content-dir}/resources
+#project.stylesheets-dir=${project.resources-dir}/stylesheets
+#project.images-dir=${project.resources-dir}/images
+#project.schema-dir=${project.resources-dir}/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
-
-
-##############
-# 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
-
+#project.translations-dir=${project.content-dir}/translations
##############
# validation properties
-# These props determine if validation is performed at all
+# This set of properties determine if validation is performed
# Values are inherited unless overridden.
-# Eg, if forrest.validate=false, then all others are false unless set to true.
+# e.g. 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}
@@ -75,37 +74,32 @@
#forrest.validate.skins=${forrest.validate}
#forrest.validate.skins.stylesheets=${forrest.validate.skins}
+# *.failonerror=(true|false) - stop when an XML file is invalid
+#forrest.validate.failonerror=true
-# 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
+# *.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=
-#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}
+
+##############
+# General Forrest properties
+
+# The URL to start crawling from
+#project.start-uri=linkmap.html
+# Set logging level for messages printed to the console
+# (DEBUG, INFO, WARN, ERROR, FATAL_ERROR)
+#project.debuglevel=ERROR
+# Max memory to allocate to Java
+#forrest.maxmemory=64m
+# 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=
+# 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.apache.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.3 +199 -64 xml-security/doc/site/src/documentation/conf/cli.xconf
Index: cli.xconf
===================================================================
RCS file: /home/cvs/xml-security/doc/site/src/documentation/conf/cli.xconf,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- cli.xconf 10 Mar 2004 11:39:36 -0000 1.2
+++ cli.xconf 15 May 2005 10:09:53 -0000 1.3
@@ -1,20 +1,19 @@
<?xml version="1.0"?>
<!--
-Copyright 2003-2004 The Apache Software Foundation
+ 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.
+ 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.
-->
-
<!--+
| This is the Apache Cocoon command line configuration file.
| Here you give the command line interface details of where
@@ -40,7 +39,16 @@
| to match the mime type
| (e.g. text/html->.html)
|
- | CVS: $Id$
+ | Note: Whilst using an xconf file to configure the Cocoon
+ | Command Line gives access to more features, the use of
+ | command line parameters is more stable, as there are
+ | currently plans to improve the xconf format to allow
+ | greater flexibility. If you require a stable and
+ | consistent method for accessing the CLI, it is recommended
+ | that you use the command line parameters to configure
+ | the CLI. See documentation at:
+ | /userdocs/offline/index.html and Wiki:CommandLine
+ |
+-->
<cocoon verbose="true"
@@ -49,6 +57,33 @@
confirm-extensions="false">
<!--+
+ | The context directory is usually the webapp directory
+ | containing the sitemap.xmap file.
+ |
+ | The config file is the cocoon.xconf file.
+ |
+ | The work directory is used by Cocoon to store temporary
+ | files and cache files.
+ |
+ | The destination directory is where generated pages will
+ | be written (assuming the 'simple' mapper is used, see
+ | below)
+ +-->
+ <context-dir>.</context-dir>
+ <config-file>WEB-INF/cocoon.xconf</config-file>
+ <work-dir>../tmp/cocoon-work</work-dir>
+ <dest-dir>../site</dest-dir>
+
+ <!--+
+ | A checksum file can be used to store checksums for pages
+ | as they are generated. When the site is next generated,
+ | files will not be written if their checksum has not changed.
+ | This means that it will be easier to detect which files
+ | need to be uploaded to a server, using the timestamp.
+ +-->
+ <!-- <checksums-uri>build/work/checksums</checksums-uri>-->
+
+ <!--+
| Broken link reporting options:
| Report into a text file, one link per line:
| <broken-links type="text" report="filename"/>
@@ -56,15 +91,15 @@
| <broken-links type="xml" report="filename"/>
| Ignore broken links (default):
| <broken-links type="none"/>
- | When a page includes an error, should a page be generated?
- |
+ |
| Two attributes to this node specify whether a page should
- | be generated when an error occured. 'generate' specifies
+ | be generated when an error has occured. 'generate' specifies
| whether a page should be generated (default: true) and
| extension specifies an extension that should be appended
| to the generated page's filename (default: none)
- | <broken-links generate="true" extension=".error.txt"/>
|
+ | Using this, a quick scan through the destination directory
+ | will show broken links, by their filename extension.
+-->
<broken-links type="xml"
file="../brokenlinks.xml"
@@ -82,96 +117,196 @@
-->
<!--+
- |
- +-->
- <logging log-kit="WEB-INF/logkit.xconf" logger="cli" level="ERROR" />
-
- <!--+
- | The context directory is usually the webapp directory
- | containing the sitemap.xmap file.
- |
- | The config file is the cocoon.xconf file.
- |
- | The work directory is used by Cocoon to store temporary
- | files and cache files.
- |
- | The destination directory is where generated pages will
- | be written (assuming the 'simple' mapper is used)
+ | Configures logging.
+ | The 'log-kit' parameter specifies the location of the log kit
+ | configuration file (usually called logkit.xconf.
+ |
+ | Logger specifies the logging category (for all logging prior
+ | to other Cocoon logging categories taking over)
+ |
+ | Available log levels are:
+ | DEBUG: prints all level of log messages.
+ | INFO: prints all level of log messages except DEBUG
+ | ones.
+ | WARN: prints all level of log messages except DEBUG
+ | and INFO ones.
+ | ERROR: prints all level of log messages except DEBUG,
+ | INFO and WARN ones.
+ | FATAL_ERROR: prints only log messages of this level
+-->
- <context-dir>.</context-dir>
- <config-file>WEB-INF/cocoon.xconf</config-file>
- <work-dir>../temp/docs</work-dir>
- <!-- Overridden in forrest.build.xml
- <dest-dir>../docs</dest-dir>
- -->
+ <!-- <logging log-kit="WEB-INF/logkit.xconf" logger="cli" level="ERROR" /> -->
<!--+
- | Specifies the filename to be appended to URIs that
- | refer to a directory (i.e. end with a forward slash).
+ | Specifies the filename to be appended to URIs that
+ | refer to a directory (i.e. end with a forward slash).
+-->
<default-filename>index.html</default-filename>
<!--+
| Specifies a user agent string to the sitemap when
| generating the site.
+ |
+ | A generic term for a web browser is "user agent". Any
+ | user agent, when connecting to a web server, will provide
+ | a string to identify itself (e.g. as Internet Explorer or
+ | Mozilla). It is possible to have Cocoon serve different
+ | content depending upon the user agent string provided by
+ | the browser. If your site does this, then you may want to
+ | use this <user-agent> entry to provide a 'fake' user agent
+ | to Cocoon, so that it generates the correct version of your
+ | site.
+ |
+ | For most sites, this can be ignored.
+-->
<!--
- <user-agent>xxx</user-agent>
+ <user-agent>Cocoon Command Line Environment 2.1</user-agent>
-->
<!--+
| Specifies an accept string to the sitemap when generating
| the site.
+ | User agents can specify to an HTTP server what types of content
+ | (by mime-type) they are able to receive. E.g. a browser may be
+ | able to handle jpegs, but not pngs. The HTTP accept header
+ | allows the server to take the browser's capabilities into account,
+ | and only send back content that it can handle.
+ |
+ | For most sites, this can be ignored.
+-->
+
<accept>*/*</accept>
<!--+
- | Specifies the URIs that should be generated (using <uri>
- | elements, and (if necessary) what should be done with the
- | generated pages.
- |
- | The old behaviour - appends uri to the specified destination
- | directory (as specified in <dest-dir>):
+ | Specifies which URIs should be included or excluded, according
+ | to wildcard patterns.
+ |
+ | These includes/excludes are only relevant when you are following
+ | links. A link URI must match an include pattern (if one is given)
+ | and not match an exclude pattern, if it is to be followed by
+ | Cocoon. It can be useful, for example, where there are links in
+ | your site to pages that are not generated by Cocoon, such as
+ | references to api-documentation.
+ |
+ | By default, all URIs are included. If both include and exclude
+ | patterns are specified, a URI is first checked against the
+ | include patterns, and then against the exclude patterns.
+ |
+ | Multiple patterns can be given, using muliple include or exclude
+ | nodes.
+ |
+ | The order of the elements is not significant, as only the first
+ | successful match of each category is used.
+ |
+ | Currently, only the complete source URI can be matched (including
+ | any URI prefix). Future plans include destination URI matching
+ | and regexp matching. If you have requirements for these, contact
+ | dev@cocoon.apache.org.
+ +-->
+
+ <exclude pattern="**/"/>
+ <exclude pattern="**apidocs**"/>
+ <exclude pattern="api/**"/>
+ <exclude pattern="c/apiDocs/**"/>
+ <exclude pattern="Java/api/**"/>
+
+ <exclude pattern="site:**"/>
+ <exclude pattern="ext:**"/>
+
+ <!-- Exclude tokens used in URLs to ASF mirrors (interpreted by a CGI) -->
+ <exclude pattern="[preferred]/**"/>
+ <exclude pattern="[location]"/>
+
+ <!-- <include-links extension=".html"/>-->
+
+ <!--+
+ | <uri> nodes specify the URIs that should be generated, and
+ | where required, what should be done with the generated pages.
+ | They describe the way the URI of the generated file is created
+ | from the source page's URI. There are three ways that a generated
+ | file URI can be created: append, replace and insert.
|
- | <uri>documents/index.html</uri>
+ | The "type" attribute specifies one of (append|replace|insert):
|
- | Append: append the generated page's URI to the end of the
- | source URI:
+ | append:
+ | Append the generated page's URI to the end of the source URI:
|
| <uri type="append" src-prefix="documents/" src="index.html"
| dest="build/dest/"/>
|
- | Replace: Completely ignore the generated page's URI - just
+ | This means that
+ | (1) the "documents/index.html" page is generated
+ | (2) the file will be written to "build/dest/documents/index.html"
+ |
+ | replace:
+ | Completely ignore the generated page's URI - just
| use the destination URI:
|
| <uri type="replace" src-prefix="documents/" src="index.html"
| dest="build/dest/docs.html"/>
+ |
+ | This means that
+ | (1) the "documents/index.html" page is generated
+ | (2) the result is written to "build/dest/docs.html"
+ | (3) this works only for "single" pages - and not when links
+ | are followed
|
- | Insert: Insert generated page's URI into the destination
+ | insert:
+ | Insert generated page's URI into the destination
| URI at the point marked with a * (example uses fictional
| zip protocol)
|
| <uri type="insert" src-prefix="documents/" src="index.html"
| dest="zip://*.zip/page.html"/>
|
+ | This means that
+ | (1)
+ |
+ | In any of these scenarios, if the dest attribute is omitted,
+ | the value provided globally using the <dest-dir> node will
+ | be used instead.
+-->
+ <!--
+ <uri type="replace"
+ src-prefix="samples/"
+ src="hello-world/hello.html"
+ dest="build/dest/hello-world.html"/>
+ -->
<!--+
- | Excludes added to XML Web site to allow mirrors.ehtml to
- | build properly
+ | <uri> nodes can be grouped together in a <uris> node. This
+ | enables a group of URIs to share properties. The following
+ | properties can be set for a group of URIs:
+ | * follow-links: should pages be crawled for links
+ | * confirm-extensions: should file extensions be checked
+ | for the correct mime type
+ | * src-prefix: all source URIs should be
+ | pre-pended with this prefix before
+ | generation. The prefix is not
+ | included when calculating the
+ | destination URI
+ | * dest: the base destination URI to be
+ | shared by all pages in this group
+ | * type: the method to be used to calculate
+ | the destination URI. See above
+ | section on <uri> node for details.
+ |
+ | Each <uris> node can have a name attribute. When a name
+ | attribute has been specified, the -n switch on the command
+ | line can be used to tell Cocoon to only process the URIs
+ | within this URI group. When no -n switch is given, all
+ | <uris> nodes are processed. Thus, one xconf file can be
+ | used to manage multiple sites.
+-->
- <exclude pattern="c/apiDocs/**" />
- <exclude pattern="Java/api/**" />
-
- <uri src="favicon.ico"/>
+ <!--
+ <uris name="mirrors" follow-links="false">
+ <uri type="append" src="mirrors.html"/>
+ </uris>
+ -->
<!--+
- | File containing URIs (plain text, one per
- | line).
+ | File containing URIs (plain text, one per line).
+-->
<!--
- <uri-file></uri-file>
+ <uri-file>uris.txt</uri-file>
-->
-
</cocoon>
-