You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@forrest.apache.org by ni...@apache.org on 2003/10/23 12:47:02 UTC

cvs commit: xml-forrest/src/core/var echo-settings-message.txt skin-not-found-message.txt template-project-created-message.txt webapp-generated-message.txt

nicolaken    2003/10/23 03:47:02

  Added:       src/core/var echo-settings-message.txt
                        skin-not-found-message.txt
                        template-project-created-message.txt
                        webapp-generated-message.txt
  Log:
  Moved some messages to external files.
  Removed unneded source doc copying in the webapp.
  Removed the deprecated Ant @tag@ substitution method for skins to
  reduce copying further.
  
  Revision  Changes    Path
  1.1                  xml-forrest/src/core/var/echo-settings-message.txt
  
  Index: echo-settings-message.txt
  ===================================================================
        ------------------------------------------------
        | Forrest template run.
        | Running from $${forrest.home} = ${forrest.home}
        | Working on   $${project.home} = ${project.home}
        ------------------------------------------------
        | //where to put the result
        | project.site-dir    = ${project.site-dir} 
        | //uri to start crawling/generation process
        | project.start-uri   = ${project.start-uri}
        | //cocoon.xconf location
        | project.configfile  = ${project.configfile}
        | //logkit.xconf location
        | project.logkitfile  = ${project.logkitfile}
        | //temp dir to throw stuff in (i.e. work and ctxt)
        | project.temp-dir    = ${project.temp-dir} 
        | //temp working directory for generation process
        | project.cocoon-work-dir    = ${project.cocoon-work-dir} 
        | //temp context directory for generation process
        | project.webapp    = ${project.webapp} 
        | //debuglevel for logging (DEBUG, INFO, WARN, ERROR, FATAL_ERROR)
        | project.debuglevel  = ${project.debuglevel}
        | //file for list of broken links
        | project.brokenlinkfile = ${project.brokenlinkfile}
        | //check if you have tools.jar installed
        | tools.jar.present   = ${tools.jar.present} 
        ------------------------------------------------
        | The following properties could be removed from future builds:
        | //which skin to apply
        | project.skin        = ${project.skin} 
        | //where your documentation xml is
        | project.content-dir = ${content-dir} 
        ------------------------------------------------
  
  
  
  1.1                  xml-forrest/src/core/var/skin-not-found-message.txt
  
  Index: skin-not-found-message.txt
  ===================================================================
  ------------------------------------------------
  Error: The skin '${project.skin}' could not be found in:
  
  ${skins-dir}
  
  And is not provided by Forrest in
  
  ${forrest.home}/context/skins
  
  Please check the $${skins-dir} and $${project.skin} properties in
  forrest.properties.
  ------------------------------------------------
  
  
  
  1.1                  xml-forrest/src/core/var/template-project-created-message.txt
  
  Index: template-project-created-message.txt
  ===================================================================
  
  -------------------------------
  ~~ Template project created! ~~
  
  Here is an outline of the generated files:
  
  /                        # ${basedir}
  /status.xml              # List of project developers, todo list and change log
  /forrest.properties      # Optional file describing your site layout
  /src/documentation/      # Doc-specific files
  /src/documentation/skinconf.xml    # Info about your project used by the skin
  /src/documentation/content/        # Site content.
  /src/documentation/content/xdocs   # XML content.
  /src/documentation/content/xdocs/index.xml # Home page
  /src/documentation/content/xdocs/site.xml  # Navigation file for site structure
  /src/documentation/content/xdocs/tabs.xml  # Skin-specific 'tabs' file.
  /src/documentation/content/*.html,pdf      # Static content files
  /src/documentation/resources/images        # Project images (logos, etc)
  
  
  What to do now?
  
  - Try rendering this template to HTML by typing 'forrest'. View the generated
    HTML in a browser to make sure everything works.
  - Edit status.xml and src/documentation/skinconf.xml and customize for your
    project.
  - Start adding content in xdocs/, remembering to add new files to site.xml
  - Provide any feedback to forrest-dev@xml.apache.org
  
  Thanks for using Apache Forrest
  -------------------------------
  
  
  
  1.1                  xml-forrest/src/core/var/webapp-generated-message.txt
  
  Index: webapp-generated-message.txt
  ===================================================================
  ---------------------------------
  Webapp generated in ${project.webapp}
  
  To run in Tomcat, add this to the config file (usu. server.xml):
  
  <Context path='/${skinconfig.project-name}'
              docBase='${project.webapp}'
              reloadable='true'/>
  
  If using JDK 1.4 or above, make sure to set the Java environment variable
  -Djava.endorsed.dirs=${forrest.home}${/}lib${/}endorsed
  Eg, in the TOMCAT_OPTS (3.3.x) or CATALINA_OPTS (4.x) env variable.
  ---------------------------------