forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r399194 - /forrest/trunk/site-author/conf/cli.xconf
Date Wed, 03 May 2006 07:58:52 GMT
Author: crossley
Date: Wed May  3 00:58:51 2006
New Revision: 399194

URL: http://svn.apache.org/viewcvs?rev=399194&view=rev
Log:
Synchronise with ../main/webapp/WEB-INF/cli.xconf
Trailing whitespace and minor text changes only.

Modified:
    forrest/trunk/site-author/conf/cli.xconf

Modified: forrest/trunk/site-author/conf/cli.xconf
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/conf/cli.xconf?rev=399194&r1=399193&r2=399194&view=diff
==============================================================================
--- forrest/trunk/site-author/conf/cli.xconf (original)
+++ forrest/trunk/site-author/conf/cli.xconf Wed May  3 00:58:51 2006
@@ -16,7 +16,7 @@
   limitations under the License.
 -->
 <!--+
-    |  This is the Apache Cocoon command line configuration file. 
+    |  This is the Apache Cocoon command line configuration file.
     |  Here you give the command line interface details of where
     |  to find various aspects of your Cocoon installation.
     |
@@ -24,37 +24,38 @@
     |  that you wish to generate.
     |
     |  The current configuration information in this file is for
-    |  building the Cocoon documentation. Therefore, all links here 
-    |  are relative to the build context dir, which, in the build.xml 
-    |  file, is set to ${build.context} 
+    |  building the Cocoon documentation. Therefore, all links here
+    |  are relative to the build context dir, which, in the build.xml
+    |  file, is set to ${build.context}
     |
     |  Options:
     |    verbose:            increase amount of information presented
     |                        to standard output (default: false)
-    |    follow-links:       whether linked pages should also be 
+    |    follow-links:       whether linked pages should also be
     |                        generated (default: true)
-    |    precompile-only:    precompile sitemaps and XSP pages, but 
+    |    precompile-only:    precompile sitemaps and XSP pages, but
     |                        do not generate any pages (default: false)
     |    confirm-extensions: check the mime type for the generated page
     |                        and adjust filename and links extensions
-    |                        to match the mime type 
+    |                        to match the mime type
     |                        (e.g. text/html->.html)
     |
-    |  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 
+    |  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 
+    |        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
+    |        http://cocoon.apache.org/2.1/userdocs/offline/
+    |        http://wiki.apache.org/cocoon/CommandLine
     |
     +-->
-    
-<cocoon verbose="true"  
-        follow-links="true" 
-        precompile-only="false" 
+
+<cocoon verbose="true"
+        follow-links="true"
+        precompile-only="false"
         confirm-extensions="false">
 
    <!--+
@@ -67,20 +68,23 @@
        |  files and cache files.
        |
        |  The destination directory is where generated pages will
-       |  be written (assuming the 'simple' mapper is used, see 
+       |  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, 
+       |  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 
+       |  This means that it will be easier to detect which files
        |  need to be uploaded to a server, using the timestamp.
+       |
+       |  The default path is relative to the core webapp directory.
+       |  An asolute path can be used.
        +-->
    <!--   <checksums-uri>build/work/checksums</checksums-uri>-->
 
@@ -94,7 +98,7 @@
        |     <broken-links type="none"/>
        |
        |   Two attributes to this node specify whether a page should
-       |   be generated when an error has 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)
@@ -102,7 +106,7 @@
        |   Using this, a quick scan through the destination directory
        |   will show broken links, by their filename extension.
        +-->
-   <broken-links type="xml" 
+   <broken-links type="xml"
                  file="../brokenlinks.xml"
                  generate="false"
                  extension=".error"
@@ -119,20 +123,20 @@
    -->
 
    <!--+
-       |  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 
+       |  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 
+       |    INFO:         prints all level of log messages except DEBUG
        |                  ones.
-       |    WARN:         prints all level of log messages except DEBUG 
+       |    WARN:         prints all level of log messages except DEBUG
        |                  and INFO ones.
-       |    ERROR:        prints all level of log messages except DEBUG, 
+       |    ERROR:        prints all level of log messages except DEBUG,
        |                  INFO and WARN ones.
        |    FATAL_ERROR:  prints only log messages of this level
        +-->
@@ -148,7 +152,7 @@
        |  Specifies a user agent string to the sitemap when
        |  generating the site.
        |
-       |  A generic term for a web browser is "user agent". Any 
+       |  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
@@ -157,7 +161,7 @@
        |  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.
        +-->
    <!--
@@ -168,8 +172,8 @@
        |  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 
+       |  (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.
        |
@@ -177,30 +181,30 @@
        +-->
 
    <accept>*/*</accept>
-   
+
    <!--+
        | Specifies which URIs should be included or excluded, according
-       | to wildcard patterns. 
-       | 
+       | 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) 
+       | 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 
+       | 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 
+       | 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 
+       | 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 
+       | any URI prefix). Future plans include destination URI matching
        | and regexp matching. If you have requirements for these, contact
        | dev@cocoon.apache.org.
        +-->
@@ -226,9 +230,9 @@
    <exclude pattern="[location]"/>
 
    <!--   <include-links extension=".html"/>-->
-   
+
    <!--+
-       |  <uri> nodes specify the URIs that should be generated, and 
+       |  <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
@@ -242,68 +246,68 @@
        |   <uri type="append" src-prefix="documents/" src="index.html"
        |   dest="build/dest/"/>
        |
-       |  This means that 
+       |  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 
+       |  Completely ignore the generated page's URI - just
        |  use the destination URI:
        |
-       |   <uri type="replace" src-prefix="documents/" src="index.html" 
+       |   <uri type="replace" src-prefix="documents/" src="index.html"
        |   dest="build/dest/docs.html"/>
-       |  
-       |  This means that 
+       |
+       |  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 
-       |  URI at the point marked with a * (example uses fictional 
+       |  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" 
+       |   <uri type="insert" src-prefix="documents/" src="index.html"
        |   dest="zip://*.zip/page.html"/>
        |
-       |  This means that 
+       |  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 
+       |  the value provided globally using the <dest-dir> node will
        |  be used instead.
        +-->
    <!--
-   <uri type="replace" 
-        src-prefix="samples/" 
+   <uri type="replace"
+        src-prefix="samples/"
         src="hello-world/hello.html"
         dest="build/dest/hello-world.html"/>
    -->
 
    <!--+
-       | <uri> nodes can be grouped together in a <uris> node. This 
+       | <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 
+       |   * src-prefix:         all source URIs should be
        |                         pre-pended with this prefix before
-       |                         generation. The prefix is not 
-       |                         included when calculating the 
+       |                         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 
+       |                         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 
+       | 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.
        +-->
 



Mime
View raw message