/[debian]/libjempbox-java/trunk/website/cli.xconf
ViewVC logotype

Annotation of /libjempbox-java/trunk/website/cli.xconf

Parent Directory Parent Directory | Revision Log Revision Log


Revision 429 - (hide annotations)
Fri Nov 17 21:04:22 2006 UTC (14 years, 10 months ago) by gregoa
File size: 13120 byte(s)
[svn-inject] Forking libjempbox-java source to Trunk
1 gregoa 427 <?xml version="1.0"?>
2     <!--
3     Copyright 2002-2004 The Apache Software Foundation
4    
5     Licensed under the Apache License, Version 2.0 (the "License");
6     you may not use this file except in compliance with the License.
7     You may obtain a copy of the License at
8    
9     http://www.apache.org/licenses/LICENSE-2.0
10    
11     Unless required by applicable law or agreed to in writing, software
12     distributed under the License is distributed on an "AS IS" BASIS,
13     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14     See the License for the specific language governing permissions and
15     limitations under the License.
16     -->
17     <!--+
18     | This is the Apache Cocoon command line configuration file.
19     | Here you give the command line interface details of where
20     | to find various aspects of your Cocoon installation.
21     |
22     | If you wish, you can also use this file to specify the URIs
23     | that you wish to generate.
24     |
25     | The current configuration information in this file is for
26     | building the Cocoon documentation. Therefore, all links here
27     | are relative to the build context dir, which, in the build.xml
28     | file, is set to ${build.context}
29     |
30     | Options:
31     | verbose: increase amount of information presented
32     | to standard output (default: false)
33     | follow-links: whether linked pages should also be
34     | generated (default: true)
35     | precompile-only: precompile sitemaps and XSP pages, but
36     | do not generate any pages (default: false)
37     | confirm-extensions: check the mime type for the generated page
38     | and adjust filename and links extensions
39     | to match the mime type
40     | (e.g. text/html->.html)
41     |
42     | Note: Whilst using an xconf file to configure the Cocoon
43     | Command Line gives access to more features, the use of
44     | command line parameters is more stable, as there are
45     | currently plans to improve the xconf format to allow
46     | greater flexibility. If you require a stable and
47     | consistent method for accessing the CLI, it is recommended
48     | that you use the command line parameters to configure
49     | the CLI. See documentation at:
50     | /userdocs/offline/index.html and Wiki:CommandLine
51     |
52     +-->
53    
54     <cocoon verbose="true"
55     follow-links="true"
56     precompile-only="false"
57     confirm-extensions="false">
58    
59     <!--+
60     | The context directory is usually the webapp directory
61     | containing the sitemap.xmap file.
62     |
63     | The config file is the cocoon.xconf file.
64     |
65     | The work directory is used by Cocoon to store temporary
66     | files and cache files.
67     |
68     | The destination directory is where generated pages will
69     | be written (assuming the 'simple' mapper is used, see
70     | below)
71     +-->
72     <context-dir>.</context-dir>
73     <config-file>WEB-INF/cocoon.xconf</config-file>
74     <work-dir>../tmp/cocoon-work</work-dir>
75     <dest-dir>../site</dest-dir>
76    
77     <!--+
78     | A checksum file can be used to store checksums for pages
79     | as they are generated. When the site is next generated,
80     | files will not be written if their checksum has not changed.
81     | This means that it will be easier to detect which files
82     | need to be uploaded to a server, using the timestamp.
83     +-->
84     <!-- <checksums-uri>build/work/checksums</checksums-uri>-->
85    
86     <!--+
87     | Broken link reporting options:
88     | Report into a text file, one link per line:
89     | <broken-links type="text" report="filename"/>
90     | Report into an XML file:
91     | <broken-links type="xml" report="filename"/>
92     | Ignore broken links (default):
93     | <broken-links type="none"/>
94     |
95     | Two attributes to this node specify whether a page should
96     | be generated when an error has occured. 'generate' specifies
97     | whether a page should be generated (default: true) and
98     | extension specifies an extension that should be appended
99     | to the generated page's filename (default: none)
100     |
101     | Using this, a quick scan through the destination directory
102     | will show broken links, by their filename extension.
103     +-->
104     <broken-links type="xml"
105     file="../brokenlinks.xml"
106     generate="false"
107     extension=".error"/>
108    
109     <!--+
110     | Load classes at startup. This is necessary for generating
111     | from sites that use SQL databases and JDBC.
112     | The <load-class> element can be repeated if multiple classes
113     | are needed.
114     +-->
115     <!--
116     <load-class>org.firebirdsql.jdbc.Driver</load-class>
117     -->
118    
119     <!--+
120     | Configures logging.
121     | The 'log-kit' parameter specifies the location of the log kit
122     | configuration file (usually called logkit.xconf.
123     |
124     | Logger specifies the logging category (for all logging prior
125     | to other Cocoon logging categories taking over)
126     |
127     | Available log levels are:
128     | DEBUG: prints all level of log messages.
129     | INFO: prints all level of log messages except DEBUG
130     | ones.
131     | WARN: prints all level of log messages except DEBUG
132     | and INFO ones.
133     | ERROR: prints all level of log messages except DEBUG,
134     | INFO and WARN ones.
135     | FATAL_ERROR: prints only log messages of this level
136     +-->
137     <!-- <logging log-kit="WEB-INF/logkit.xconf" logger="cli" level="ERROR" /> -->
138    
139     <!--+
140     | Specifies the filename to be appended to URIs that
141     | refer to a directory (i.e. end with a forward slash).
142     +-->
143     <default-filename>index.html</default-filename>
144    
145     <!--+
146     | Specifies a user agent string to the sitemap when
147     | generating the site.
148     |
149     | A generic term for a web browser is "user agent". Any
150     | user agent, when connecting to a web server, will provide
151     | a string to identify itself (e.g. as Internet Explorer or
152     | Mozilla). It is possible to have Cocoon serve different
153     | content depending upon the user agent string provided by
154     | the browser. If your site does this, then you may want to
155     | use this <user-agent> entry to provide a 'fake' user agent
156     | to Cocoon, so that it generates the correct version of your
157     | site.
158     |
159     | For most sites, this can be ignored.
160     +-->
161     <!--
162     <user-agent>Cocoon Command Line Environment 2.1</user-agent>
163     -->
164    
165     <!--+
166     | Specifies an accept string to the sitemap when generating
167     | the site.
168     | User agents can specify to an HTTP server what types of content
169     | (by mime-type) they are able to receive. E.g. a browser may be
170     | able to handle jpegs, but not pngs. The HTTP accept header
171     | allows the server to take the browser's capabilities into account,
172     | and only send back content that it can handle.
173     |
174     | For most sites, this can be ignored.
175     +-->
176    
177     <accept>*/*</accept>
178    
179     <!--+
180     | Specifies which URIs should be included or excluded, according
181     | to wildcard patterns.
182     |
183     | These includes/excludes are only relevant when you are following
184     | links. A link URI must match an include pattern (if one is given)
185     | and not match an exclude pattern, if it is to be followed by
186     | Cocoon. It can be useful, for example, where there are links in
187     | your site to pages that are not generated by Cocoon, such as
188     | references to api-documentation.
189     |
190     | By default, all URIs are included. If both include and exclude
191     | patterns are specified, a URI is first checked against the
192     | include patterns, and then against the exclude patterns.
193     |
194     | Multiple patterns can be given, using muliple include or exclude
195     | nodes.
196     |
197     | The order of the elements is not significant, as only the first
198     | successful match of each category is used.
199     |
200     | Currently, only the complete source URI can be matched (including
201     | any URI prefix). Future plans include destination URI matching
202     | and regexp matching. If you have requirements for these, contact
203     | dev@cocoon.apache.org.
204     +-->
205    
206     <exclude pattern="**/"/>
207     <exclude pattern="**apidocs**"/>
208     <exclude pattern="**javadoc**"/>
209     <exclude pattern="api/**"/>
210     <exclude pattern="**/images/**"/>
211    
212     <exclude pattern="site:**"/>
213     <exclude pattern="ext:**"/>
214    
215     <!-- Exclude tokens used in URLs to ASF mirrors (interpreted by a CGI) -->
216     <exclude pattern="[preferred]/**"/>
217     <exclude pattern="[location]"/>
218    
219     <!-- <include-links extension=".html"/>-->
220    
221     <!--+
222     | <uri> nodes specify the URIs that should be generated, and
223     | where required, what should be done with the generated pages.
224     | They describe the way the URI of the generated file is created
225     | from the source page's URI. There are three ways that a generated
226     | file URI can be created: append, replace and insert.
227     |
228     | The "type" attribute specifies one of (append|replace|insert):
229     |
230     | append:
231     | Append the generated page's URI to the end of the source URI:
232     |
233     | <uri type="append" src-prefix="documents/" src="index.html"
234     | dest="build/dest/"/>
235     |
236     | This means that
237     | (1) the "documents/index.html" page is generated
238     | (2) the file will be written to "build/dest/documents/index.html"
239     |
240     | replace:
241     | Completely ignore the generated page's URI - just
242     | use the destination URI:
243     |
244     | <uri type="replace" src-prefix="documents/" src="index.html"
245     | dest="build/dest/docs.html"/>
246     |
247     | This means that
248     | (1) the "documents/index.html" page is generated
249     | (2) the result is written to "build/dest/docs.html"
250     | (3) this works only for "single" pages - and not when links
251     | are followed
252     |
253     | insert:
254     | Insert generated page's URI into the destination
255     | URI at the point marked with a * (example uses fictional
256     | zip protocol)
257     |
258     | <uri type="insert" src-prefix="documents/" src="index.html"
259     | dest="zip://*.zip/page.html"/>
260     |
261     | This means that
262     | (1)
263     |
264     | In any of these scenarios, if the dest attribute is omitted,
265     | the value provided globally using the <dest-dir> node will
266     | be used instead.
267     +-->
268     <!--
269     <uri type="replace"
270     src-prefix="samples/"
271     src="hello-world/hello.html"
272     dest="build/dest/hello-world.html"/>
273     -->
274    
275     <!--+
276     | <uri> nodes can be grouped together in a <uris> node. This
277     | enables a group of URIs to share properties. The following
278     | properties can be set for a group of URIs:
279     | * follow-links: should pages be crawled for links
280     | * confirm-extensions: should file extensions be checked
281     | for the correct mime type
282     | * src-prefix: all source URIs should be
283     | pre-pended with this prefix before
284     | generation. The prefix is not
285     | included when calculating the
286     | destination URI
287     | * dest: the base destination URI to be
288     | shared by all pages in this group
289     | * type: the method to be used to calculate
290     | the destination URI. See above
291     | section on <uri> node for details.
292     |
293     | Each <uris> node can have a name attribute. When a name
294     | attribute has been specified, the -n switch on the command
295     | line can be used to tell Cocoon to only process the URIs
296     | within this URI group. When no -n switch is given, all
297     | <uris> nodes are processed. Thus, one xconf file can be
298     | used to manage multiple sites.
299     +-->
300     <!--
301     <uris name="mirrors" follow-links="false">
302     <uri type="append" src="mirrors.html"/>
303     </uris>
304     -->
305    
306     <!--+
307     | File containing URIs (plain text, one per line).
308     +-->
309     <!--
310     <uri-file>uris.txt</uri-file>
311     -->
312     </cocoon>

  ViewVC Help
Powered by ViewVC 1.1.26