wamblee.org Git - utils/blob - forrest.properties

   1 # Copyright 2002-2005 The Apache Software Foundation or its licensors,
   2 # as applicable.
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 ##############
  17 # Properties used by forrest.build.xml for building the website
  18 # These are the defaults, un-comment them only if you need to change them.
  19 ##############
  20
  21 # Prints out a summary of Forrest settings for this project
  22 #forrest.echo=true
  23
  24 # Project name (used to name .war file)
  25 #project.name=my-project
  26
  27 # Specifies name of Forrest skin to use
  28 # See list at http://forrest.apache.org/docs/skins.html
  29 project.skin=tigris
  30
  31 # Descriptors for plugins and skins
  32 # comma separated list, file:// is supported
  33 #forrest.skins.descriptors=http://forrest.apache.org/skins/skins.xml,file:///c:/myskins/skins.xml
  34 #forrest.plugins.descriptors=http://forrest.apache.org/plugins/plugins.xml,http://forrest.apache.org/plugins/whiteboard-plugins.xml
  35
  36 ##############
  37 # behavioural properties
  38 #project.menu-scheme=tab_attributes
  39 #project.menu-scheme=directories
  40
  41 ##############
  42 # layout properties
  43
  44 # Properties that can be set to override the default locations
  45 #
  46 # Parent properties must be set. This usually means uncommenting
  47 # project.content-dir if any other property using it is uncommented
  48
  49 #project.status=status.xml
  50 project.content-dir=docs
  51 #project.raw-content-dir=${project.content-dir}/content
  52 #project.conf-dir=${project.content-dir}/conf
  53 #project.sitemap-dir=${project.content-dir}
  54 #project.xdocs-dir=${project.content-dir}/content/xdocs
  55 project.resources-dir=${project.content-dir}/resources
  56 #project.stylesheets-dir=${project.resources-dir}/stylesheets
  57 #project.images-dir=${project.resources-dir}/images
  58 #project.schema-dir=${project.resources-dir}/schema
  59 #project.skins-dir=${project.content-dir}/skins
  60 #project.skinconf=${project.content-dir}/skinconf.xml
  61 #project.lib-dir=${project.content-dir}/lib
  62 project.classes-dir=${project.resources-dir}/properties
  63 #project.translations-dir=${project.content-dir}/translations
  64
  65
  66
  67 ##############
  68 # validation properties
  69
  70 # This set of properties determine if validation is performed
  71 # Values are inherited unless overridden.
  72 # e.g. if forrest.validate=false then all others are false unless set to true.
  73 #forrest.validate=true
  74 #forrest.validate.xdocs=${forrest.validate}
  75 #forrest.validate.skinconf=${forrest.validate}
  76 #forrest.validate.sitemap=${forrest.validate}
  77 #forrest.validate.stylesheets=${forrest.validate}
  78 #forrest.validate.skins=${forrest.validate}
  79 #forrest.validate.skins.stylesheets=${forrest.validate.skins}
  80
  81 # *.failonerror=(true|false) - stop when an XML file is invalid
  82 #forrest.validate.failonerror=true
  83
  84 # *.excludes=(pattern) - comma-separated list of path patterns to not validate
  85 # e.g.
  86 #forrest.validate.xdocs.excludes=samples/subdir/**, samples/faq.xml
  87 #forrest.validate.xdocs.excludes=
  88
  89
  90 ##############
  91 # General Forrest properties
  92
  93 # The URL to start crawling from
  94 #project.start-uri=linkmap.html
  95
  96 # Set logging level for messages printed to the console
  97 # (DEBUG, INFO, WARN, ERROR, FATAL_ERROR)
  98 #project.debuglevel=ERROR
  99
 100 # Max memory to allocate to Java
 101 #forrest.maxmemory=64m
 102
 103 # Any other arguments to pass to the JVM. For example, to run on an X-less
 104 # server, set to -Djava.awt.headless=true
 105 #forrest.jvmargs=
 106
 107 # The bugtracking URL - the issue number will be appended
 108 #project.bugtracking-url=http://issues.apache.org/bugzilla/show_bug.cgi?id=
 109 #project.bugtracking-url=http://issues.apache.org/jira/browse/
 110
 111 # The issues list as rss
 112 #project.issues-rss-url=
 113
 114 #I18n Property. Based on the locale request for the browser.
 115 #If you want to use it for static site then modify the JVM system.language
 116 # and run once per language
 117 #project.i18n=true
 118
 119 # The names of plugins that are required to build the project
 120 # comma separated list (no spaces)
 121 # You can request a specific version by appending "-VERSION" to the end of
 122 # the plugin name. If you exclude a version number the latest released version
 123 # will be used, however, be aware that this may be a development version. In
 124 # a production environment it is recomended that you specify a known working
 125 # version.
 126 # Run "forrest available-plugins" for a list of plug-ins currently available
 127 project.required.plugins=org.apache.forrest.plugin.output.pdf
 128
 129 # Proxy configuration
 130 # proxy.host=
 131 # proxy.port=