[DAISY] Updated: Configuring Cocoon with build.properties

[da...@cocoon.zones.apache.org]

A document has been updated:

Document ID: 30
Branch: main
Language: default
Name: Configuring Cocoon with build.properties (unchanged)
Document Type: Simple Document (unchanged)
Updated on: 6/10/05 3:47:18 PM
Updated by: Mark Leicester

A new version has been created, state: draft

Parts
=====
Content
-------
This part has been updated.
Mime type: text/xml (unchanged)
File name:  (unchanged)
Size: 9477 bytes (previous version: 10329 bytes)
Content diff:
(11 equal lines skipped)
    <li>build.properties in the Cocoon root directory.</li>
    </ol>
    
--- <p>For example, if your cocoon.build.properties contains the line
--- "exclude.webapp.javadocs=true" then this will take precedence over any settings
--- to the contrary in later files (i.e. in local.build.properties or
--- build.properties). The first file to set a property "wins".</p>
+++ <p>For more about property precedence, see the Property precedence section of
+++ <a href="daisy:29">The Cocoon Build System</a>.</p>
    
    <h1>Modifying build properties</h1>
    
--- <p>To override properties you will need to copy the existing build.properties
--- file from the Cocoon root directory to a new file called local.build.properties
--- also in your Cocoon root directory, or to cocoon.build.properties in your user
--- account's home directory.</p>
+++ <p>To modify build.properties you have one of two choices:</p>
    
--- <p>From build.properties (should be copied to local.build.properties):</p>
+++ <ul>
+++ <li>Copy build.properties to cocoon.build.properties in your user account's home
+++ directory (as in 1. above). Changes made in that file will only affect you.</li>
+++ <li>Copy build.properties to local.build.properties in the Cocoon root directory
+++ (as in 2. above). Changes made in that file will affect all users of your
+++ machine.</li>
+++ </ul>
    
+++ <p>Your copy of build.properties will contain the following properties.</p>
+++ 
    <pre># ---- Webapp ------------------------------------------------------------------
    
    #exclude.webapp.documentation=true
    #exclude.webapp.javadocs=true
--- #exclude.webapp.idldocs=true
--- #exclude.webapp.scratchpad=true
    #exclude.webapp.samples=true
+++ #exclude.webapp.test-suite=true
    </pre>
    
    <p>The above properties affect what is included <strong>in the webapp</strong>
(9 equal lines skipped)
    The link for the javadocs will also be excluded from the main welcome page.</p>
    </li>
    <li>
--- <p><strong>idldocs</strong> some modeling documentation on the flow object model
--- (FOM) described in idl. The link for the FOM docs will also be excluded from the
--- main welcome page.</p>
--- </li>
--- <li>
--- <p><strong>scratchpad</strong> new components or core functions under
--- experimental development. The components will not be configured in sitemap.map,
--- cocoon.xconf, etc.</p>
--- </li>
--- <li>
    <p><strong>samples</strong> the functioning samples. This excludes core, blocks
    and scratchpad samples. (blocks and scratchpad may not have been included anyway
    depending on your choices in other config options).</p>
(2 equal lines skipped)
    
    <pre># ---- Build Exclusions --------------------------------------------------------
    
--- #exclude.scratchpad=true
    #exclude.deprecated=true
+++ #exclude.documentation=true
    #exclude.javadocs=true
--- #exclude.idldocs=true
+++ # Include Java source code into the binary jar files
+++ #include.sources-in-jars=true
+++ # Include Java source code into separate, source only jar files
+++ #include.sources-jars=true
    </pre>
    
    <p>The above control what is actually assembled, whether they are included in
(10 equal lines skipped)
    <li>
    <p><strong>javadocs</strong> the javadocs will not be created at all</p>
    </li>
--- <li>
--- <p><strong>idldocs</strong> the idl FOM docs will not be created at all</p>
--- </li>
    </ul>
    
    <pre># ---- Configuration -----------------------------------------------------------
(3 equal lines skipped)
    #include.driver.odbc=true
    #config.allow-reloads=true
    #config.enable-uploads=true
+++ #config.enable-instrumentation=true
    </pre>
    
    <p>The above are convenience settings to control some init-params in web.xml.
(33 equal lines skipped)
    
    <pre># ---- Validation --------------------------------------------------------------
    
--- validate.config=true
--- validate.xdocs=true
--- validate.jars=true
+++ #exclude.validate.config=true
+++ #exclude.validate.xdocs=true
+++ #exclude.validate.jars=true
    </pre>
    
    <p>The validation targets ensure that various config files, documentation xml
(4 equal lines skipped)
    jars.xml. Only the lib/local directory is excluded from this requirement. The
    validate.jars target enforces this requirement.</p>
    
--- <pre># ---- Forrest -----------------------------------------------------------------
--- 
--- forrest.home=../xml-forrest/build/dist/shbat/
--- </pre>
--- 
--- <p>If present, Cocoon uses Forrest (an Apache project based on Cocoon focused on
--- building documentation) to build its own documentation. Forrest does not ship
--- with Cocoon because of the circular dependency it would create. If not present,
--- Cocoon still builds its own documentation.</p>
--- 
--- <p>NOTE: I am surmising this to be the case because I don't have Forrest present
--- on my machine and the docs still build with the old look
--- (<a href="http://wiki.apache.org/cocoon/GeoffHoward">GeoffHoward</a>). I have
--- not traced this through the build targets though.</p>
--- 
    <pre># ---- Build -------------------------------------------------------------------
    
    build.root=build
    build=${build.root}/${name}-${version}
    build.dest=${build}/classes
    build.mocks=${build}/mocks
    build.test=${build}/test
+++ build.test.output=${build.test}/output
+++ build.test.report=${build.test}/report
+++ build.test.htmlunit=${build.test}/htmlunit
+++ build.test.htmlunit.output=${build.test.htmlunit}/output
+++ build.test.htmlunit.report=${build.test.htmlunit}/report
    build.docs=${build}/docs
    build.docs.printer=${build}/printer-docs
    build.site=${build}/site
    build.xdocs=${build}/xdocs
--- build.idldocs=${build}/idldocs
    build.javadocs=${build}/javadocs
    build.context=${build}/documentation
    build.context.printer=${build}/printer-documentation
    build.blocks=${build}/blocks
    build.deprecated=${build}/deprecated
--- build.scratchpad=${build}/scratchpad
--- build.scratchpad.src=${build.scratchpad}/src
--- build.scratchpad.dest=${build.scratchpad}/dest
    build.samples=${build}/samples
    build.temp=${build}/temp
+++ build.mounttable=../../mount-table.xml
    
    build.docs.loglevel=ERROR
    build.docs.printer.loglevel=ERROR
(4 equal lines skipped)
    during the building of the regular docs and the printer friendly docs (if
    included).</p>
    
--- <pre># ------ Webapp Build Properties -----------------------------------------------
+++ <pre># ---- Webapp Build Properties -------------------------------------------------
    
    build.webapp=${build.root}/webapp
    build.webapp.webinf=${build.webapp}/WEB-INF
    build.webapp.classes=${build.webapp.webinf}/classes
    build.webapp.lib=${build.webapp.webinf}/lib
    build.webapp.samples=${build.webapp}/samples
+++ build.webapp.test-suite=${build.webapp}/test-suite
    build.webapp.docs=${build.webapp}/docs
    build.webapp.javadocs=${build.webapp}/api/java
--- build.webapp.idldocs=${build.webapp}/api/fom
    build.webapp.loglevel=INFO
    build.war=${build}/${name}.war
    </pre>
(13 equal lines skipped)
    </li>
    </ul>
    
--- <pre># ------ Standalone-demo Build Properties --------------------------------------
+++ <pre># ---- Standalone-demo Build Properties ----------------------------------------
+++ 
    build.standalone.demo=${build.root}/standalone-demo
    </pre>
    
(13 equal lines skipped)
    compiler.optimize=on
    compiler.deprecation=off
    compiler.nowarn=on
+++ source.vm=1.3
    </pre>
    
    <p>The above are compiler settings that would not normally need to be touched.
    </p>
    
--- <pre># ------ System Properties -----------------------------------------------------
+++ <pre># ---- System Properties -------------------------------------------------------
    
    # WARNING: you shouldn't need to modify anything below here since there is a
    # very high change of breaking the build system. Do it only if you know what
(3 equal lines skipped)
    <p>The properties following this warning have been ommited. If you have to ask,
    you shouldn't be messing with them!</p>
    
--- <h2>Q&amp;A</h2>
+++ <h1>FAQ</h1>
    
    <p><strong>Q:</strong> Can I add an #include.driver.mysql=true to the
    Configuration section; if so, perhaps this should be a commented line already
(10 equal lines skipped)


Fields
======
no changes

Links
=====
no changes

Custom Fields
=============
no changes

Collections
===========
no changes