Apache Forrest is pleased to release the new version: apache-forrest-0.7

It can be downloaded from one of the Apache Software Foundation mirror sites.

Apache Forrest is a publishing framework that transforms input from various sources into a unified presentation in one or more output formats. The modular and extensible plugin architecture is based on Apache Cocoon and relevant standards, which separates presentation from content. Forrest can generate static documents, or be used as a dynamic server, or be deployed by its automated facility.

Requirements

A Java Runtime Environment (1.4 or higher) installed. This can be obtained from http://java.sun.com/j2se/downloads.html or other places.

To build from source requires a Java Development Kit (1.4 or higher)

Apache Ant is not required: Forrest uses its own version of Ant in tools/ant/

Apache Cocoon is not required: Forrest uses its own version.

Installing Apache Forrest

The distribution contains all Forrest resources (skins, XSLTs, images, schemas), source code and Forrest's own website documentation.

Copy somewhere permanent, like /usr/local/forrest or c:\forrest Support for installation on Windows systems into directories containing spaces is very new, please report back on your success or failure.

Set FORREST_HOME environment variable to point to that top-level directory.

Add to the system PATH environment variable, i.e. $FORREST_HOME/bin (Unix) or %FORREST_HOME%\bin (Windows)

Getting Started

See the file index.html for the quick start tips.

Issue tracking

If you notice what appears to be a bug, please report it via the Forrest issue tracker.

Known issues are summarized at: http://forrest.apache.org/0.7/forrest-issues.html (a nice example of RSS syndication).

Feedback

Feedback, feature suggestions, bugs and any other issues can be discussed on our mailing lists.

 Added document to facilitate upgrading to v0.8
apache-forrest-0.7.1-dev

Will only be released if absolutely necessary

 Added document to facilitate upgrading to v0.7 Howto-v20 now properly handles a/@class=fork etc. attribute to enable links to open in a new browser window. Forrestbot deploy.scp workstage now uses keyfile/passphrase in preference, then fallback to remote password. Changed handling of table elements with class-attributes in source: Table elements w/o class elements will receive standard Forrest styling like before (cellpadding="4" cellspacing="1" class="ForrestTable") while elements that have class will pass unchanged. Note: To style tables with class elements like before you have to add styling code in the extra-css-section of skinconfig. Fixed problems with disappearing of id-attributes in img-element and several others. Added new "clean" targets. Doing 'forrest clean-site' will remove the contents of the project's generated documents directory. Doing 'forrest clean-work' will remove the project's work directories (usually build/tmp and build/webapp which include the Cocoon cache and the Cocoon logs). Doing 'forrest clean' will remove both sections. Added document to facilitate upgrading to v0.7 Config check for the i8n attribute for i18n transformer so it is used only when necessary. Enhanced the Message of the Day (MOTD) facility. See skinconf.xml from a "seed" site for configuration details. Append a small text string after html title. Add text to a panel on the page. Select different messages depending on the URI string pattern. To use it, declare skinconfig-v07-1.dtd in your skinconf.xml file. Enable skinconf to specify optional page number format for PDF. Plugins are now version controlled. Do not limit status.xml contexts in projectInfo plugin. The "extra-css" from skinconf.xml is now inserted at the very end of the CSS. That enables it to properly override other elements. Rewrote example of raw content in fresh-site to correctly document the behaviour in 0.7. Removed ihtml example from fresh-site and replaced with an example of embedded HTML. The use of ihtml is now deprecated in favour of embedded HTML. Fixed a bug with individual "credit image" placement in the pelt skin. If one credit was specified to be in the alternative location, then all credits were placed there. Also added a second alternative location. Split plugins.xml between plugins.xml in main plugins dir and whiteboard-plugins.xml in whiteboard/plugins and added relevant docs to plugins index page. Added importance attribute to actions on status.dtd Added ability to add page breaks to output. See Page Breaks FAQ Allow the serving of raw SVG files to allow clients to render locally. Plugin docs are now upated automatically when a plugin is deployed. Alternatively you can update the docs independantly by running the deploy-docs target in the plugin directory. * Uses skinconf.xml to determine background and border color for notes, warnings, and fixmes; * Uses skinconf.xml to determine background and border color for table cells (headers and data); * Honors headings type set in skinconf.xml (clean|underlined|boxed) and colors headings accordingly; * Uses skinconf.xml to determine font color for links. In addition, this patch extends the "link" template to also apply to the "fork", "jump", and "a" elements. Generate html/head/meta elements from document-v2. Added org.apache.forrest.plugin.input.listLocations plugin. Use lists of locations maintained in a simple xml format and transform them to documents. Reinstate error reporting for broken "site:" and "ext:" links which are due to missing entries in site.xml or typos in site: links. The text "error:" is also prepended. This is a workaround for bug FOR-284 "link rewriting broken when linking to xml source views which contain site: links". This latter issue is handled by the core. However, if your project uses a Cocoon cli.xconf then you will need add the same "exclude" entries. Handle FAQs sections and faqs with both howto-v1.* and howto-v2.* docs. Apply proper section numbering. Removed old versions of pre-release plugins following renaming to the convention defined in Plugin Infrastructure. Added org.apache.forrest.plugin.input.dtdx plugin by moving functionality out of the core. Generates DTD documentation using a custom Cocoon Generator. Removed the leather-dev docs and added the begining of the View plugin docs. Changed plugin template location to {forrest.plugins.dir}/pluginTemplate in the build.xml of plugins/ and whiteboard/plugins/. That allows to create new plugins in the whiteboard/plugin/ directory. Activated multiple output formats to be configured via a View. Added viewHelper plugin and removed experimental leather plugin. Enhanced the documentation of view/viewHelper. Images group.svg and project.svg were rendered with the shadow effect slightly clipped. Needed to add width and height to filter element. Added contracts and nuggets to the "view" plugins. Created a new plugin org.apache.forrest.plugin.internal.view from the fbits core and removed the fbits plugin. Added FAQ about "pageBreakBefore" and "pageBreakAfter" class int PDF documents and describe how to enable the page break behaviour in HTML documents. Use "pageBreakBefore" and "pageBreakAfter" class to sections to force a page break in PDF output. Added How to customize processing of html source Moved status "changes" and "todo" page generation to the org.apache.forrest.plugin.input.projectInfo plugin. Fix broken links in Table of Contents when titles contain accented characters. I18n uses org.apache.cocoon.matching.LocaleMatcher instead of i18n transformer. This requires that your source must now be foo.lang.xml instead of foo_lang.xml Added proxy.host, proxy.port, proxy.user and proxy.password to allow plugin downloads from behind a proxy. Fix various bugs with Lucene search. Added a plugin to handle input documents from Microsoft Excel. Enabled XInclude in site.xml and tabs.xml Added external plugin POD-input to allow Plain Old Documentation (POD) files to be included in a Forrest site. Updated nekodtd to 0.1.11 Moved POD output from the common skin to its own plugin. Fixed quotes in forrest.bat so forrest can be in a directory with spaces. Added a text-output plugin. Added WYSIWYG editor as a plugin (only works in dynamic webapps). Added photoGallery plugin. Added capability to deploy directly to site in SVN using "ant deploy" from within plugin directory. Stopped doing deletion of the cache-dir, so consecutive "forrest site" actions can be cached. Added testing facilities to plugins to facilitate integration testing. Merge xdocs and raw files in the same directory src/document/content/xdocs Added How-To Run Forrest from Maven. Added How-To Build a plugin. Split plugin documentation between user and developer topics. LocaleAction changed its API. The "lang" value is "language" now. Ignore directory links for aggregations. Added HowTo about editing CSS in a WYSIWYG fashion using Mozilla Firefox and its Edit-CSS plugin. Added custom xml sample and project sitemap to the 'forrest seed site'. Added How to modify the color of generated corner images. Added links to example websites to demonstrate each available default skin. Changed Ant build property name "version" to "forrest.version" to prevent collisions with other build systems when using the Ant "import" task. Fixed some public identifiers (for DTD-v2.0) which were still pointing to old versions of DTDs. Added to the document-v20 DTD to support "usemap" attribute in img tag. Also added demonstration of client-side imagemap to the "seed site". Added FAQ to explain character encoding for certain languages. Enable sitemap plugins. Plugins allow Forrest to have functionality added through the addition of small code blocks (plugins). Plugins are downloaded automatically when a site that requires them is built. See Extending Forrest with Plugins. Update fop-0.20.5 just with optional jimi support. This fixes the issue building the Apache FOP site. Replace libraries to use the cocoon-2.2.0-dev version. The brokenlinks file now contains referer information. Upgraded lib/core/cocoon.jar and added attribute "show-referrers" to the Cocoon cli.xconf Updated How-To: How to create a PDF document for each tab to create subject-specific aggregated documents. Java 1.4 is required starting with Forrest-0.7-dev docbook2document.xsl: remove unnecessary / from template matches. docbook2document.xsl: docinfo element. never in OASIS Docbook XML DTD docbook2document.xsl: handle the xref and xreflabel. Proper positioning of icon/links for PDF, XML, POD, Print content options on pelt skin. Updated commons-collections to 3.1, commons-logging to 1.0.4, jcs to 1.1-dev.20040811, lucene to 1.4.1 Enable email address obfuscation to be configurable using the obfuscate-mail-value option in skinconf.xml Allow forrest to run in a project directory with a space in the name. Openoffice2forrest: add support for merged cells in tables. Fixed the domain bug of the searchbox in pelt. Fixed the menu in pelt by adding getMenu.js and changing the site2xhtml.xsl. Now the chapter image will get expand again. getMenu.js - fixes a path issue and the double click behaviour of pelt. Explained the usage of the extra-css element in skinconf.xml of the fresh site. Initial Chaperon grammar for minimal MoinMoin Wiki to Forrest xdocs transformation. Source documents use the *.moinwiki filename extension. Requesting linkmap.html Forrest now renders the site.xml file as a table of contents. Now the *.ihtml and *.cwiki extensions are deprecated. To get the same functionality it is recommended to switch to *.html and *.jspwiki. With this it's now possible to have a site in simple html, edited with any html editor. The *.jspwiki extension was put to make it clear what the format is about. New project sitemap extension mechanism. Now it is possible to add a project sitemap that plugs into the processing at the beginning. If the requested url is resolved by it, it will serve the file directly. If the requested url with the extension changed to xml is matched, then Forrest will use that result as the intermediate format and render it. This will enable project-specific sitemaps to not collide with future Forrest updates. Relative URIs with absolute paths were broken in the site.xml linking mechanism. Re-write the Chaperon grammar for JSPWiki to address ambiguity with paragraphs and sub-sections. Added configuration for XMLMind XML Editor to scratchpad. Originally from splike.com Enhance the document2pod functionality to handle many other elements and enable the link to this format to be configured via skinconf. See the issue report for some notes. Automatically add some meta elements to head of html (Generator name, Forrest version, skin name) Optional feedback link for the footer of all skins. New output format for POD (the Perl community's Plain Old Documentation) triggered using the .pod filename extension. Initial work, needs enhancement. See forrest-dev discussion Eclipse plugin code added to scratchpad (donated by Burrokeet). Initial work, needs enhancement. Skins "forrest-css" and "avalon-tigris" are deleted. The "tigris-style" is renamed to "tigris". Aliases set in place for backward-compatibility. The old "forrest-site" and "krysalis-site" skins are retained for a little while longer, but are deprecated, so please move to one of the other skins. See notes about Default skins. Updated Ant 1.6.2. JCS log messages go through cocoon instead of to stdout. Generate proper html for figures in simplified docbook. Have @class attribute in DTD for every element, which enables the "extra-css" section in the skinconf to be put to good use. Updated all v1.2 DTDs to become v1.3 DTDs (forward compatibility: v1.2 docs will work fine as V1.3). Updated the v2.0a DTDs to become v2.0 DTDs (forward incompatibility: v1.2/1.3 docs are not forward-compatible as V2.0). Added demo of extra-css to the seed site and updated some sample docs to use new v1.3 DTDs. See the samples and reference docs. See the issue report for full list of changes. Added a How-To: Generate an ASF mirrors page using interactive web form using ihtml to include additional html form elements. Added forrestbot deploy.svn implmentation. Support running Forrest on Win9x. Don't copy unneeded project files in 'war' and 'webapp' targets. Add more desriptions to forrest targets. Highlight the most common ones. Added a How-To: How to create a PDF document for each tab to create subject-specific aggregated documents. Created the How-To section of the documentation. Continue Dianna Shannon's good work with designing the DTDs, concepts, and documentation effort at Cocoon. The new "pelt" skin (uses CSS and div). See notes about Default skins. Projects can use a local CatalogManager.properties to declare additional Catalogs for DTDs and other entities. Improve look of PDF pages. PDF pages receive skinconf properly (through the skinconf pipeline). FAQ page does not need to provide it's own extra index. Brokenlinks file is now generated in project.home rather than forrest.home Added a mechanism to enable impoverished XML tools that do not use the Catalog Entity Resolver to fetch the DTDs direct from the website. See upgrading to v0.6 Please help to upgrade our /dtd/.htaccess file (see issue FOR-107) and please help to address the SVN Issue 1233. In skinconfig, add box-location attribute to search element. Remove 'template' skin; better to base a new skin on an existing one. Replace URLs in all docs to be http://forrest.apache.org/ Add missing xdocs from the validate.exclude property. Allowing to exclude files. Improved resolving image references in PDFs. Now CSS files are parsed internally, so that the urls are included in the static site generation. Forrest is now a top-level Apache project. The new website is at http://forrest.apache.org/ Lucene-index target works. If search@provider="lucene" is set create a search index. Build site and run targets as per project directory instead of forrest.home. Fix relative links and image references in aggregate pages. Worked search functionality into all skins. Fixed query parameters for Google site search. Lateral search box was incompatible with new skinconf.xml format. Added new documentation about Searching Forrest-built documentation which describes both Lucene and Google search. Upgrade to cocoon 2.1.5 Clean up first Lucene search implementation in Forrest. Locationmap modules added. Not in use yet. Forrestdoc code added to scratchpad; previously was Jakarta Alexandria Removed author and cvs-id tags from code and xdocs. Repack Jetty without JSP support. Now we can remove org.apache.jasper.jar Moved forrestbot2 from scratchpad into main. Uses ant 1.6's 'import' task instead of XSLT/ant. Webapp completely rewritten to use JSTL, Struts, Java utility classes, and OpenSymphony's OSUser for flexible authentication. Forrest does not copy anything around anymore. The only step to make it work is to have java compile the forrest jar; all other resources are used in their original location. Moved all references to //skinconfig out of the document2html.xsl into the site2xhtml.xsl file. * Rationalized the Table of Contents stuff by creating a "toc" mode in the common/xslt/html/document2html.xsl. That is then used to generate the per-page ToC and the ToC attached to the menu. * Removed extraneous default xsl matchers on the non-common document2html and site2xhtml XSLs. This allows matches defined in the imported transformation sheets to match (imported sheets have lower precedence). * Defined a couple of <div id="..."> place holder tags used by the document2html. Those are then skinned by the site2xhtml sheets. * Note: If you have your own skins that were referencing "$config" or "//skinconfig" in the document2html.xsl then you need to make similar changes. * For more information see the FOR-146 issue report. Add <copyright-link> element to skinconf The .ehtml files have been deprecated. Use .ihtml instead. Future html input support will be based on this discussion. Remove misleading error message. Reported a cocoon bug #28939 Revert the changes to access skinconf using "skinconf//" done on r10259 Information about the new forrest-user mail list. Jetty jar was mistakenly compiled for jdk 1.4 - now re-compiled for jdk 1.3 Forrest-targets with ant proxy is obsolete; use forrestbot now. 'build patch' command updated for SVN. Completely rewritten Lucene-based index and search functionality. skinconf was being ignored for the svg and fo formats. "Warning" was mistakenly labeled as "Note" in PDF. site2book.xsl handle all menu-item and menu attributes Proper table around 'graphic' in simplified docbook. Replace document() function to get skinconf values and use "//skinconfig". Fix order so it can validate skinconf. Use <search/> instead of <disable-search/> <disable-lucene/> <searchsite-domain/> <searchsite-name/>. Fix skinconf.xsl so it produces a proper skinconf Updated jetty to 4.2.19 Update scripts and config files to allow upgrade to cocoon 2.1.5-dev New stylesheet to import the original cocoon.xconf file Stop overwriting skinconf and cocoon.xconf on webapp target. Libs were not copied on the webapp target. Move context targets from forrest.build.xml to targets/context Use skinconf DTD. Use xmlvalidate for skinconf. Create upgradeskinconf.xsl for old skinconf.xml files The language alternative div displays language in your own language. Docbook support for refentry element and it's children. Generally used for man pages. Do not create ToC unless it has been defined on the skinconf. Change level attribute to max-depth attribute. Add a min-sections attribute to define a minimun number of sections before create a toc. Add Language alternatives div. To test it: i18n-foo.html Page size and orientation for pdf. Converted repository from CVS to SVN. Upgrade to batik 1.5.1 Add i18n to single file content. ToC element is optional on skinconf. Updated Ant 1.6.1 Add i18n to tabs. Putting a jettyconf.xml file in your document directory will override the one supplied in the default Forrest context. Also no longer copies jettyconf.xml to build dir (one more file closer to no copying ;-)) Allow a full url image to be included on a pdf file. Use only tmp as the temporary directory. Split build file in various parts (webapp,war,validate,site) Support multiple skin descriptor files via the forrest.skins.descriptors property Move ant + Jetty under tools on the build target Libraries are not copied anymore in the servlet context of the dist and of the project being built; they are added instead to the classpath of jetty for the 'run' target and of the Cocoon CLI for the default 'site' target. New 'clean-dist' target for build.xml, which is now the default target. Wrong directory being used for wiki grammars. Upgrade to Jing 20030619. Validation is now "dynamic", by setting the parser feature "http://apache.org/xml/features/validation/dynamic". This means that documents with DTD are fully validated, while documents without DTD are just checked for well-formedness. Added SkinconfTransformer, that augments the skinconf.xml by adding these attributes to colors if not present: @highlight, @lowlight, @font, @link, @vlink, @hlink. Removed xml2xhtml.xsl import in profile2page.xsl that was not used (file not present). New build target to build a webapp that can be distributed. "war" target depends on "code" which will produce an deployable webapp, "run" target depends on "webapp-local" which leaves many files in the project directory to ease editing (e.g. src, resources and skins) Now skins can get a stab at enhancing skinconf.xml, by placing a skinconf.xsl file in the skin directory. By default some values are added by the common skin, like default Forrest colors. Upgrade to cocoon 2.1.3 nekodtd 0.1.9 remove excalibur-concurrent-20020820.jar remove excalibur-cli-1.0.jar remove excalibur-datasource-vm12-20021121.jar remove jakarta-oro-2.0.6.jar Add support for Openoffice Writer 1.1 files. Instead of forrest-targets.ent with Ant 1.6 Forrest can now also be used with the new import facility: <import file="forrest-targets.xml"/> Fixes to the krysalis skin to bring it up to snuff. Added lateral search bar. Added credits section. Use automatically skinnable borders Fix code font size. Other small enhancements. Automatic generation of borders from skin colors and naming convention. Rounded and straight 45 degrees corners supplied. For example, to generate a 'r'ounded corner for 't'op 'l'eft the size of '5' pixels of background 'header', foreground 'tab-selected' and border of 'tab-unselected' I can just ask for: /skin/images/rc-t-l-5-1header-2tab-selected-3-tab-unselected.png Removed all validation includes and excludes from the fresh site, except the most basic one. This means that the feature is to be considered deprecated. New "extra-css" tag in skinconf can contain css that is injected in forrest.css, added in the skins by default. New section in skinconf about colors used by the site. Enabled for krysalis-site and tigris-style. If a needed color is not specified, the default one is used. Now skin resources can be generated from skinconf.xml from xslt. For example '/myskin/css/my.css.xslt' is used by forrest on 'skinconf.xml' to get 'my.css' It is now possible to have two levels of tabs. External links are now identified by a small trailing icon. The icon can be overridden by the skin and the behaviour can be disabled in skinconf.xml. Added new 'tigris' skin, by using exactly the same skin version 1.1. from the project Style at http://style.tigris.org/. This will completely replace the avalon-tigris skin in subsequent versions. The avalon-tigris skin is to be considered deprecated and no longer developed. Properties from ${user.home}/forrest.properties are loaded, after the project's forrest.properties and before the default-forrest.properties are. Updated Ant 1.6.0 Refactored forrestbot to organize workstages and their implementations. Properties named by workstage and implementation for clarity and to prevent conflicts. The 'clean-site' target appears in 'forrest -projecthelp'. Deletes temp, webapp, and brokenlinks files too. Began documentation for new forrestbot; moved stable forrestbot docs Now skins that are edited in place have their non-traversable resources also copied for static rendering. New file format: '.aart'. These are text files that are converted automatically be Cocoon in SVG, if requested with a '.png' extension. Updated and separated in their directory all the resources needed by Chaperon, and make the pipeline generate the xml grammar versions if unavailable. This fixes some wiki rendering bugs and makes sections follow the correct level nesting. Now also all forrest /resources are editable in forrest.home and translations in their source space. Skins are now editable directly in FORREST_HOME. DHTML menus in Krysalis skin now work on all levels. Updated Entity Resolver from pre-release to official xml-commons-resolver-1.1 release. Updated Jetty to 4.2.14 Removed the deprecated Ant @tag@ substitution method for skins to reduce copying further. Wrong default value for translations directory. All resources in skins/common/images|scripts are used if the corresponding resource is not found in the skin being used. Moved under these dirs the images and the scripts that were placed by default under resources/images or copied in each skin, and added a temporary sitemap rule to route the request of the images to the new location. Moved the images of fresh-site to the src/content/xdocs directory, for the new layout that has been decided on forrest-dev. Now images are generated from the xdocs content dir as if they were in the resources/images dir. The latter will be phased out. Fixed the handling of images and resources in the resources.xmap pipeline, to cater for the new system that does not copy docs prior to rendering. Added a new property to forrest.properties (project.raw-content-dir=${project.content-dir}/content) to define where raw files are to be served from. Also removed the internal property real-content.dir that was used internally for this and replaced it with a raw-content.dir property. Major update to inner working of the krysalis-site skin: - removed all use of the spacer.gif image - replaced all visual enhancement icons with css icons - fixed CSS and html validation - reduced final output size, - removed all font tag usage in favor of css - added aural (speech) style in css - reduced usage of nested tables - refactored main xhtml stylesheet to be more clear and maintainable - refactored css to have a single small place where to define the skin colors - changed icons to original icons (made by me and not gotten from elsewhere) - removed unused icons. - made location of minitoc configurable as "page", "menu", or "both" Removed duplicated copying of files during the creation of the distro. Now the command-line context dir is like the webapp context dir. This reduces Forrest build time from 53 to 19 seconds on my system. Fixed bug in the autodownload support for skins that was preventing custom skins in the project source dir from working. Added support for docbook version 4.1.2. Allows importing files from various editors (Open office, Abiword). Added default translation for menu on fresh-site so it is used when the user locale can not be found. Synchronized some I18n labels after a modification on fresh-site. Patch facility to be used by any contributor (From Ant's project). To use it run "build.[sh|bat] patch". Added German Translation for menu in fresh-site example seed. Patched directory2book.xsl to be able to serve raw documents from the side menu (e.g. pdf); previously it always generated .html links. Skins can now be packaged, downloaded and automatically installed. See documentation. Added creation of TOC support on PDF files. Improved so it uses value from skinconfig.xml. Improve algoritm to define font size for section/subsection/... First I18n integration for menus in forrest. In the generated "changes" document, add "version_" to section@id as required by document-v12. Sort action types order to "add","remove","update","fix". The 'validate-site' build target will validate the intermediate xdocs. Integrate Lucene on Forrest. Check the bug report for more info. Added XSP support. For old sitemap.xmap add this tag: <map:generator name="serverpages" src="org.apache.cocoon.generation.ServerPagesGenerator"/> Upgrade to Cocoon 2.1.2, which fixes a bug that caused some pages in a site not to be rendered from the command-line, and has some cosmetic improvements. In skinconf.xml, made project-description optional to keep compatibility with 0.4. Added obfuscate-mail-links skinconf.xml option, on by default. Fix forrest-site tables bug that broke Opera forrest.antproxy.xml script now properly fails when Cocoon fails Fixed URLs for comma-separated bug keys in status.xml Fix bugs in forrest.bat|sh scripts encountered when used in odd environments (perl and Win9x). The 'forrest' command no longer sources /etc/antrc and ~/.antrc, which solves problems on some *nix distributions. Added new document to facilitate upgrading to v0.5 Added @label support for note and warning elements. Fixed java.lang.reflect.InvocationTargetException caused by catalog DTD HTTP lookup. The build had an extra and older resolver.jar Fix character return on line feed for fresh-site on the zip distribution New property "bugtracking-url" to allow a bug tracking systems other than bugzilla. Added a "forrest clean" task that removes the project build directory. In the forrest-site skin and derivatives, display the author and version at the bottom of the page, as krysalis-site does. Also added parsing for CVS Revision tags, so <version>$Revision: 1.288 $</version> can be used. Added ability to have version-specific overridden sitemaps. For example, src/documentation/sitemap-0.5.xmap will be used by Forrest 0.5 in preference to any others present in the same directory. This means a site with overridden sitemaps can build with Cocoon versions expecting different sitemap formats. Added email template for html content in common skin. Support for version, type and notice on html format. Style information on the common skin. build directory created in wrong directories. On fresh-site: Synchronize size for group and project logo. Added description on site.xml elements so it displays tooltip. Remove errors for fopx:bookmarks element. Add description to {group, project} logo. Switched off skinconf.rnc validation to promote better forwards-compat. Upgraded to Cocoon 30/08/2003, now with ability to exclude URLs from being processed, in cli.xconf. Add "title" attribute to menu item links using the "description" attribute from entries in site.xml or book.xml The generated Tables of Contents can be configured to show a certain number of section levels. Default is two levels. Level 0 means show no ToC at all. See the fresh-site skinconf.xml for example usage. New 'expand-dtd' target for generating monolithic DTDs suitable for use in catalog-ignorant XML editors such as IDEA. Allow images to scale on pdf output. Comma separated bugs have a link to bugzilla systems. Docbook table header is shifted one column. ihtml now works again. Had to add a jtidy configuration that prevented it to output tidies html to the pipeline, thus making the stylesheet unusable. Also had to fix the sitemap schema. Cleanup maps:components definitions on sub-maps. Remove indent attr from the xsl:output as it is define on serializer. Move xsl:output for *2document.xsl to "xml-document" serializer. abstract element was ignored for html output. Unescape strings, so they display properly on the trail for all skins. Use sync task to clean the tmp directory for xdocs. Now the Krysalis skin has javascript-collapsable menus. site.xml changes now picked up without requiring a reload of the webapp. Updated to Cocoon 20/7/03, and use the new command-line (cli.xconf), which makes Forrest static rendering more than twice as fast as before. New Icons. Added a text2document.xsl stylesheet. Convert to unix format so it stop EOL character. Simplify so it does not use chaperon format. format. Stopped the rewriting of extensions. Updated Cocoon to -D "2003/06/22 12:00". This fixes a bug where files with unknown extensions were written with 'null' appended to their filename. Allow any sort of content inside resources/, which will be made available to the sitemap but not automatically copied to the generated site output. Add a flag for email obfuscation, and turn it off by default. Fixed bug that showed the krysalis-site skin in IE browsers from a remote site to start with a font size of 100. Also made the font size script kick in at the start of the page rendering, as before it resized only after all the page was loaded, which was not nice to say the least. Added alternative menu/tab selection algorithm, that uses tab attributes in site.xml instead of relying on physical site structure (directories). In PDFs, section titles are no longer numbered/reduced in size indefinitely. Upgraded FOP from 0.20.4 to 0.20.5. Upgraded Cocoon to M2. Make FAQ 'Questions' section more legible, and avoid duplicate numbering in FAQ PDF. Links to subdirectories no longer blow up the command-line rendering. The 'backcopy' command will now copy all types of custom content (*.xmap, skinconf.xml, xdocs, images, stylesheets, DTDs). Add a @indexfile attribute to tabs.xml, so that the user can specify which file the tab links to. Enable link rewriting for *.ehtml files. Enable link rewriting for images and figures (@src attribute). Add <elaborate> to the FAQ <question> element, which lets one provide some background (elaboration) in the FAQ body without cluttering the FAQ list. Allow plain text (instead of just block-level elements) in the FAQ's <answer> element. Added a forrest.maxmemory property specifying the maximum amount of memory allocated to the JVM. Useful for rendering large PDFs. Added forrest.jvmargs property for other JVM options. Get breadcrumbs working in Mac IE 5, and don't capitalize the first letter of each link in the forrest-site skin. Fixed bug where absolute paths to images were created in the build/site directory. Get the Wiki syntax support working again. Created new document-v12 DTD module, containing all DTD improvements made since 0.4 was released, and use it to define new v12 versions of all DTDs (document, howto, faq, etc). The doc-v12 DTD removes many restrictions in the DTD that were found to be unnecessary, and is closer to the HTML content model. A list of changes can be found in the doc-v12 sample page. Fixed rendering of images in PDF for images not located in the resources/images dir. Add automatic (doctype-triggered) handling of todo and changes XML files, regardless of file name or location in the directory tree. The root changes.html and todo.html files are still generated from status.xml. On the forrestbar, added a community menu, made 'AskSam' a resources submenu, moved the search part to the right. In skins/common/xslt/html/tab2menu.xsl, renamed template 'unselected-tab-href' to 'calculate-tab-href', potentially breaking 3rd party skins. Fix menu bug where links with #fragment identifiers wouldn't display. Get images in PDFs working with FOP 0.20.x. This requires the user to download jimi.jar from Sun and place it in the lib/core (src distro) or WEB-INF/lib (binary distro) directory. On krysalis skin: fixed print css, also using text instead of logos and adding the footer, and changed link colors to blues and red for active links. On krysalis skin: fixed left navigation bar icons and sizing using divs instead of list elements, made all links underlined, added space to the bottom of the page text, and changed font increase-decrease links to buttons. On krysalis skin: users can select font size, reworked left-bar inclusion of page section titles, made them only one level deep, moved buttons after the left navbar, added publish date on top right navbar. For both Forrest and krysalis skins, added single background pixel line below unselected tabs and made selected tab more prominent. Fixed java.lang.NoClassDefFoundError: javax/servlet/ServletInputStream error. Enabled multiple output links on each page (print - pdf - xml) They can be enabled by adding the relative disable-*-link elements and setting them to false. Allow users to determine which URLs Forrest should ignore, by overriding stylesheets/filterlinks.xsl (and other stylesheets in that directory). Upgraded to 2003-03-11 version of Cocoon Docbook stylesheet improvements. Forrestbar is now Phoenix compatible. Added links for both possible local forrests (port 8080 and 8888), and make them configurable in properties.xml. Thanks to Mark Vovsi for pointing it out. Fix a bug with forrest.antproxy.xml introduced in 0.4, which caused unresolved '${project.home}' variables. Refactored the "transform-to-document" sitemap resource to do the the xinclude, linkrewriter, and idgen steps. Added XInclude capability to the documents. Remember to disable validations for files with xincludes as the xinclude is not performed during validation. Added DocBook 4.2 and simplified DocBook 1.0 to the schemas and to the validation catalogue. Added Docbook and simplified Docbook rendering capability for documents. Use meaningful fragment identifiers in krysalis-skin. Correctly ignore @role='pdf' credits in HTML krysalis-site skin now works better with multi-level menus. Added the CSS validation logo, fixed all skins' CSS to validate, minor fixes due to the switch to full HTML-loose DTD. Normalize space in acronym titles. Make the forrestbot shell script work under Cygwin. Got skins working in the forrestbot. Added a minimal template skin. The problem with starting a new forked JVM is that all properties get lost. This makes it able to use one forrest.properties for all multiple projects, and just create the docs from there. The menu is now limited to only pages in the current subdirectory and below. Added the cwiki stylesheets that were missing and an example in the fresh site seed. Make the forrest-site and krysalis-site skins more printer friendly by using CSS media type to hide navigations. the avalon-tigris skin already works well, the forrest-site one still needs tweaking. Use full loose DTD specification for html pages. This also makes the avalon-tigris skin show the same in Mozilla and IE. Switched all loglevels to ERROR. Added page for ForrestBar on the site with a simple link and an autoinstall link to the forrestbar.xpi generated by Gump every day. Correctly serve swf files. Fix site: and ext: rewriting in book.xml, ihtml, ehtml and cwiki files in subdirectories. If build/webapp/content/xdocs/* is more recent than src/* equivalent, forrest webapp won't clobber it. A new forrest backcopy command will copy build/webapp/content/xdocs content back to src/documentation/content/xdocs. forrest-site skin is now HTML 4.0.1 compliant. The compliance validator logo can be switched off with a skinconf.xml element. Indirectly referenced files in skins (e.g. images in CSSurl()'s) are now copied across to the rendered site. Previously, we relied on spidering to cover the URI space, which has proved insufficient. Lots of FAQ improvements: -Improved URI space by using @id attributes as the #fragment-identifier for <faq> and <part> elements. -Number FAQ entries and categories -Added back-links from FAQ entries to the menu -Process tags in <question> in menu entries -Indent FAQ text -FAQ sample added to seed project Thanks to Joerg Pietschmann and Ralf Hauser for the suggestions. On avalon-tigris skin it's now possible to add a mysite.css file to customize the style. An example that can be used is from chaperon.sf.net. Also added a rounded corner to paragraphs, and many minor fixes. Fixed the annoying link highlighting on the krysalis skin due to the border. Removed the border, now it highlights fine. Added <acronym> tag. Added a means to override the check for existing content: forrest seed -Dskip.contentcheck=yes Thanks to Tom Klaasen. Added the possibility to use svg files instead png images. That is, if an image is found in the images dir that is svg and the browsers requests a png with the same name, the png is created from the svg automatically with batik. Added the possibility to use wiki files in xdocs instead of xml files. They must have a .cwiki extension, and follow the chaperon wiki format ATM. Updated part of the editor so that it now can save files in wiki format. Still needs more work. Updated Batik Block so that now PNGs can be created correctly from SVG. Added "Edit Page" button to edit the current page in Composer. Still needs an icon. Added the possibility to use html files in xdocs instead of xml files. They must have an .ihtml extension. HTML fragment identifiers for sections are now meaningfully named, based on the section title, rather than document-id()-generated characters. Fixed site regeneration bugs where changing the skin in forrest.properties had no effect after the first build. Added copyright statement to PDF footer (10pt, light-grey text). if a skinconf.xml 'credit' element has a role='pdf' attribute, this text will be used instead. Thanks to Keiron Liddle. Now all files in src/documentation/content (except xdocs) and src/documentation/resources/images are copied across when Forrest generates a static site. This fixes the problem when an unparseable file links to another, and Cocoon can't crawl (and hence copy) the linked-to file. An example of this are CSS url('foo.png') image refs (so krysalis-site will now work properly). Also, large batches of pregenerated files like Javadocs will now be copied across instead of individually traversed. New site.xml file in content/xdocs. This is used to implement <link href="site:internalURI"> 'semantic' links, <link href="ext:externalURI"> aliases to external links, and renders book.xml files obsolete. See Menus and Linking for more info. Updated some documentation, especially Forrestbot Introduction Now files present in the content dir are correctly linked and copied verbatim by the CLI. The wellknown files are given with the correct mime-type, and links in html and xml are followed. Update to 2002-12-26 Cocoon. Tweaked forrestbar, added a sub-project menu for Jakarta, fixed download link and added submenu for tools and gump. Added rss capability to changes generation. Added latest krysalis-site skin, using common templates where possible. There is a changes2rss stylesheet that still needs sitemap changes to run. Now even the selected tab retains a link, to be able to easily select the main page of that tab even if it is "current". Fixed a bug in the search form where there was no space between search term and 'site:' term. Search form also no longer requires Javascript. Allow special handling of tab hrefs with #anchor references in them. By default, such menu links are always clickable. Fixed a bug where the no menu entry is 'selected' when in subdirectories. Updated avalon-tigris skin by merging what was in CVS here and what was used in Avalon with its Cocoon-generated site. The visual effect is the same to the current framework and Exalibur Avalon sites. Now error reporting in CLI runs should work and show the cause of the error; before it was just reporting [broken link]. Updated latest Cocoon jars: chain metamodule name set to "forrest", and it is used instead of the default one. Fixed a bug where multiple menu entries are highlighted if the filenames share a common prefix. Allow configuration of a project local-catalog and the entity resolver verbosity level, via forrest.properties configuration. This replaces tokens in the default cocoon.xconf Fixed a bug in forrest.bat, which would fail if run from a different drive to that Forrest was installed in. Fix bug where the webapp would break due to missing XML jars under JDK 1.2/1.3. Moved credit and host logos to bottom left corner on forrest-site skin. Make the seed project use the correct 'built with Apache Forrest' logo instead of Cocoon + Centipede logos. Rewrite skins to share a common block of XSLT, which is used via <xsl:import>. This should make skin maintenance much easier. Removed the 'basic' skin, to be shortly replaced with something much more maintainable. Removed some images (built-with-cocoon.gif, centipede-logo-small.gif) from the skins, and moved them to src/documentation/resources/images, as they are Forrest-specific. Added enhancements to status.xml to comply with the needs for a complete status file, like other "STATUS" text files at Apache. Stylesheets not yet done. Added buttons for nightly Gump runs and local forrest. Corrected and completed existing interface, and made buttons flat (the bar is slimmer too). We need icons for the new buttons. Fixed bug where validation of xdocs was not descending into sub-directories. Fixed bug where changes to the breadcrumb links in skinconf.xml were ignored until the Forrest binary was rebuilt, or the project build/tmp/ deleted. Webapp now works under JDK 1.3 (parsers weren't being copied) SourceAction or the so-called 'content aware pipelines' enables conditional processing of XML documents based on their grammar, being indicated by their DTD, XML Schema PI, root element, or a processing instruction (PI) in the prolog of the document. Added a convert dir in the resources with stylesheets and buildfile to help convert Anakia and Maven-based sites. Validate project sitemaps and choice of skin Validation of important core configuration files at build-time using RELAX NG. Fixed selected menu link (meant to be inactive and yellow) Now an id attribute on any XML element below <body> will be rendered as an anchor which can be linked to. Fixed webapp redirect problems under Tomcat and (sometimes) under Jetty. Added alpha system for editing content in the webapp. To try it do "forrest run" and point the browser to http://localhost:8888/edit/ . Added avalon-tigris skin. Removed unmaintained skins: avalon-site, jakarta-site, xml-apache-site, Removed the dependency that the default "site" target had on clean-site. It means that running "forrest" will not delete the current files in ./build/site/** . Now Cocoon serves a file directly if the filename matches the one in ./src/documentation/contents/** . Put the internal matches in a separate pipeline with internal-only="true". Now site builds do not delete files in build/site that are included in the Ant list of default excludes, like CVS info. Included Jetty in the distro. type "forrest run" to have the ./build/webapp dir contents be run in a local web server, starting from http://localhost:8888/index.html Added a docbook2document.xsl stylesheet to library/xslt. XML validation is now fully configurable through a hierarchical set of forrest.validation.*{includes,excludes,failonerror} properties. Validate XSLTs in user skins and resources/stylesheets directories. Added new document Standards Compliance Thanks to Robert Koberg. Added Jing "RELAX NG validator in Java" and initial grammar for skinconf.xml files. These config files now get validated during the build. Enhanced forrest-site skin's tabs. Any URL (not just directories) can now be tabbed with a new 'href' attribute. There is an improved 'longest match' algorithm for deciding which tab is on which is more robust than the old one. Fixed a bug where having a tabs.xml link to a file not otherwise mentioned in book.xml caused a broken link. See forrest-dev discussion Fixed all broken links in the Forrest site. Simplified the sitemap-stylesheet contract. Instead of 'dir' and 'resource' parameters with varying meaning, there is just one 'path' parameter. Allow user to specify what XML files to validate via forrest.validate.{includes,excludes} properties. Fixed broken PDFs in most subdirectories. Added a subdirectory to the template site and fixed all broken links. XML doc files are now validated before rendering with the 'validate' target. Uses OASIS catalogs provided by Forrest, optionally augmented by user project catalogs. The distribution no longer requires Ant to be preinstalled. Now, nothing but a Java installation is needed. Building Forrest no longer requires a network connection (for downloading Centipede). It is buildable by typing 'ant' or with the provided build scripts. Fixed ClassNotFoundException when running on JDK1.4.x Allow xml:space='preserve' attribute on <p> element, which preserves space without the changed font and block display that <code> uses. Fixed a bug where the log files weren't being created. Thanks to Vladimir Bossicard for reporting. User projects can now override the default cocoon.xconf and logkit.xconf files, by placing these files in src/documentation/conf PDFs for faq, changes and todo now work. "Change History" images (update.jpg, add.jpg etc) are now provided by default by Forrest (in images/), and need not be supplied by user projects. User projects can now add custom classes and jars to Forrest doc builds. Useful for custom sitemap components, or overriding Forrest-provided jars. The locations where Forrest expects doc files to be is now configurable via properties, that can be set in forrest.properties. User projects may now specify their own sitemap, overriding the Forrest-provided one. Made forrest-site skin fully generic, usable with any project. Skins are configured through an external 'skinconf.xml' file, specified by the project. Fixed bug where multiple copies of the same image where generated, one for each directory. Now all image links are page-relative, leading to a single copy. Fixed tab links, which were previously hardcoded and forrest-specific. They are now page-relative. tabs.xml file entries no longer have to end in '/'. Added new document Your Project - getting started with using Forrest Added to the "forrest-site" skin the ability to split source code larger than 80 chars in two or more lines. Replace the "forrest-site" skin with the new "bert" skin. Added the forrestbot - infrastructure and configuration for remote project building. Added breadcrumb trail script from the Avalon site skin. Updated Cocoon to 2.1-dev to use xsltc and new CLI status messages. Logs are in the build/work/WEB-INF/logs directory and the list of broken links is in the build directory. added NekoDTD-based DTD documentation using a custom Cocoon Generator draft forrest toolbar for Mozilla Initial import of Libre facility - replacement for */book.xml Added a draft DTD for the Gump Descriptor forrest.xgump Forrest website is being automatically built and published to krysalis.org Designed a new skin for the Forrest documents. Particular attention to cross-browser issues. Added initial "Dream List" by harvesting statements from the forrest-dev mail list. Added simple xsl stylesheet for forrest.xgump. In IE6 and Mozilla 6 it renders using this, in older ones it uses the more simplifies CSS version. Added Forrest to Gump runs. Added preliminary version of a scarab-like skin. Added simple css stylesheet for forrest.xgump. In IE and Mozilla 6 it renders. Fixed links in Forrest home page and added: contributing, mailing list, list archives, who we are. Updated Centipede stuff to latest changes: - added lib/endorsed dir for endorsed jars that are put in global calsspath - changed the build scripts to not make direct reference to jar files - added "examples" dir in src and creation of examples jar in buils - added "testmodule" target to be run before committing stuff - added "gump" build to be run by Gump Merged forrest needed info in forrest.xgump. Updated project descriptor: now it should be usable by Gump. Added basic Forrest descriptor. Refactored site generation stuff to use skins; still need to integrate with xforrest descriptor. Added jakarta-site, xml-apache-site, cocoon-printer skins. Imported Centipede as a build system. Ensure that initial DTDs are valid and that the initial XML instances can be validated using these DTDs and OASIS Catalogs. Initial Import Please see our Jira issue tracker for tasks to be done. Note that the Todo list below is old. We need someone to move those tasks over to the issue tracker. Rework the menu generation system to make it more flexible. See thread Fixing menus Define an 'object model' for Forrest sites, in the form of a Cocoon pipeline, that defines - The directory structure of a site - Site metadata (what currently lives in skinconf.xml + gump.xml stuff) - Perhaps site.xml metadata for pages? This info can then be made public to the sitemap (via XMLFileModule attributes) and the stylesheets (through document(cocoon:/...) calls or inlined with source XML). Finalise the project-definition DTDs, like status.xml and module.xml; try to come up with a common format with others on community.at.apache.org. Finish the RSS feed for status.xml. Aggregate status.xml and project.xml to have all needed project data. Add stylesheets to render the enhanced status.xml file contents. In skinconf.xml, change 'disable-search' to 'enable-search'. Enhance the initial forrest toolbar for Mozilla. See email discussion draft forrest toolbar for Mozilla. Fix things so docs can be edited in src/*, and have the changes appear immediately in the webapp. Involves creating/using an InputModule for passing 'forrest.skin' and other properties to the sitemap, so we can avoid the @skin@ hack, and a bit of forrest.build.xml hacking. There are some @tokens@ in a forrest-site CSS file that also need some sort of in-place modification. Perhaps a @token@-to-value Transformer could be the same ${variable}-to-value Transformer mentioned in the RT [3]. Act on 'Entities in XML docs' RT. I can implement Stefano's suggested solution quite easily, but is such limited functionality worth the cost of introducing a proprietary ${variable} syntax? Maybe.. Best short-term alternative seems to be using the XNI XInclude processor for pre-validation inclusion. A lot of the info on the website is outdated. Using metadata from site.xml, it would at least be possible to indicate how old the doc is, and perhaps indicate its relevance from a small controlled vocabulary. Develop a mechanism for supporting legacy URLs. See email discussion - redirects with static sites Fix up and integrate the Forrest Maven plugin. Ensure that PHP-like stuff can be embedded easily in Forrest files and document it. Continue the development of the Libre facility - replacement for */book.xml Start a community doc where we list tools such as "code". Migrate to a decent schema language, primarily so that we can use namespaces in XML docs, allowing things like XInclude, in-line metadata, in-line SVG, Jelly snippets, or anything else users can make a Transformer for. Streamline the process of adding support for new schemas. Ideally we'd have an auto-download system, e.g. 'forrest-update docbook' would fetch and install the Docbook DTDs, create catalog entries, sitemap mods etc. Make a CSS Generator and a stylesheet to serialize it to text. Add a document about authoring in XML for beginners..