gump-general mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From aj...@apache.org
Subject cvs commit: jakarta-gump/template/forrest forrest.properties status.xml forrest-targets.ent
Date Wed, 24 Sep 2003 20:13:48 GMT
ajack       2003/09/24 13:13:48

  Added:       template/forrest forrest.properties status.xml
                        forrest-targets.ent
  Log:
  Trying forrest.properties in yet another place...
  
  Revision  Changes    Path
  1.1                  jakarta-gump/template/forrest/forrest.properties
  
  Index: forrest.properties
  ===================================================================
  ##############
  # Properties used by forrest.build.xml for building the website
  ##############
  
  # Prints out a summary of Forrest settings for this project
  #forrest.echo=true 
  
  # Project name (used to name .war file)
  project.name=gump
  
  # Specifies name of Forrest skin to use
  #project.skin=forrest-site
  #project.skin=forrest-css
  #project.skin=avalon-tigris
  #project.skin=krysalis-site
  
  
  ##############
  # behavioural properties
  #project.menu-scheme=tab_attributes
  #project.menu-scheme=directories
  
  ##############
  # layout properties
  
  # Properties that must 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=forrest
  #project.conf-dir=${project.content-dir}/conf
  #project.sitemap-dir=${project.content-dir}
  #project.xdocs-dir=${project.content-dir}/content/xdocs
  #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 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
  
  # These props determine if validation is performed at all
  # Values are inherited unless overridden.
  # Eg, 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}
  #forrest.validate.sitemap=${forrest.validate}
  #forrest.validate.stylesheets=${forrest.validate}
  #forrest.validate.skins=${forrest.validate}
  #forrest.validate.skins.stylesheets=${forrest.validate.skins}
  
  
  # 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
  
  forrest.validate.failonerror=false
  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=index.html
  # Set logging level for messages printed to the console
  #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=Djava.awt.headless=true
  
  
  
  1.1                  jakarta-gump/template/forrest/status.xml
  
  Index: status.xml
  ===================================================================
  <?xml version="1.0"?>
  <status>
  
    <developers>
      <person name="Joe Bloggs"      email="joe@joescompany.org"      id="JB" />
      <!-- Add more people here -->
    </developers>
  
    <todo>
      <actions priority="high">
        <action context="docs" dev="JB">
          Customize this template project with your project's details.  This
          TODO list is generated from 'status.xml'.
        </action>
        <action context="docs" dev="JB">
          Add lots of content.  XML content goes in
          <code>src/documentation/content/xdocs</code>, or wherever the
          <code>${project.xdocs-dir}</code> property (set in
          <code>forrest.properties</code>) points.
        </action>
        <action context="feedback" dev="JB">
          Mail <link
            href="mailto:forrest-dev@xml.apache.org">forrest-dev@xml.apache.org</link>
          with feedback.
        </action>
      </actions>
      <!-- Add todo items. @context is an arbitrary string. Eg:
      <actions priority="high">
        <action context="code" dev="SN">
        </action>
      </actions>
      <actions priority="medium">
        <action context="docs" dev="open">
        </action>
      </actions>
      -->
    </todo>
  
    <changes>
      <!-- Add new releases here -->
      <release version="0.1" date="2002">
        <!-- Some action types have associated images. By default, images are
        defined for 'add', 'fix', 'remove' and 'update'. If you add
        src/documentation/resources/images/<foo>.jpg images, these will
          automatically be used for entries of type <foo>. -->
  
            <action dev="JB" type="add" context="admin">
              Initial Import
            </action>
            <!-- Sample action:
            <action dev="JB" type="fix" due-to="Joe Contributor"
              due-to-email="joec@apache.org" fixes-bug="123">
              Fixed a bug in the Foo class.
            </action>
            -->
          </release>
        </changes>
      </status>
  
  
  
  1.1                  jakarta-gump/template/forrest/forrest-targets.ent
  
  Index: forrest-targets.ent
  ===================================================================
  <!--
  This build.xml snippet contains Forrest targets for Ant 1.5+.  It checks that
  the user has set ${forrest.home}, either in one of:
    build.properties
    project.properties
    ant.properties
    .ant.properties
  or with the FORREST_HOME environment variable, and prints an informative error
  message if not found.
  
  Usage:
  1) Copy this file to somewhere in your project.
  2) Add the following to the top of your project's Ant build.xml script
  (adjusting the path):
  
    <!DOCTYPE project [
      <!ENTITY forrest-targets SYSTEM "file:./forrest-targets.ent">
    ]>
  
  3) Before the closing '</project>' in your build.xml, add this:
  
    &forrest-targets;
    
  This is like expanding a macro: it pulls in the contents of this file.
  
  A minimal build.xml would thus be:
  
  <!DOCTYPE project [
  <!ENTITY forrest-targets SYSTEM "file:./forrest-targets.ent">
  ]>
  
  <project default="site">
      &forrest-targets;
  </project>
  -->
  
    <target name="site" depends="forrest.init" description="Generates static HTML documentation">
      <ant antfile="${forrest.home}/forrest.antproxy.xml" target="site"/>
    </target>
  
    <target name="webapp" depends="forrest.init" description="Generates an unpackaged webapp
of the website">
      <ant antfile="${forrest.home}/forrest.antproxy.xml" target="webapp"/>
    </target>
  
    <target name="war" depends="forrest.init" description="Generates a .war file containing
the website">
      <ant antfile="${forrest.home}/forrest.antproxy.xml" target="war"/>
    </target>
  
    <target name="validate" depends="forrest.init" description="Validates XML documentation
files">
      <ant antfile="${forrest.home}/forrest.antproxy.xml" target="validate"/>
    </target>
  
    <target name="forrest.init" depends="forrest.sethome, forrest.home.defined"/>
  
    <target name="forrest.sethome" depends="forrest.loadenv,
    forrest.checkenv, forrest.checkhome, forrest.check-build.properties,
    forrest.check-project.properties, forrest.check-ant.properties,
    forrest.check-.ant.properties"/>
  
    <target name="forrest.loadenv" unless="forrest.home.present">
      <property environment="env"/>
      <echo level="verbose">Forrest: Got ${env.FORREST_HOME}</echo>
    </target>
  
    <target name="forrest.checkenv" if="env.FORREST_HOME">
      <echo level="verbose">Found $FORREST_HOME..</echo>
      <property name="forrest.home" location="${env.FORREST_HOME}"/>
      <echo level="verbose">forrest.home set to ${forrest.home}</echo>
      <available file="${forrest.home}" type="dir" property="forrest.home.present"/>
    </target>
  
  
    <target name="forrest.checkhome">
      <available file="${forrest.home}" type="dir" property="forrest.home.present"/>
      <available file="build.properties" type="file" property="build.properties.present"/>
      <available file="project.properties" type="file" property="project.properties.present"/>
      <available file="ant.properties" type="file" property="ant.properties.present"/>
      <available file=".ant.properties" type="file" property=".ant.properties.present"/>
    </target>
  
    <!-- No we can't extract the commonalities below into an antcall'ed target,
    because it wouldn't be able to set forrest.home -->
    <target name="forrest.check-build.properties" unless="forrest.home.present"
    if="build.properties.present">
      <echo level="verbose">Forrest: Checking build.properties..</echo>
      <loadproperties srcfile="build.properties">
        <filterchain>
          <linecontains>
            <contains value="forrest.home"/>
          </linecontains>
        </filterchain>
      </loadproperties>
      <available file="${forrest.home}" type="dir" property="forrest.home.present"/>
  
    </target>
  
    <target name="forrest.check-project.properties" unless="forrest.home.present"
    if="project.properties.present">
      <echo level="verbose">Forrest: Checking project.properties..</echo>
      <loadproperties srcfile="project.properties">
        <filterchain>
          <linecontains>
            <contains value="forrest.home"/>
          </linecontains>
        </filterchain>
      </loadproperties>
      <available file="${forrest.home}" type="dir" property="forrest.home.present"/>
    </target>
  
    <target name="forrest.check-ant.properties" unless="forrest.home.present"
    if="ant.properties.present">
      <echo level="verbose">Forrest: Checking ant.properties..</echo>
      <loadproperties srcfile="ant.properties">
        <filterchain>
          <linecontains>
            <contains value="forrest.home"/>
          </linecontains>
        </filterchain>
      </loadproperties>
      <available file="${forrest.home}" type="dir" property="forrest.home.present"/>
    </target>
  
    <target name="forrest.check-.ant.properties" unless="forrest.home.present"
    if=".ant.properties.present">
      <echo level="verbose">Forrest: Checking .ant.properties..</echo>
      <loadproperties srcfile=".ant.properties">
        <filterchain>
          <linecontains>
            <contains value="forrest.home"/>
          </linecontains>
        </filterchain>
      </loadproperties>
      <available file="${forrest.home}" type="dir" property="forrest.home.present"/>
    </target>
  
    <target name="forrest.home.defined" depends="forrest.sethome" unless="forrest.home.present">
      <property name="path" value="${user.home}/xml-forrest/build/dist/shbat"/>
      <pathconvert targetos="windows" property="winpath">
        <path>
          <pathelement location="${path}"/>
        </path>
      </pathconvert>
      <pathconvert targetos="unix" property="unixpath">
        <path>
          <pathelement
            location="${path}"/>
        </path>
      </pathconvert>
  
      <echo>
        ----------------------------------------------
        To run this target, you need Forrest installed.
        Please do the following:
  
        export CVSROOT=:pserver:anoncvs@cvs.apache.org:/home/cvspublic
        cvs checkout xml-forrest
        cd xml-forrest
        build      (Windows)
        ./build.sh (Unix)
  
        Then either:
  
        - Set FORREST_HOME as the Forrest build instructions describe
        - Create a build.properties, with the forrest.home property pointing to
          the forrest shbat directory, eg:
  
          forrest.home=${winpath}  (Windows)
          forrest.home=${unixpath}  (Unix)
  
          (adjusting the path according to where your xml-forrest is)
        ----------------------------------------------
      </echo>
      <fail message="Need to define $${forrest.home}"/>
    </target>
  
  
  

Mime
View raw message