You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@forrest.apache.org by Thorsten Scherler <th...@apache.org> on 2006/08/03 08:57:39 UTC

Re: minimal forrest.properties (Was: r428188: main/fresh-site/ main/template-sites/basic/ ...)

El jue, 03-08-2006 a las 10:00 +1000, David Crossley escribió:
> thorsten@apache.org wrote:
> > Author: thorsten
> > Date: Wed Aug  2 16:29:56 2006
> > New Revision: 428188
> > 
> > URL: http://svn.apache.org/viewvc?rev=428188&view=rev
> > Log:
> > FOR-799 - remove all references from the core to the dispatcher
> > I removed all properties related to the dispatcher (or former versions) from the core.
> > This includes cleaning 
> >  - basic (further switched to a minimal config) and fresh-site seed forrest.properties
> 
> I previously tried to trim down the templates/basic/forrest.properties
> and was asked to revert it:

http://marc.theaimsgroup.com/?l=forrest-dev&w=2&r=1&s=r366100&q=b
I am still the same opinion as back then.

Further I created the basic seed to not have to senseless remove code
that I do not need. The basic seed is a slim down and clean startup for
projects from scratch.

Regarding Ross comment in
http://marc.theaimsgroup.com/?l=forrest-dev&m=113647830724990&w=2
"...These are used by users as a 
starting point and therefore extra documentation in there will reduce 
the number of questions we get on the mailing lists..."

The basic seed is for advanced user of forrest, that already played a
round with the samples and want to start from scratch. I do not think
that someone will ask regarding the basic seed.

salu2

> 
> ------------------------------------------------------------------------
> r366423 | crossley | 2006-01-06 15:30:07 +1100 (Fri, 06 Jan 2006) | 3 lines
> 
> Add duplicate full forrest.properties to "basic" and "business" seeds.
> Please keep these synchronised with the master copy in main/fresh-site
> 
> ------------------------------------------------------------------------
> r366100 | crossley | 2006-01-05 18:01:23 +1100 (Thu, 05 Jan 2006) | 2 lines
> 
> Use minimal forrest.properties files.
> ------------------------------------------------------------------------
> 
> -David
> 
> >  - default-forrest.properties
> >  - forrest-core.xconf
> > Further adding of forrest.properties.xml to basic and fresh-site seed.
> > 
> > Switching to the new properties system in all code of the dispatcher plugin where former core references have been.
> > 
> > 
> > Added:
> >     forrest/trunk/main/fresh-site/forrest.properties.xml   (with props)
> >     forrest/trunk/main/template-sites/basic/forrest.properties.xml   (with props)
> >     forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/default.plugin.properties.xml   (with props)
> > Modified:
> >     forrest/trunk/main/template-sites/basic/forrest.properties
> >     forrest/trunk/main/webapp/WEB-INF/xconf/forrest-core.xconf
> >     forrest/trunk/main/webapp/default-forrest.properties
> >     forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/forrest.properties
> >     forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/locationmap.xml
> >     forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispatcher/resources.xmap
> 
> [ snip ]
> 
> > Modified: forrest/trunk/main/template-sites/basic/forrest.properties
> > URL: http://svn.apache.org/viewvc/forrest/trunk/main/template-sites/basic/forrest.properties?rev=428188&r1=428187&r2=428188&view=diff
> > ==============================================================================
> > --- forrest/trunk/main/template-sites/basic/forrest.properties (original)
> > +++ forrest/trunk/main/template-sites/basic/forrest.properties Wed Aug  2 16:29:56 2006
> > @@ -14,144 +14,12 @@
> >  # limitations under the License.
> >  
> >  ##############
> > -# These are the defaults, un-comment them only if you need to change them.
> > -#
> > -# You can even have a completely empty file, to assist with maintenance.
> > -# The file obtained from 'forrest seed-sample' shows the defaults.
> > +# This is a minimal properties file.
> > +# These are defaults, un-comment them only if you need to change them.
> > +# See the full set of default properties in a 'forrest seed-sample' site.
> > +# Copy properties from there as needed.
> >  ##############
> > -
> > -# Prints out a summary of Forrest settings for this project
> > -#forrest.echo=true
> > -
> > -# Project name (used to name .war file)
> > -#project.name=my-project
> > -
> > -# Specifies name of Forrest skin to use
> > -# See list at http://forrest.apache.org/docs/skins.html
> > -#project.skin=pelt
> > -
> > -# codename: Dispatcher
> > -# Dispatcher is using a fallback mechanism for theming.
> > -# You can configure the theme name and its extension here
> > -#project.theme-extension=.fv
> > -#project.theme=pelt
> > -
> > -
> > -# Descriptors for plugins and skins
> > -# comma separated list, file:// is supported
> > -#forrest.skins.descriptors=http://forrest.apache.org/skins/skins.xml,file:///c:/myskins/skins.xml
> > -#forrest.plugins.descriptors=http://forrest.apache.org/plugins/plugins.xml,http://forrest.apache.org/plugins/whiteboard-plugins.xml
> > -
> > -##############
> > -# behavioural properties
> > -#project.menu-scheme=tab_attributes
> > -#project.menu-scheme=directories
> > -
> > -##############
> > -# layout properties
> > -
> > -# 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.raw-content-dir=${project.content-dir}/content
> > -#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
> > -#project.translations-dir=${project.content-dir}/translations
> > -
> > -#project.build-dir=${project.home}/build
> > -#project.site=site
> > -#project.site-dir=${project.build-dir}/${project.site}
> > -#project.temp-dir=${project.build-dir}/tmp
> > -
> > -##############
> > -# Cocoon catalog entity resolver properties
> > -# A local OASIS catalog file to supplement the default Forrest catalog
> > -#project.catalog=${project.schema-dir}/catalog.xcat
> > -
> > -##############
> > -# validation properties
> > -
> > -# This set of properties determine if validation is performed
> > -# Values are inherited unless overridden.
> > -# 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}
> > -#forrest.validate.sitemap=${forrest.validate}
> > -#forrest.validate.stylesheets=${forrest.validate}
> > -#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
> > -
> > -# *.excludes=(pattern) - comma-separated list of path patterns to not validate
> > -# Note: If you do add an "excludes" list then you need to specify site.xml too.
> > -# e.g.
> > -#forrest.validate.xdocs.excludes=site.xml, samples/subdir/**, samples/faq.xml
> > -#forrest.validate.xdocs.excludes=site.xml
> > -
> > -
> > -##############
> > -# 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
> > -# Projects would use their own issue tracker, of course.
> > -#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. Based on the locale request for the browser.
> > -#If you want to use it for static site then modify the JVM system.language
> > -# and run once per language
> > -#project.i18n=false
> > -
> > -# The names of plugins that are required to build the project
> > -# comma separated list (no spaces)
> > -# You can request a specific version by appending "-VERSION" to the end of
> > -# the plugin name. If you exclude a version number, the latest released version
> > -# will be used. However, be aware that this may be a development version. In
> > -# a production environment it is recommended that you specify a known working
> > -# version.
> > -# Run "forrest available-plugins" for a list of plug-ins currently available.
> >  project.required.plugins=org.apache.forrest.plugin.output.pdf
> > -
> >  # codename: Dispatcher
> >  # Add the following plugins to project.required.plugins:
> >  #org.apache.forrest.plugin.internal.dispatcher,org.apache.forrest.themes.core
> > -
> > -# Proxy configuration
> > -# - proxy.user and proxy.password are only needed if the proxy is an authenticated one...
> > -# proxy.host=myproxy.myhost.com
> > -# proxy.port=<ProxyPort, if not the default : 80>
> > -# proxy.user=<login, if authenticated proxy>
> > -# proxy.password=<password, if authenticated proxy>
> 
> [ snip ]
-- 
thorsten

"Together we stand, divided we fall!" 
Hey you (Pink Floyd)


RE: minimal forrest.properties (Was: r428188: main/fresh-site/main/template-sites/basic/ ...)

Posted by "Gav...." <br...@brightontown.com.au>.

> -----Original Message-----
> From: Thorsten Scherler [mailto:thorsten@apache.org]
> Sent: Thursday, 3 August 2006 2:58 PM
> To: dev@forrest.apache.org
> Subject: Re: minimal forrest.properties (Was: r428188: main/fresh-
> site/main/template-sites/basic/ ...)
> 
> El jue, 03-08-2006 a las 10:00 +1000, David Crossley escribió:
> > thorsten@apache.org wrote:
> > > Author: thorsten
> > > Date: Wed Aug  2 16:29:56 2006
> > > New Revision: 428188
> > >
> > > URL: http://svn.apache.org/viewvc?rev=428188&view=rev
> > > Log:
> > > FOR-799 - remove all references from the core to the dispatcher
> > > I removed all properties related to the dispatcher (or former
> versions) from the core.
> > > This includes cleaning
> > >  - basic (further switched to a minimal config) and fresh-site seed
> forrest.properties
> >
> > I previously tried to trim down the templates/basic/forrest.properties
> > and was asked to revert it:
> 
> http://marc.theaimsgroup.com/?l=forrest-dev&w=2&r=1&s=r366100&q=b
> I am still the same opinion as back then.
> 
> Further I created the basic seed to not have to senseless remove code
> that I do not need. The basic seed is a slim down and clean startup for
> projects from scratch.
> 
> Regarding Ross comment in
> http://marc.theaimsgroup.com/?l=forrest-dev&m=113647830724990&w=2
> "...These are used by users as a
> starting point and therefore extra documentation in there will reduce
> the number of questions we get on the mailing lists..."
> 
> The basic seed is for advanced user of forrest, that already played a
> round with the samples and want to start from scratch. I do not think
> that someone will ask regarding the basic seed.

I agree with the usage of this, however the title 'basic' does not in my
mind tie in with 'advanced'. To me , 'basic' would be the place I would head
for if I knew nothing. 'minimal' describes it well and newbies may well get
the message and steer clear from.

Gav...

> 
> salu2
> 
> >
> > ------------------------------------------------------------------------
> > r366423 | crossley | 2006-01-06 15:30:07 +1100 (Fri, 06 Jan 2006) | 3
> lines
> >
> > Add duplicate full forrest.properties to "basic" and "business" seeds.
> > Please keep these synchronised with the master copy in main/fresh-site
> >
> > ------------------------------------------------------------------------
> > r366100 | crossley | 2006-01-05 18:01:23 +1100 (Thu, 05 Jan 2006) | 2
> lines
> >
> > Use minimal forrest.properties files.
> > ------------------------------------------------------------------------
> >
> > -David
> >
> > >  - default-forrest.properties
> > >  - forrest-core.xconf
> > > Further adding of forrest.properties.xml to basic and fresh-site seed.
> > >
> > > Switching to the new properties system in all code of the dispatcher
> plugin where former core references have been.
> > >
> > >
> > > Added:
> > >     forrest/trunk/main/fresh-site/forrest.properties.xml   (with
> props)
> > >     forrest/trunk/main/template-sites/basic/forrest.properties.xml
> (with props)
> > >
> forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispat
> cher/default.plugin.properties.xml   (with props)
> > > Modified:
> > >     forrest/trunk/main/template-sites/basic/forrest.properties
> > >     forrest/trunk/main/webapp/WEB-INF/xconf/forrest-core.xconf
> > >     forrest/trunk/main/webapp/default-forrest.properties
> > >
> forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispat
> cher/forrest.properties
> > >
> forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispat
> cher/locationmap.xml
> > >
> forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.internal.dispat
> cher/resources.xmap
> >
> > [ snip ]
> >
> > > Modified: forrest/trunk/main/template-sites/basic/forrest.properties
> > > URL: http://svn.apache.org/viewvc/forrest/trunk/main/template-
> sites/basic/forrest.properties?rev=428188&r1=428187&r2=428188&view=diff
> > >
> ==========================================================================
> ====
> > > --- forrest/trunk/main/template-sites/basic/forrest.properties
> (original)
> > > +++ forrest/trunk/main/template-sites/basic/forrest.properties Wed Aug
> 2 16:29:56 2006
> > > @@ -14,144 +14,12 @@
> > >  # limitations under the License.
> > >
> > >  ##############
> > > -# These are the defaults, un-comment them only if you need to change
> them.
> > > -#
> > > -# You can even have a completely empty file, to assist with
> maintenance.
> > > -# The file obtained from 'forrest seed-sample' shows the defaults.
> > > +# This is a minimal properties file.
> > > +# These are defaults, un-comment them only if you need to change
> them.
> > > +# See the full set of default properties in a 'forrest seed-sample'
> site.
> > > +# Copy properties from there as needed.
> > >  ##############
> > > -
> > > -# Prints out a summary of Forrest settings for this project
> > > -#forrest.echo=true
> > > -
> > > -# Project name (used to name .war file)
> > > -#project.name=my-project
> > > -
> > > -# Specifies name of Forrest skin to use
> > > -# See list at http://forrest.apache.org/docs/skins.html
> > > -#project.skin=pelt
> > > -
> > > -# codename: Dispatcher
> > > -# Dispatcher is using a fallback mechanism for theming.
> > > -# You can configure the theme name and its extension here
> > > -#project.theme-extension=.fv
> > > -#project.theme=pelt
> > > -
> > > -
> > > -# Descriptors for plugins and skins
> > > -# comma separated list, file:// is supported
> > > -
> #forrest.skins.descriptors=http://forrest.apache.org/skins/skins.xml,file:
> ///c:/myskins/skins.xml
> > > -
> #forrest.plugins.descriptors=http://forrest.apache.org/plugins/plugins.xml
> ,http://forrest.apache.org/plugins/whiteboard-plugins.xml
> > > -
> > > -##############
> > > -# behavioural properties
> > > -#project.menu-scheme=tab_attributes
> > > -#project.menu-scheme=directories
> > > -
> > > -##############
> > > -# layout properties
> > > -
> > > -# 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.raw-content-dir=${project.content-dir}/content
> > > -#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
> > > -#project.translations-dir=${project.content-dir}/translations
> > > -
> > > -#project.build-dir=${project.home}/build
> > > -#project.site=site
> > > -#project.site-dir=${project.build-dir}/${project.site}
> > > -#project.temp-dir=${project.build-dir}/tmp
> > > -
> > > -##############
> > > -# Cocoon catalog entity resolver properties
> > > -# A local OASIS catalog file to supplement the default Forrest
> catalog
> > > -#project.catalog=${project.schema-dir}/catalog.xcat
> > > -
> > > -##############
> > > -# validation properties
> > > -
> > > -# This set of properties determine if validation is performed
> > > -# Values are inherited unless overridden.
> > > -# 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}
> > > -#forrest.validate.sitemap=${forrest.validate}
> > > -#forrest.validate.stylesheets=${forrest.validate}
> > > -#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
> > > -
> > > -# *.excludes=(pattern) - comma-separated list of path patterns to not
> validate
> > > -# Note: If you do add an "excludes" list then you need to specify
> site.xml too.
> > > -# e.g.
> > > -#forrest.validate.xdocs.excludes=site.xml, samples/subdir/**,
> samples/faq.xml
> > > -#forrest.validate.xdocs.excludes=site.xml
> > > -
> > > -
> > > -##############
> > > -# 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
> > > -# Projects would use their own issue tracker, of course.
> > > -#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. Based on the locale request for the browser.
> > > -#If you want to use it for static site then modify the JVM
> system.language
> > > -# and run once per language
> > > -#project.i18n=false
> > > -
> > > -# The names of plugins that are required to build the project
> > > -# comma separated list (no spaces)
> > > -# You can request a specific version by appending "-VERSION" to the
> end of
> > > -# the plugin name. If you exclude a version number, the latest
> released version
> > > -# will be used. However, be aware that this may be a development
> version. In
> > > -# a production environment it is recommended that you specify a known
> working
> > > -# version.
> > > -# Run "forrest available-plugins" for a list of plug-ins currently
> available.
> > >  project.required.plugins=org.apache.forrest.plugin.output.pdf
> > > -
> > >  # codename: Dispatcher
> > >  # Add the following plugins to project.required.plugins:
> > >
> #org.apache.forrest.plugin.internal.dispatcher,org.apache.forrest.themes.c
> ore
> > > -
> > > -# Proxy configuration
> > > -# - proxy.user and proxy.password are only needed if the proxy is an
> authenticated one...
> > > -# proxy.host=myproxy.myhost.com
> > > -# proxy.port=<ProxyPort, if not the default : 80>
> > > -# proxy.user=<login, if authenticated proxy>
> > > -# proxy.password=<password, if authenticated proxy>
> >
> > [ snip ]
> --
> thorsten
> 
> "Together we stand, divided we fall!"
> Hey you (Pink Floyd)
> 
> 
> 
> 
> --
> No virus found in this incoming message.
> Checked by AVG Free Edition.
> Version: 7.1.394 / Virus Database: 268.10.5/406 - Release Date: 8/2/2006