Author: crossley Date: Sat Apr 7 20:29:22 2007 New Revision: 526521 URL: http://svn.apache.org/viewvc?view=rev&rev=526521 Log: Automatic publish from forrestbot
Added: forrest/site/dtdx/document-v20.txt (with props) Modified: forrest/site/docs_0_80/upgrading_08.html forrest/site/docs_0_80/upgrading_08.pdf forrest/site/dtdx/document-v20.html forrest/site/dtdx/document-v20.pdf forrest/site/dtdx/document-v20.pod forrest/site/dtdx/document-v20.xml forrest/site/procedures/How_to_publish_docs.html forrest/site/procedures/How_to_publish_docs.pdf Modified: forrest/site/docs_0_80/upgrading_08.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/upgrading_08.html?view=diff&rev=526521&r1=526520&r2=526521 ============================================================================== --- forrest/site/docs_0_80/upgrading_08.html (original) +++ forrest/site/docs_0_80/upgrading_08.html Sat Apr 7 20:29:22 2007 @@ -344,6 +344,9 @@ <a href="#cocoon">Notes about Cocoon version</a> </li> <li> +<a href="#xmlformat">Whitespace and indenting of xml files with xmlformat</a> +</li> +<li> <a href="#tips">General upgrade tips</a> </li> <li> @@ -413,10 +416,19 @@ <span class="codefrag">PROJECT_HOME/src/documentation/content/locationmap.xml</span> </p> +<div class="warning"> +<div class="label">Warning</div> +<div class="content">If you do use locationmaps and an entry for a specific request is + missing Forrest generates a confusing error message. Please ask on our + mailing lists for help in debugging your problem (hint, turn on locationmap + debugging in [FORREST_HOME]/main/webapp/WEB-INF/logkit.xconf, restart Forrest, + request the broken pages and visit [SITE_HOM]/build/webapp/logs/locationmap.xml). + This issue will be fixed in the next version of Forrest.</div> +</div> </div> -<a name="N10062"></a><a name="modules"></a> +<a name="N10065"></a><a name="modules"></a> <h2 class="underlined_10">Forrest configuration simplification</h2> <div class="section"> <p> @@ -449,7 +461,7 @@ </div> -<a name="N1009A"></a><a name="clean"></a> +<a name="N1009D"></a><a name="clean"></a> <h2 class="underlined_10">Run a clean target after upgrade</h2> <div class="section"> <p> @@ -459,7 +471,7 @@ </div> -<a name="N100A4"></a><a name="to2to"></a> +<a name="N100A7"></a><a name="to2to"></a> <h2 class="underlined_10">New filename convention for stylesheets</h2> <div class="section"> <p> @@ -476,7 +488,7 @@ </div> -<a name="N100B8"></a><a name="docs"></a> +<a name="N100BB"></a><a name="docs"></a> <h2 class="underlined_10">Notes about documentation</h2> <div class="section"> <p>After each release, the "Versioned Docs" are copied to form the new "dev" set. @@ -492,7 +504,7 @@ </div> -<a name="N100CA"></a><a name="cocoon"></a> +<a name="N100CD"></a><a name="cocoon"></a> <h2 class="underlined_10">Notes about Cocoon version</h2> <div class="section"> <p> @@ -510,7 +522,19 @@ </div> -<a name="N100D7"></a><a name="tips"></a> +<a name="N100DA"></a><a name="xmlformat"></a> +<h2 class="underlined_10">Whitespace and indenting of xml files with xmlformat</h2> +<div class="section"> +<p> + All xml type files have been formatted using xmlformat. You can apply + this to your own work if necessary by using the same configuration + as the Forrest project. + See notes at <a href="http://issues.apache.org/jira/browse/FOR-644">FOR-644</a>. + </p> +</div> + + +<a name="N100E8"></a><a name="tips"></a> <h2 class="underlined_10">General upgrade tips</h2> <div class="section"> <p> @@ -529,7 +553,7 @@ </div> -<a name="N100E7"></a><a name="To+be+continued..."></a> +<a name="N100F8"></a><a name="To+be+continued..."></a> <h2 class="underlined_10">To be continued...</h2> <div class="section"> <p>...as more issues are discovered/remembered :) Please send feedback Modified: forrest/site/docs_0_80/upgrading_08.pdf URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/upgrading_08.pdf?view=diff&rev=526521&r1=526520&r2=526521 ============================================================================== Binary files - no diff available. Modified: forrest/site/dtdx/document-v20.html URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v20.html?view=diff&rev=526521&r1=526520&r2=526521 ============================================================================== --- forrest/site/dtdx/document-v20.html (original) +++ forrest/site/dtdx/document-v20.html Sat Apr 7 20:29:22 2007 @@ -604,7 +604,7 @@ <tr> -<td colspan="1" rowspan="1">Text</td> +<td colspan="1" rowspan="1"><a href="document-v20.txt">Text</a></td> <td colspan="1" rowspan="1"> <p>This document as straight text.</p> @@ -638,17 +638,17 @@ </tr> </table> -<a name="N101B3"></a><a name="section"></a> +<a name="N101B5"></a><a name="section"></a> <h3 class="underlined_5">Using sections</h3> <p>You can use sections to put some structure in your document. </p> -<a name="N101BD"></a><a name="sub-section"></a> +<a name="N101BF"></a><a name="sub-section"></a> <h3 class="underlined_5">Sections, the sequel</h3> <p>Just some second section.</p> -<a name="N101C6"></a><a name="sub-sub-section"></a> +<a name="N101C8"></a><a name="sub-sub-section"></a> <h4>Section 2.1</h4> <p>Which contains a subsection (2.1).</p> -<a name="N101D1"></a><a name="source"></a> +<a name="N101D3"></a><a name="source"></a> <h3 class="underlined_5">Showing preformatted source code</h3> <p>Enough about these sections. Let's have a look at more interesting elements, <span class="codefrag"><source></span> for instance:</p> @@ -680,7 +680,7 @@ </pre> <p>Please take care to still use a sensible line-length within your source elements.</p> -<a name="N101F2"></a><a name="table"></a> +<a name="N101F4"></a><a name="table"></a> <h3 class="underlined_5">Using tables</h3> <p>And now for a table:</p> <table class="ForrestTable" cellspacing="1" cellpadding="4"> @@ -740,7 +740,7 @@ </tr> </table> -<a name="second-figure-anchor" id="second-figure-anchor"></a><a name="N10259"></a><a name="figure"></a> +<a name="second-figure-anchor" id="second-figure-anchor"></a><a name="N1025B"></a><a name="figure"></a> <h3 class="underlined_5">Using figures</h3> <p>And a <span class="codefrag"><figure></span> to end all of this. Note that this can also be implemented with an @@ -748,7 +748,7 @@ </p> <div id="" style="text-align: center;"> <img id="" class="figure" alt="The fine Forrest logo" src="images/project-logo.png" height="65" width="220"></div> -<a name="N1026F"></a><a name="link-class"></a> +<a name="N10271"></a><a name="link-class"></a> <h3 class="underlined_5">Using class attribute on links</h3> <p>The document-v13 had elements <fork> and <jump>. In document-v20, those elements no longer exist but the functionality can @@ -801,13 +801,13 @@ </div> -<a name="N102AF"></a><a name="changes"></a> +<a name="N102B1"></a><a name="changes"></a> <h2 class="underlined_10">DTD changes</h2> <div class="section"> <p>See the generated <a href="../docs_0_80/../dtdx/dtd-docs.html">DTD reference documentation</a>. </p> -<a name="N102BC"></a><a name="changes-20"></a> +<a name="N102BE"></a><a name="changes-20"></a> <h3 class="underlined_5">Changes between document-v13 and document-v20</h3> <ul> @@ -823,14 +823,14 @@ </li> </ul> -<a name="N102DF"></a><a name="changes-13"></a> +<a name="N102E1"></a><a name="changes-13"></a> <h3 class="underlined_5">Changes between document-v12 and document-v13</h3> <p> All v1.2 docs will work fine as v1.3 DTD. The main change is the addition of a @class attribute to every element, which enables the "extra-css" section in the skinconf to be put to good use. </p> -<a name="N102E9"></a><a name="changes-12"></a> +<a name="N102EB"></a><a name="changes-12"></a> <h3 class="underlined_5">Changes between document-v11 and document-v12</h3> <p> doc-v12 enhances doc-v11 by relaxing various restrictions that were Modified: forrest/site/dtdx/document-v20.pdf URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v20.pdf?view=diff&rev=526521&r1=526520&r2=526521 ============================================================================== Binary files - no diff available. Modified: forrest/site/dtdx/document-v20.pod URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v20.pod?view=diff&rev=526521&r1=526520&r2=526521 ============================================================================== --- forrest/site/dtdx/document-v20.pod (original) +++ forrest/site/dtdx/document-v20.pod Sat Apr 7 20:29:22 2007 @@ -288,7 +288,7 @@ | | | t this link will be | | | | shown. | +---------------------+---------------------+---------------------+ - | Text | This document as st | <disable-txt-link>. | + | document-v20.txt | This document as st | <disable-txt-link>. | | | raight text. | By default, set to | | | | true, meaning that | | | For additional info | this link will not | Added: forrest/site/dtdx/document-v20.txt URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v20.txt?view=auto&rev=526521 ============================================================================== --- forrest/site/dtdx/document-v20.txt (added) +++ forrest/site/dtdx/document-v20.txt Sat Apr 7 20:29:22 2007 @@ -0,0 +1,342 @@ + The Apache Forrest xdocs document-v2.0 DTD + + NOTICE + The content of this document doesn't make any sense at all. + + ABSTRACT + This is a demonstration document using all possible elements in the + current Apache Forrest xdocs document-v20.dtd + +Table Of Contents +================= +Sample Content + Block and inline elements + Various presentation formats + Using sections + Sections, the sequel + Section 2.1 + Showing preformatted source code + Using tables + Using figures + Using class attribute on links +DTD changes + Changes between document-v13 and document-v20 + Changes between document-v12 and document-v13 + Changes between document-v11 and document-v12 + + ** Note ** +This is a demonstration document using all possible elements in the current +Apache Forrest xdocs document-v20.dtd (See the DTD changes [Link: #changes] +section at the bottom.) +---------------------------------------------------------------------------- + +Sample Content +============== + + Hint: See the xml source to see how the various elements are used and + see the DTD reference documentation [Link: + ../docs_0_80/../dtdx/dtd-docs.html]. + + Block and inline elements + ------------------------- + + This is a simple paragraph. Most documents contain a fair amount of + paragraphs. Paragraphs are called <p>. + +With the <p xml:space="preserve"> attribute, you can declare + that whitespace should be preserved, without implying it is in any other + way special. + + This next paragraph has a class attribute of 'quote'. CSS can be + used to present this <p class='quote'> in a different style than + the other paragraphs. The handling of this quoted paragraph is + defined in the <extra-css> element in the skinconf.xml. + + Anyway, like I was sayin', shrimp is the fruit of the sea. You can + barbecue it, boil it, broil it, bake it, sautee it. Dey's uh, + shrimp-kabobs, shrimp creole, shrimp gumbo. Pan fried, deep fried, + stir-fried. There's pineapple shrimp, lemon shrimp, coconut shrimp, + pepper shrimp, shrimp soup, shrimp stew, shrimp salad, shrimp and + potatoes, shrimp burger, shrimp sandwich. That- that's about it. + + A number of in-line elements are available in the DTD, we will show + them inside an unordered list (<ul>): + + * Here is a simple list item (<li>). + * Have you seen the use of the <code> element in the previous item? + * Also, we have <sub> and <sup> elements to show content aboveor belowthe + text baseline. + * There is a facility to emphasize certain words using the <em> <strong> + elements. + * We can use [Icon: feather] <icon>s too. + * Another possibility is the <img> element: [Image: another feather], + which offers the ability to refer to an image map. + * We have elements for hyperlinking: + :: <a href="../index.html"> + Use this to link [Link: ../index.html] to another document. As per + normal, this will open the new document in the same browser window. + + :: <a href="#section"> + Use this to link [Link: #section] to the named anchor in the current + document. + + :: <a href="../index.html#status"> + Use this to link [Link: ../index.html#status] to another document and + go to the named anchor. This will open the new document in the same + browser window. + + :: Targetted window control with jump and fork. + See demonstration using class attribute on links [Link: #link-class]. + + * Oh, by the way, a definition list <dl> was used inside the previous list item. We could put another + * unordered list + * inside the list item + A sample nested table + +---------------------------------+---------------------------------+ + | Or even tables.. | +-----------------------------+ | + | | | inside tables.. | | + | | +-----------------------------+ | + +---------------------------------+---------------------------------+ + | or inside lists, but I believe | | + | this liberty gets quickly | | + | quite hairy as you see. | | + +---------------------------------+---------------------------------+ + + + + + + So far for the in-line elements, let's look at some paragraph-level + elements. + + ** Fixme (SN) ** + The <fixme> element is used for stuff which still needs work. Mind + the author attribute! + ------------------------------------------------------------------------ + + ** Note ** + Use the <note> element to draw attention to something, e.g. ...The + <code> element is used when the author can't express himself + clearly using normal sentences ;-) + ------------------------------------------------------------------------ + + ** Warning ** + Sleep deprivation can be the result of being involved in an open + source project. (a.k.a. the <warning> element). + ------------------------------------------------------------------------ + + ** Important ** + If you want your own labels for notes and warnings, specify them + using the label attribute. + ------------------------------------------------------------------------ + + Apart from unordered lists, we have ordered lists too, of course. + + 1. Item 1 + 2. Item 2 + 3. This should be 3 if my math is still OK. + + Various presentation formats + ---------------------------- + + This sample document, written in document-v20 XML can be presented + via Forrest in a number of different formats. The links in the + following list show this document in each of the currently + available formats. + + Each of the formats can be made available as a link near the top of + the page. Actual placement of those links depends on the skin + currently in use. Those links are enabled in the skinconf.xml via + the <disable-XXX-link> elements in the skinconf.xml + + +--------------------+--------------------+--------------------+ + | Presentation | Description | skinconf.xml | + | Format | | Element | + +--------------------+--------------------+--------------------+ + | HTML [Link: docume | This document in | Always generated | + | nt-v20.html] | HTML format. | by default. | + | | | Cannot be turned | + | | | off. | + +--------------------+--------------------+--------------------+ + | XML [Link: documen | This document in | <disable-xml-link> | + | t-v20.xml] | its raw XML | . By default, set | + | | format. | to true, meaning | + | | | that this link | + | | | will not be shown. | + +--------------------+--------------------+--------------------+ + | PDF [Link: documen | This document as | <disable-pdf-link> | + | t-v20.pdf] | Adobe PDF | . By default, set | + | | | to false, meaning | + | | | that this link | + | | | will be shown. | + +--------------------+--------------------+--------------------+ + | Text [Link: docume | This document as | <disable-txt-link> | + | nt-v20.txt] | straight text. | . By default, set | + | | For additional | to true, meaning | + | | information see | that this link | + | | the Forrest | will not be shown. | + | | text-output | | + | | plugin. | | + +--------------------+--------------------+--------------------+ + | POD [Link: documen | This document as | <disable-pod-link> | + | t-v20.pod] | Perl POD (Plain | . By default, set | + | | Old | to true, meaning | + | | Documentation). | that this link | + | | Text with minimal | will not be shown. | + | | formatting | | + | | directives. If on | | + | | a *nix system | | + | | with perl | | + | | installed, see | | + | | "man perlpod". | | + | | For additional | | + | | information see | | + | | the Forrest | | + | | pod-output plugin. | | + +--------------------+--------------------+--------------------+ + + + + + Using sections + -------------- + + You can use sections to put some structure in your document. + + Sections, the sequel + -------------------- + + Just some second section. + + Section 2.1 + .-.-.-.-.-. + + Which contains a subsection (2.1). + + Showing preformatted source code + -------------------------------- + + Enough about these sections. Let's have a look at more interesting + elements, <source> for instance: + + // This example is from the book _Java in a Nutshell_ by David Flanagan. + // Written by David Flanagan. Copyright (c) 1996 O'Reilly & Associates. + // You may study, use, modify, and distribute this example for any purpose. + // This example is provided WITHOUT WARRANTY either expressed or implied. + + import java.applet.*; // Don't forget these import statements! + import java.awt.*; + + public class FirstApplet extends Applet { + // This method displays the applet. + // The Graphics class is how you do all drawing in Java. + public void paint(Graphics g) { + g.drawString("Hello World", 25, 50); + } + } + + + CDATA sections are used within <source> elements so that you can + write pointy brackets without needing to escape them with messy + < entities ... + + <pointy> + easy + </pointy> + + + + Please take care to still use a sensible line-length within your + source elements. + + Using tables + ------------ + + And now for a table: + Table caption + +--------------------+--------------------+--------------------+ + | heading cell 1 | heading cell 2 | heading cell 3 | + +--------------------+--------------------+--------------------+ + | data cell | this data cell | | + | | spans two columns | | + +--------------------+--------------------+--------------------+ + | Tables can be | +----------+------ | * and can include | + | nested: | ----+ | most other | + | | | column 1 | colum | elements | + | | n 2 | | * such as lists | + | | +----------+------ | | + | | ----+ | | + | | | cell A | cell | | + | | B | | | + | | +----------+------ | | + | | ----+ | | + +--------------------+--------------------+--------------------+ + + + + + Using figures + ------------- + + And a <figure> to end all of this. Note that this can also be + implemented with an <img> element. + [Figure: The fine Forrest logo] + Using class attribute on links + ------------------------------ + + The document-v13 had elements <fork> and <jump>. In document-v20, + those elements no longer exist but the functionality can be + duplicated by using the @class attribute. Even though the opening + of separate windows should be under the control of the user, these + techniques can still be employed. + + +--------------------------------+--------------------------------+ + | Document V1.3 | Document V2.0 | + +--------------------------------+--------------------------------+ + | <fork href="../index.html"> | <a class="fork" href="../index | + | | .html"> [Link: ../index.html] | + +--------------------------------+--------------------------------+ + | <jump href="../index.html"> | <a class="jump" | + | | href="../index.html"> [Link: | + | | ../index.html] | + +--------------------------------+--------------------------------+ + + + + +DTD changes +=========== + + See the generated DTD reference documentation [Link: + ../docs_0_80/../dtdx/dtd-docs.html]. + + Changes between document-v13 and document-v20 + --------------------------------------------- + + * Renamed <link> to <a> + * Removed <fork> and <jump> in favour of the <a> element. See + demonstration using class attribute on links [Link: #link-class]. + + Changes between document-v12 and document-v13 + --------------------------------------------- + + All v1.2 docs will work fine as v1.3 DTD. The main change is the + addition of a @class attribute to every element, which enables the + "extra-css" section in the skinconf to be put to good use. + + Changes between document-v11 and document-v12 + --------------------------------------------- + + doc-v12 enhances doc-v11 by relaxing various restrictions that were + found to be unnecessary. + + * Links ((link|jump|fork) and inline elements (br|img|icon|acronym) are + allowed inside title. + * Paragraphs (p|source|note|warning|fixme), table and figure|anchor are + allowed inside li. + * Paragraphs (p|source|note|warning|fixme), lists (ol|ul|dl), table, + figure|anchor are allowed inside definition lists (dd) and tables (td + and dh). + * Inline content + (strong|em|code|sub|sup|br|img|icon|acronym|link|jump|fork) is allowed + in strong and em. Propchange: forrest/site/dtdx/document-v20.txt ------------------------------------------------------------------------------ svn:eol-style = native Modified: forrest/site/dtdx/document-v20.xml URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v20.xml?view=diff&rev=526521&r1=526520&r2=526521 ============================================================================== --- forrest/site/dtdx/document-v20.xml (original) +++ forrest/site/dtdx/document-v20.xml Sat Apr 7 20:29:22 2007 @@ -185,7 +185,7 @@ </tr> <tr> - <td colspan="1" rowspan="1">Text</td> + <td colspan="1" rowspan="1"><link href="document-v20.txt">Text</link></td> <td colspan="1" rowspan="1"><p>This document as straight text.</p> <p>For additional information see the Forrest text-output Modified: forrest/site/procedures/How_to_publish_docs.html URL: http://svn.apache.org/viewvc/forrest/site/procedures/How_to_publish_docs.html?view=diff&rev=526521&r1=526520&r2=526521 ============================================================================== --- forrest/site/procedures/How_to_publish_docs.html (original) +++ forrest/site/procedures/How_to_publish_docs.html Sat Apr 7 20:29:22 2007 @@ -365,7 +365,7 @@ <p>Note that forrestbot does not remove docs from the forrest/site SVN (FOR-392). So need to manually delete: 'cd /svn/forrest/site; svn delete oldDoc'. Then remove it from the forrestbot work directories: - 'cd $FORREST_HOME; rm build/forrest-docs/oldDoc; rm work/svn-deploy/forrest-docs/oldDoc'. + 'cd $FORREST_HOME/site-author; rm build/forrest-docs/oldDoc; rm work/svn-deploy/forrest-docs/oldDoc'. </p> <p> The generated docs are in build/forrest-docs @@ -375,7 +375,7 @@ <pre class="code"> forrest -f publish.xml build svn update work/svn-deploy/forrest-docs -diff -rq build/forrest-docs work/svn-deploy/forrest-docs | grep -v "\.svn"</pre> +diff -rq build/forrest-docs work/svn-deploy/forrest-docs | grep -v "\.svn" | grep differ</pre> </div> Modified: forrest/site/procedures/How_to_publish_docs.pdf URL: http://svn.apache.org/viewvc/forrest/site/procedures/How_to_publish_docs.pdf?view=diff&rev=526521&r1=526520&r2=526521 ============================================================================== Binary files - no diff available.