Delivered-To: mailing list svn@forrest.apache.org Received: (qmail 2205 invoked by uid 99); 11 Apr 2005 14:41:21 -0000 X-ASF-Spam-Status: No, hits=-9.2 required=10.0 tests=ALL_TRUSTED,NORMAL_HTTP_TO_IP,NO_REAL_NAME,WEIRD_PORT X-Spam-Check-By: apache.org Received: from minotaur.apache.org (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.28) with SMTP; Mon, 11 Apr 2005 07:41:16 -0700 Received: (qmail 56577 invoked by uid 65534); 11 Apr 2005 14:41:15 -0000 Message-ID: <20050411144115.56574.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Mailer: svnmailer-1.0.0-dev Date: Mon, 11 Apr 2005 14:41:15 -0000 Subject: svn commit: r160890 [2/4] - in forrest/site/0.7: abs-linkmap abs-menulinks contrib.html docs.html flyer.html forrest-issues.html guidelines.html index.html license.html linkmap.html live-sites.html mail-lists.html proposal-asf-forrestbot.html proposal-asf-publish.html who.html To: svn@forrest.apache.org From: crossley@apache.org X-Virus-Checked: Checked X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Added: forrest/site/0.7/forrest-issues.html URL: http://svn.apache.org/viewcvs/forrest/site/0.7/forrest-issues.html?vie= w=3Dauto&rev=3D160890 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- forrest/site/0.7/forrest-issues.html (added) +++ forrest/site/0.7/forrest-issues.html Mon Apr 11 07:41:12 2005 @@ -0,0 +1,642 @@ + + + + + + + + +Open issues for the upcoming release (v0.7) + + + + + + + + + +

+ +

+apache > forrest +

+ + +

+ + + + + +

+ Font size:=20 + = =20 + + +

Open issues for the upcoming release

+ This is documentation for current release v0.7 + (More ...)

Note

These are the open issues for our upcoming release = listed in our + issue tracking system + (see=20 + all open iss= ues). + The listing below is regenerated on each Forrest run.

+ +

[FOR-475] move some docs in forrest_06_branch = e=2Eg. faq.html changes.html into /docs/

+http://issues.coco= ondev.org//browse/FOR-475 +

This is just a convenience for us with website maintenance.

+ +

[FOR-470] docs and fresh-site samples for "raw= content" need update

+http://issues.coco= ondev.org//browse/FOR-470 +

The documentation about "raw content" describes the method us= ed prior to version 0.7 +
+so we need to update docs and the fresh-site samples. +
+faq.html and upgrading_07.html and elsewhere. +
+

+ +

[FOR-468] refresh the listings of build output= messages

+http://issues.coco= ondev.org//browse/FOR-468 +

e.g. docs-author/content/xdocs/your-project.xml

+ +

[FOR-465] Logging Error: Writing event to clos= ed stream.

+http://issues.coco= ondev.org//browse/FOR-465 +

After doing 'forrest' there is a strange error message at the end of Co= coon's run: +
+"Logging Error: Writing event to closed stream." This happens on= every different project that i have tried.

+ +

[FOR-457] Carry over meta-data tags form DocV2= .0 sources

+http://issues.coco= ondev.org//browse/FOR-457 +

http://marc.theaimsgroup.com/?l=3Dforrest-dev&m=3D11032406= 1019177&w=3D2 +
+ +
+Describes a way of using the meta data provided in a document 2.0 when gen= erating HTML pages.

+ +

[FOR-454] add content about major changes for = this release

+http://issues.coco= ondev.org//browse/FOR-454 +

We need notes about the major changes for this release: +
+upgrading_07.xml +
+announcement-0.7.txt +
+RELEASE-NOTES-0.7.txt

+ +

[FOR-433] OpenOffice.org plugin produces inval= id intermediate documents

+http://issues.coco= ondev.org//browse/FOR-433 +

The intermediate XML produced by the OOo plugin does not conform to the= document-v12 DTD, even though the xsl:output element in openoffice-common2= forrest.xsl says so. In particular: +
+ +
+* The intermediate document contains a <style> element inside <he= ader>; invalid per the DTD. +
+* <p> elements contain a "class" attribute; invalid per th= e DTD. +
+* <fixme> elements do not contain an "author" attribute, t= hough required by the DTD. +
+ +
+Steps to reproduce: +
+* Run "forrest run" from the plugins/org.apache.forrest.plugin.O= penOffice.org subdirectory of your Forrest checkout. +
+* Download http://localhost:8888/samples/openoffice-writer.xml and have the docum= ent checked by your favorite validating parser. +
+ +
+The trouble with this is that the FO stylesheets carry the contents of the= <style> element over into the result tree, where they pop up as part= of the ToC. This looks like fairly meaningless gibberish to the reader of = the resulting PDF (etc.) document. You may verify this by checking http://localhost:8= 888/samples/openoffice-writer.pdf in the above-mentioned setup.

+ +

[FOR-430] FO output ignores color settings def= ined by skinconf.xml

+http://issues.coco= ondev.org//browse/FOR-430 +

When using FO output, Forrest ignores color settings defined in skincon= f=2Exml. This is due to the fact that the document2fo.xsl stylesheet (in th= e "common" skin) uses hard-coded color values, rather than checki= ng skinconf.xml for the user's own color settings.

+ +

[FOR-429] Missing navigation links on Forrest = site

+http://issues.coco= ondev.org//browse/FOR-429 +

Take a look at our published website home page - http://forrest.apache.org +
+ +
+In particular not the About menu items on the left: +
+ +
+About +
+  Index +
+  License +
+  Download +
+  Who we are +
+  Flyer +
+  Example sites +
+ +
+Now look at the about navigation menu on the FAQ page: +
+ +
+About +
+  Index +
+  License +
+  Download +
+  Who we are +
+  FAQs +
+  Changes +
+  Todo +
+  Example sites +
+ +
+Note that the items below do not appear on the home page. +
+ +
+  FAQs +
+  Changes +
+  Todo

+ +

[FOR-416] input/output formats documented

+http://issues.coco= ondev.org//browse/FOR-416 +

Clearly document all possible input and output formats, and any advanta= ges and disadvantages of them. IMHO, I envision this as a new, short page,= rather than letting it get lost in any existing page (although it would be= good also to modifying the front page's quick steps and Using Forrest to s= how there are more options than XML for source).

+ +

[FOR-394] html2document.xsl misses content bef= ore first h1 element

+http://issues.coco= ondev.org//browse/FOR-394 +

The html2document.xsl stylesheet does not transform content that preced= es the first H1 element.

+ +

[FOR-391] website docs/site split

+http://issues.coco= ondev.org//browse/FOR-391 +

Split our website into a standalone documentation site (which will be m= aintained per version/branch) and the main version-independent site.

+ +

[FOR-341] Plugin resources are not copied to s= ite

+http://issues.coco= ondev.org//browse/FOR-341 +

If a plugin contains some resources required in a statically built site= (such as Javascripts) they are not copied across to build/site when "= ;forrest site" is run

+ +

[FOR-335] Generate Plugins documentation

+http://issues.coco= ondev.org//browse/FOR-335 +

When functionality is removed from Forrest core and placed in plugins t= he samples in the documentation and fresh-site should also be removed. Howe= ver, this leaves us in the position where new Users cannot see the potentia= l of Forrest + plugins. +
+ +
+We need to include the documentation and samples within plugins in the For= rest website and also include a list of plugins and their funcitionality in= fresh-site. +
+ +
+

+ +

[FOR-262] openoffice2forrest: add support for = merged cells in tables

+http://issues.coco= ondev.org//browse/FOR-262 +

Processing of OpenOffice files is useful, but tables containing merged = cells are not handled properly, preventing the use of many OpenOffice docum= ents with Forrest. +
+ +
+If you merge two cells in OOo you get this attribute: table:number-columns= -spanned=3D"2" and this could translate into the HTML colspan=3D&= quot;2" attribute. But it's not happening - does this first require an= enhancement of the Forrest DTD? Which seems to contain the following: +
+ +
+<!ENTITY % cell.span 'colspan CDATA "1" +
+         rowspan CDATA "= 1"'> and=20 +
+ +
+<!ATTLIST td +
+  %common.att;=20 +
+  %cell.span;=20 +
+ +
+Does this prevent cells from spanning rows and columns?

+ +

[FOR-259] openoffice files can skip sections +
+
+http://issues.coco= ondev.org//browse/FOR-259 +
+
Create an openoffice file with lines like this: +
+ +
+Heading 2 +
+Heading 3 +
+Heading 4 +
+Heading 9 +
+Heading 2 +
+ +
+The last two lines are not translated into sections.
+
+ +

[FOR-241] forrest undoes entity resolution

+http://issues.coco= ondev.org//browse/FOR-241 +

If I have a url like this inside the XML source: +
+ +
+http://sourceforge.net/sflogo.php?group_id=3Dcomics-grabber&type= =3D1 +
+ +
+validate-xdocs fails because it wants the literal & to be typed out as +
+& instead. So I correct it to become: +
+ +
+http://sourceforge.net/sflogo.php?group_id=3Dcomics-grabber&= amp;type=3D1 +
+ +
+However, the generated HTML has the entity resolution UNDONE!: +
+ +
+http://sourceforge.net/sflogo.php?group_id=3Dcomics-grabber&type= =3D1 +
+ +
+This HTML fails validation as 4.01 transitional. +
+ +
+David Crossley adds: +
+There is a demonstration of the problem in the document +
+src/documentation/content/xdocs/docs/dreams.xml +
+The ampersand in the link element text is properly handled but +
+the ampersand in the link href attribute is not.

+= +

[FOR-229] SVG not converted to PNG

+http://issues.coco= ondev.org//browse/FOR-229 +

See http://mail-archi= ves.apache.org/eyebrowse/BrowseList?listName=3Ddev@forrest.apache.org&b= y=3Dthread&from=3D828955

+ +

[FOR-227] static html site: index.html missing= in links

+http://issues.coco= ondev.org//browse/FOR-227 +

When creating a static html site (running command "forrest") +
+links in the document that point to a directory (index.html) +
+are broken when using the site without a server (file:= //) +
+ +
+To fix: add the filename to the links, i.e. +
+create <a href=3D"../chapter1/index.html">=20 +
+instead of <a href=3D"../chapter1/"> +
+

+ +

[FOR-185] Can't get svg files served along wit= h the PNG

+http://issues.coco= ondev.org//browse/FOR-185 +

The sitemap does not allow to get a file that is in xdocs as .svg, thus= preventing users from adding a link to it from a page that contains the pn= g version.

+ +

[FOR-145] Make Forrest able to be imported by = Ant

+http://issues.coco= ondev.org//browse/FOR-145 +

I use an ant build system called antworks, +
+http://antworks.sourceforge.n= et/ +
+ which includes an antlet for forrest. +
+Antlets are included into a projects build file with a ant <import> = task. =20 +
+ +
+However forrest has many common target names and properties. =20 +
+Please prefix all targets and properties with "forrest." to supp= ort using ant import of the entire forrest.build.xml

+ +

+ + + Propchange: forrest/site/0.7/forrest-issues.html ---------------------------------------------------------------------------= --- svn:eol-style =3D native Added: forrest/site/0.7/guidelines.html URL: http://svn.apache.org/viewcvs/forrest/site/0.7/guidelines.html?view=3D= auto&rev=3D160890 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- forrest/site/0.7/guidelines.html (added) +++ forrest/site/0.7/guidelines.html Mon Apr 11 07:41:12 2005 @@ -0,0 +1,806 @@ + + + + + + + + +Apache Forrest project guidelines (v0.7) + + + + + + + + + +

+ +

+apache > forrest +

+ + +

+ + + + + +

+ Font size:=20 + = =20 + + +

Apache Forrest project guidelines

+ This is documentation for current release v0.7 + (More ...)

+The mission of Apache Forrest +
+The Apache Way +
+Roles and responsibilities +
+Project Management Committee (PMC) +
+Decision making +
- +Voting +
- +Types of approval +
- +Vetoes +
- +Actions +
- +Voting timeframes +
- +Voting procedure +
- +Ultimatum and breakdown +
+
+Code management +

=20 + =20 +

+ This document provides the guidelines under which the Apache Forrest + project operates. It defines the roles and responsibilities, who may vo= te, + how voting works, how conflicts are resolved, etc. + Apache Forrest is a project of the Apache Software Foundation + (ASF) which holds + the copyright for all Apache projects. The ASF website explains the + operation and background of the ASF. These project guidelines supplemen= t that + ASF documentation. Normally these guidelines are not needed - the proje= ct + just gets on with its day-to-day operation - but they enable + all people to understand how the project operates. +

+ + =20 + +

The mission of Apache Forrest

+ The generation of aggregated multi-channel documentation, + maintaining a separation of content and presentation. +

+ + =20 + +

The Apache Way

+ Forrest is typical of Apache projects, in that it operates under a s= et of + principles known collectively as the "Apache Way". This facilitates + open collaborative development, with respect for others. + For more information about how Apache projects operate, please refer= to + the + ASF foundation + and + ASF developer sections + of the ASF website, including the + ASF ByLaws<= /a> + and the + How i= t works document, + as well as the + Incubator project. +

+ + =20 + +

Roles and responsibilities

The meritocracy enables various roles as defined in the + How i= t works document. +

+ =20 +user<= /a> -> + developer -> + committer -> + PMC member -> + ASF member + =20 +

The current Apache Forrest committers and PMC members are + listed. +

+ + =20 + +

Project Management Committee (PMC)

The Apache Forrest project was established in January 2002 and became a + top-level project in May 2004. + The Project Management Committee (PMC) was created by a + resolution + of the board of the Apache Software Foundation. + See explanation of the role of the PMC in that resolution and also t= he + ASF Bylaws<= /a> + and=20 + How= -it-works. +

The responsibilities of the PMC include:

Be familiar with these project guidelines, and the + ASF Bylaws, and with the ASF documentation and procedures + in general.
Keep oversight of the commit log messages and ensure that + the codebase does not have copyright and license issues.
Resolve license disputes regarding products of the project, + including other supporting software that is re-distributed.
Decide what is distributed as products of the project. + In particular all releases must be approved by the PMC.
Guide the direction of the project.
Strive for and help to facilitate a harmonious productive community. + =20 +
Nominate new PMC members and committers.
Maintain the project's shared resources, including the + codebase repository, mailing lists, websites.
Speak on behalf of the project.
Maintain these and other guidelines of the project.

+ The PMC does have a private mailing list on which it can discuss + certain issues. However this list is rarely used and every effort + is made to conduct all discussion on the public mailing lists. +

+ Membership of the PMC is by invitation only and must receive + consensus approval of the active PMC members. +

+ A PMC member is considered + "emeritus" by their own declaration or by not contributing in + any form to the project for over six months. An emeritus member may + request reinstatement to the PMC. Such reinstatement is subject to + consensus approval of the active PMC members. Membership of the PMC = can be + revoked by unanimous consensus of all active PMC members (other than + the member in question). +

+ The chair of the PMC is appointed by the Board and is an officer of + the ASF (Vice President). The chair has primary responsibility to the + Board, and has the power to establish rules and procedures for the + day to day management of the communities for which the PMC is + responsible, including the composition of the PMC itself. + The chair reports to the board quarterly on developments within the + project. The PMC may consider the position of PMC chair annually and=20 + may recommend a new chair to the board. + Ultimately, however, it is the board's responsibility who it chooses + to appoint as the PMC chair. + See further explanation of the role of the chair in the + ASF Bylaws<= /a> + and the + PMC FAQ + =20 +

+ + =20 + +

Decision making

+ Different types of decisions require different + forms of approval. For example, the previous section describes + several decisions which require "consensus approval". This + section defines how voting is performed, the types of approval, and = which + types of decision require which type of approval. +

+ Most day-to-day operations do not require explicit voting - just get= on + and do the work. See the "Lazy approval" type described below. +

+ +

Voting

+ Certain actions and decisions regarding the project are made by vo= tes + on the project development mailing list. Where necessary, + PMC voting may take place on the private PMC mailing list. +

+ Votes are clearly indicated by subject line starting with [VOTE]. + Discussion and proposal should have happened prior to the vote. + Voting is carried out by replying to the vote mail.=20 + See voting procedure below. + Votes are expressed using one of the following symbols: +

+ + =20 + + =20 + + + =20 + + + =20 + + =20 + + + =20 + + + =20 + + =20 + + + =20 + + + =20 + + =20 + + + =20 + + + =20 + + =20 + + + =20 + + =20 +

+1	+ "Yes," "Agree," or "the action should be + performed." In general, this vote also indicates a willingness + on the behalf of the voter to assist with "making it happen". +
+0	+ This vote indicates a willingness for the action under + consideration to go ahead. The voter, however will not be able + to help. +
-0	+ This vote indicates that the voter does not, in general, agree= with + the proposed action but is not concerned enough to prevent the + action going ahead. +
-1	+ This is a negative vote. On issues where consensus is required, + this vote counts as a veto. + All vetoes must + contain an explanation of why the veto is appropriate. Vetoes = with + no explanation are void. It may also be appropriate for a -1 v= ote + to include an alternative course of action. +
abstain	People can abstain from voting. = They can either remain + silent or express their reason. +

+ All participants in the project are encouraged to show their + preference for a particular action by voting. When the votes are + tallied, only the votes of PMC members are binding. Non-binding + votes are still useful to enable everyone to understand the + perception of an action by the wider community. +

+ Voting can also be applied to changes made to the project codebase= . These + typically take the form of a veto (-1) in reply to the commit mess= age + sent when the commit is made. +

+ +

Types of approval

+ Different actions require different types of approval: +

+ + =20 + + =20 + + + =20 + + + =20 + + =20 + + + =20 + + + =20 + + =20 + + + =20 + + + =20 + + =20 + + + =20 + + + =20 + + =20 + + + =20 + + =20 +

Consensus approval	+ Consensus approval requires 3 binding +1 votes and no binding = vetoes. +
Lazy majority	+ A lazy majority vote requires 3 binding +1 votes and more bind= ing +1 + votes that -1 votes. +
Lazy approval	+ An action with lazy approval is implicitly allowed unless a -1= vote + is received, at which time, depending on the type of action, e= ither + lazy majority or consensus approval must be obtained. +
2/3 majority	+ Some actions require a 2/3 majority of active PMC members. + Such actions typically affect the foundation + of the project (e.g. adopting a new codebase to replace an exi= sting + product). The higher threshold is designed to ensure such chan= ges + are strongly supported. To pass this vote requires at least 2/= 3 of + binding vote holders to vote +1 +
Unanimous consensus	+ All voters with binding votes must vote and there + can be no binding vetoes (-1). +

+ +

Vetoes

+ A valid veto cannot be over-ruled, it can only be withdrawn by its= issuer. + Any veto must be accompanied by reasoning and be prepared to defen= d it. +

+ The validity of a veto, if challenged, can be confirmed by anyone = who + has a binding vote. This does not necessarily signify agreement wi= th the + veto - merely that the veto is valid. In case of disputes about wh= ether + a veto is valid, then opinion of the PMC chair is final. +

+ If you disagree with a valid veto, then you must engage the person + casting the veto to further discuss the issues. The vetoer is obli= ged + to vote early and to then work with the community to resolve + the matter. +

+ If a veto is not withdrawn, the action that has been vetoed must + be reversed in a timely manner. +

+ +

Actions

+ This section describes the various actions which are undertaken wi= thin + the project, the corresponding approval required for that action, = and + those who have binding votes over the action. +

+ + =20 + + =20 + + + + + =20 + + =20 + + =20 + + + + + =20 + + =20 + + =20 + + + + + =20 + + =20 + + =20 + + + + + =20 + + =20 + + =20 + + + + =20 + + =20 + + =20 + + + + + =20 + + =20 + + =20 + + + + + =20 + + =20 + + =20 + + + + + =20 + + =20 + + =20 + + + + + =20 + + =20 + + =20 + + + + + =20 + + =20 +

Action	Description	Approval	Binding Votes
Code change	+ A change made to a codebase of the project by a committer. + This includes source code, documentation, website content, etc. +	+ Lazy approval +	+ Active PMC members +
Release plan	+ Defines the timetable and actions for a release. +	+ Lazy majority +	+ Active PMC members +
Product release	+ When a release of one of the project's products is ready, a vo= te is + required to accept the release as an official release of the + project. +	+ Lazy majority +	+ Active PMC members +
Adoption of new codebase<= /td> +	+ When the codebase for an existing, released product is to be + replaced with an alternative codebase. If such a vote fails to + gain approval, the existing code base will continue. + This also covers the creation of new sub-projects + within the project. +	+ 2/3 majority +	+ Active PMC members +
New committer	+ When a new committer is proposed for the project. +	+ Consensus approval +	+ Active PMC members +
New PMC member	+ When a new member is proposed for the PMC. +	+ Consensus approval +	+ Active PMC members +
Reinstate emeritus member=	+ An emeritus PMC member can be reinstated. +	+ Consensus approval +	+ Active PMC members (excluding the member in question) +
Committer removal	+ When removal of commit privileges is sought. +	+ Unanimous consensus +	+ Active PMC members (excluding the committer in question if a + member of the PMC) +
PMC member removal	+ When removal of a PMC member is sought. + See also section 6.5 of the ASF Bylaws whereby the ASF Board m= ay + remove a PMC member. +	+ Unanimous consensus +	+ Active PMC members (excluding the member in question) +

+ +

Voting timeframes

+ Votes are open for a period of one week to allow all active voters + time to consider the vote. If the vote has not achieved a quorum, + then it can be extended for another week. If still no quorum, then + the vote fails, and would need to be raised again later. + Votes relating to code changes are not subject to a strict timetab= le, + but should be made as timely as possible. +

+ +

Voting procedure

+ Discussion about the topic would have already happened in a [Propo= sal] + email thread to express the issues and opinions. The [Vote] thread= is + to ratify the proposal. +

+ The instigator sends the Vote email to the dev mailing list. + Describe the issue with no ambiguity and in a positive sense. +

+ Votes are expressed by replying email using the + voting symbols defined above. + Voters can change their vote during the timeframe. + At the end of the vote period, the instigator tallies the number of + final votes and reports the results. +

+ +

Ultimatum and breakdown

+ For breakdown situations and those requiring unanimous consensus, + if this consensus cannot be reached within the extended timeframe, + then the Board expects the chair to act as the officer of the + Foundation and make the ultimate decision. +

+ + =20 + +

Code management

+ =20 +Commit-then-review. +

+ + + +

+ +

+ + + Propchange: forrest/site/0.7/guidelines.html ---------------------------------------------------------------------------= --- svn:eol-style =3D native Added: forrest/site/0.7/index.html URL: http://svn.apache.org/viewcvs/forrest/site/0.7/index.html?view=3Dauto&= rev=3D160890 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- forrest/site/0.7/index.html (added) +++ forrest/site/0.7/index.html Mon Apr 11 07:41:12 2005 @@ -0,0 +1,464 @@ + + + + + + + + +Welcome to Apache Forrest (v0.7) + + + + + + + + + +

+ +

+apache > forrest +

+ + +

+ + + + + +

+ Font size:=20 + = =20 + + +

Welcome to Apache Forrest

+ This is documentation for current release v0.7 + (More ...)

=20 + =20 + +

Introduction

Apache Forrest is an XML standards-oriented documentation framework + based upon Apache Cocoon, providing XSLT stylesheets and schemas, + images and other resources. Forrest uses these to render the source + content into a website via command-line, robot, or dynamic=20 + application. +

+ + =20 + +

User-friendly

+ Forrest is designed with the new user in mind. Much effort has go= ne + into making the process of generating a new site easy and + simple: +

+
+ =20 +
+Step 1: Do 'forrest seed'= to populate + the directory with template site structure and contents.
+ =20 +
+Step 2: Add content by editing docs in + task-specific, presentation-neutral XML.
+ =20 +
+Step 3: Do 'forrest run' = then use + the web browser to immediately review + changes at http://localhost:8888/ + =20 +
+ =20 +
+Step 4: Do 'forrest' to g= enerate the + complete website from the XML sources. + Various styles (known as skins) are available. Custom skins + can be developed.
+ =20 +
+Step 5: For more information about installation + and use, see the=20 + Using Forrest guide. +
+ =20 +
+
+ Forrest's focus on low "startup cost" makes it ideal for rapid + development of small sites, where time and budget constraints do n= ot + allow time-wasting HTML experiments. Of course, that same methodol= ogy + can scale up to large projects. + Your development team does not need Java experience, or even XML s= kills, + to use Forrest. The framework lets you concentrate on content and = design. +
+
+ By separating content from + presentation, providing content templates + and pre-written skins, Forrest is unequalled at e= nabling + content producers to get their message out fast. This separation = of + concerns makes Forrest excellent + to publish project documentation (notably softwar= e projects), + intranets, and home pages, + and anything else you can think of. +
+

+ =20 + +
Powerful
+
+
+ Forrest is far from a quick and dirty solution however. Forrest is + built on one of the world's leading XML application frameworks,=20 + Apache Cocoon, which= provides advanced + users with extremely powerful publishing capabilities. +
+
+ =20 +
Multiple task-specific source XML formats can be used + (How-To, + FAQ, + changelogs and + todo lists supported natively). + Source formats include: Apache xdocs xml format, plain html + documents, some Wiki formats, a subset of DocBook, ... +
+ =20 +
Multiple output formats supported, for example HTML and PDF (using + Apache FOP). +
+ =20 +
SVG to PNG rendering (using A= pache + Batik). Simply drop the SVG in the appropriate directory + and it will be rendered as PNG.
+ =20 +
+ Transparent inclusion and aggregation of external content, like + RSS feeds= . +
+ =20 +
+ Anything else possible with the + Cocoon sitemap. Using database + queries, charting, web services + integration; the possibilities are constantly growing as Cocoon = grows. + See the C= ocoon Features list + for the full suite of capabilities. +
+ =20 +
+ Based on Java, Forrest is platform-independent, making for a + documentation system that is just as portable as the XML data it + processes. +
+ =20 +
+ +
Static or Dynamic
+
+ Unique amongst comparable documentation tools, Forrest generates + sites that can run both interactively as a dyna= mic + web application, or as statically rendered pages. +
+
+ This provides a path for site growth: start off small and static= , and + if dynamic features (user login, forms processing, runtime data,= site + search etc) are one day needed, these can be accommodated by swi= tching + to webapp mode. +
+
+ Running as a webapp has a major advantage during development: + content can be written, and + then the rendered output viewed almost instantly in a web browse= r=2E + This webapp technique<= /a> + enables Forrest's edit/review cycle to be faster than command-li= ne + transformation tools. +
+
+ + =20 + +
History
+
+
Apache Forrest was started in January 2002, with the major use-case bei= ng to + create a consistent and efficient=20 + xml.apache.org group of pro= ject + websites with a + uniform, lightweight, easy-to-navigate layout and structure. In + addition, Forrest was to be a Sourceforge-like project management + tool, complementing Apache Gum= p (hence + the name 'Forrest'). +
+
+ The focus shifted for Apache Forrest to primarily be a generic doc= umentation + tool capable of meeting many needs. Certain relevant project manag= ement + facilities are being added. +
+
+ + =20 + +
Project status and website status
+
+
Apache Forrest is currently progressing rapidly through a series of 0.x + releases. It is certainly usable now (despite not yet being versio= n 1.x). + See the growing list of=20 + example sites including + many Apache sites. +
+
+ In general, prior to 1.0, ensuring quality of design will be consi= dered + more important than retaining backwards-compatibility. Users + (particularly those with custom sitemaps and skins) should be awar= e that + this is evolving software, and read the release notes carefully be= fore + upgrading. That said, we appreciate the commitment in time that + adopters make, and will not make capricious or undocumented + backwards-incompatible changes. +
+
+ Documentation on the Apache Forrest website exists for=20 + various versions + including the latest release, the current development, and past re= leases. + All versions of Forrest include their own copy of the documentatio= n=2E + To view it, do 'forrest run' and go to + http://127.0.0.1:8888/ (for versions after 0.6, do 'cd docs-autho= r' first). + The Apache Forrest website<= /a> is updated + manually as needed, while we develop the=20 + forrestbot deployment= facility. +
+
+ =20 + +
News and events
+
+
+ =20 +
Apache Forrest 0.6 was released on 2004-10-15. Uses all resources + in-place so no more copying; workflow and productivity improvemen= ts; + project sitemaps get first chance processing then pass-through + to core sitemaps; new skins use CSS rather than tables and are + configurable; enhanced forrestbot. +
+ =20 +
The Forrest project has evolved to become a "top-level" Apache + project. +
+ =20 +
+
+ =20 + +
Help Wanted!
+
+
+ Apache Forrest is fairly new, and is in need of developers. + If you know (or want to learn) any of XML, Ant, HTML, XSLT, or CSS, + then you are qualified to help. +
+
+ As with all Apache projects, Forrest is a meritocracy; the more you + put in, the more you get to define the project's future. See the + "contributing" page for more + information. +
+
+ =20 +

+ +

+

+
+ +
+ +
+
+ Copyright © 2002-2005 The Apache Software Foundation.
+
+ +
+ +
+ + Propchange: forrest/site/0.7/index.html ---------------------------------------------------------------------------= --- svn:eol-style =3D native

Open issues for the upcoming release

[FOR-475] move some docs in forrest_06_branch = e=2Eg. faq.html changes.html into /docs/

[FOR-470] docs and fresh-site samples for "raw= content" need update

[FOR-468] refresh the listings of build output= messages

[FOR-465] Logging Error: Writing event to clos= ed stream.

[FOR-457] Carry over meta-data tags form DocV2= .0 sources

[FOR-454] add content about major changes for = this release

[FOR-433] OpenOffice.org plugin produces inval= id intermediate documents

[FOR-430] FO output ignores color settings def= ined by skinconf.xml

[FOR-429] Missing navigation links on Forrest = site

[FOR-416] input/output formats documented

[FOR-394] html2document.xsl misses content bef= ore first h1 element

[FOR-391] website docs/site split

[FOR-341] Plugin resources are not copied to s= ite

[FOR-335] Generate Plugins documentation

[FOR-262] openoffice2forrest: add support for = merged cells in tables

[FOR-259] openoffice files can skip sections + + +http://issues.coco= ondev.org//browse/FOR-259 + +Create an openoffice file with lines like this: + + + +Heading 2 + +Heading 3 + +Heading 4 + +Heading 9 + +Heading 2 + + + +The last two lines are not translated into sections. + + +

[FOR-241] forrest undoes entity resolution

[FOR-229] SVG not converted to PNG

[FOR-227] static html site: index.html missing= in links

[FOR-185] Can't get svg files served along wit= h the PNG

[FOR-145] Make Forrest able to be imported by = Ant

Apache Forrest project guidelines

The mission of Apache Forrest

The Apache Way

Roles and responsibilities

Project Management Committee (PMC)

Decision making

Voting

Types of approval

Vetoes

Actions

Voting timeframes

Voting procedure

Ultimatum and breakdown

Code management

Welcome to Apache Forrest

Introduction

User-friendly

Powerful

Static or Dynamic

History

Project status and website status

News and events

Help Wanted!

[FOR-259] openoffice files can skip sections +
+
+http://issues.coco= ondev.org//browse/FOR-259 +
+
Create an openoffice file with lines like this: +
+ +
+Heading 2 +
+Heading 3 +
+Heading 4 +
+Heading 9 +
+Heading 2 +
+ +
+The last two lines are not translated into sections.
+
+ +