click-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r735539 - in /incubator/click/trunk/tools/docbook: README.txt src/docbook/click/ClickManual.xml src/images/LICENSE.txt
Date Sun, 18 Jan 2009 20:51:32 GMT
Author: sabob
Date: Sun Jan 18 12:51:31 2009
New Revision: 735539

update docbook build process


Modified: incubator/click/trunk/tools/docbook/README.txt
--- incubator/click/trunk/tools/docbook/README.txt (original)
+++ incubator/click/trunk/tools/docbook/README.txt Sun Jan 18 12:51:31 2009
@@ -57,6 +57,28 @@
+Linking to resources
+The Click documentation output files (PDF and HTML), will be placed in the
+folder 'user-guide' of the Click distribution:
+  <click-distribution>/documentation/docs/user-guide/pdf
+  <click-distribution>/documentation/docs/user-guide/html
+  <click-distribution>/documentation/docs/user-guide/htmlsingle
+When linking to other Click documentation such as 'click-api' and other images,
+use the relative path and '../../'.
+For example:
+  <para>This framework uses a single servlet, called
+  <ulink url="../../click-api/org/apache/click/ClickServlet.html">ClickServlet</ulink>
+Notice we link to ClickServlet using the relative path '../../' since that is
+where the click-api will be located relative to the user-guide.
 Soft pagebreaks
@@ -81,11 +103,12 @@
 For example:
-  <?dbfo-need height="2in" ?>
   <section id="section-hello-world">
-  <para>Some content</para>
-This will ensure that the <section> will be forced to the next page if less
+  <?dbfo-need height="2in" ?>
+  <title>Hello World</title>
+This will ensure that the section <title> will be forced to the next page if less
 than 2 inches are available on the current page. This alleviates the problem where
 the section title is displayed at the bottom of the page but the actual content
 only starts on the next page, which looks awkward.
@@ -95,14 +118,16 @@
   <para>Some text</para>
   <!-- Below we would like to have the description and code listing on the same page,
-       so we add a soft page break (2 inches) as shown below -->
-  <?dbfo-need height="2in" ?>
+       so we add a soft page break of 0.8 inches as shown below -->
+  <?dbfo-need height="0.8in" ?>
   <para>For example:</para>
   <programlisting>public class MyPage extends Page {
 } </programlisting>
+Here there must be at least an 8th of an inch available at the bottom of the page,
+otherwise the paragraph and program listing will be forced to the next page.
 For more info see:

Modified: incubator/click/trunk/tools/docbook/src/docbook/click/ClickManual.xml
--- incubator/click/trunk/tools/docbook/src/docbook/click/ClickManual.xml (original)
+++ incubator/click/trunk/tools/docbook/src/docbook/click/ClickManual.xml Sun Jan 18 12:51:31
@@ -29,7 +29,7 @@
       <holder>The Apache Software Foundation</holder>
-    <releaseinfo>V 1.5</releaseinfo>
+    <releaseinfo>V 2.1.0</releaseinfo>
@@ -56,7 +56,7 @@
       Java developers.</para>
       <para>Click is an open source project, licensed under the <ulink
-      url="images/LICENSE.txt"><citetitle>Apache
+      url="../../LICENSE.txt"><citetitle>Apache
       <para>Click uses an event based programming model for processing Servlet
@@ -67,9 +67,9 @@
       <para>This framework uses a single servlet, called <ulink
-      url="click-api/net/sf/click/ClickServlet.html">ClickServlet</ulink>, to
+      url="../../click-api/org/apache/click/ClickServlet.html">ClickServlet</ulink>,
       act as a request dispatcher. When a request arrives ClickServlet creates
-      a <ulink url="../../click-api/net/sf/click/Page.html">Page</ulink>
+      a <ulink url="../../click-api/org/apache/click/Page.html">Page</ulink>
       object to process the request and then uses the page's Velocity template
       to render the results.</para>
@@ -107,7 +107,6 @@
-      <?dbfo-need height="2in" ?>
       <para>Next we would have a page template
@@ -118,7 +117,7 @@
     Hello world from Click at <varname>$time</varname>
-&lt;/html&gt;       </programlisting>
+&lt;/html&gt; </programlisting>
       <para>And finally we have a <filename>click.xml</filename> configuration
       file which tells our Click application to map
@@ -154,7 +153,7 @@
       <para>One of the commonly used controls is the <ulink
-      url="click-api/net/sf/click/control/ActionLink.html">ActionLink</ulink>,
+      url="../../click-api/org/apache/click/control/ActionLink.html">ActionLink</ulink>,
       which you can use to have a HTML link call a method on a Page object.
       For example:</para>
@@ -235,7 +234,7 @@
       <title>Simple Table Example</title>
       <para>One of the most useful Click controls is the <ulink
-      url="click-api/net/sf/click/control/Table.html">Table</ulink>
+      url="../../click-api/org/apache/click/control/Table.html">Table</ulink>
       <para>An example usage of the Table control in a customers Page is
@@ -269,7 +268,7 @@
       <para>In this Page code example a Table control is declared, we set the
       table's HTML class, and then define a number of table <ulink
-      url="click-api/net/sf/click/control/Column.html">Column</ulink> objects.
+      url="../../click-api/org/apache/click/control/Column.html">Column</ulink>
       In the column definitions we specify the name of the column in the
       constructor, which is used for the table column header and also to
       specify the row object property to render.</para>
@@ -398,9 +397,9 @@
       <para>In this Page code example a Table control is declared and a number
       of <ulink
-      url="click-api/net/sf/click/control/Column.html">Column</ulink> objects
+      url="../../click-api/org/apache/click/control/Column.html">Column</ulink>
       are added. A deleteLink <ulink
-      url="click-api/net/sf/click/control/ActionLink.html">ActionLink</ulink>
+      url="../../click-api/org/apache/click/control/ActionLink.html">ActionLink</ulink>
       control is used as a decorator for the "Action" column. This control
       will invoke the Page <methodname>onDeleteClick()</methodname> method
       when it is clicked. Finally we have the Page
@@ -436,12 +435,13 @@
       Page deleting the customer record.</para>
-    <section>
+    <section id="section-simple-form-example">
       <title>Simple Form Example</title>
       <para>The <ulink
-      url="click-api/net/sf/click/control/Form.html">Form</ulink> and <ulink
-      url="click-api/net/sf/click/control/Field.html">Field</ulink> controls
+      url="../../click-api/org/apache/click/control/Form.html">Form</ulink> and
+      url="../../click-api/org/apache/click/control/Field.html">Field</ulink> controls
       are also some of the most commonly used controls in the Click
@@ -449,9 +449,9 @@
       <para>In our example code we have the page's constructor adding a <ulink
-      url="click-api/net/sf/click/control/TextField.html">TextField</ulink>
+      url="../../click-api/org/apache/click/control/TextField.html">TextField</ulink>
       field and a <ulink
-      url="click-api/net/sf/click/control/Submit.html">Submit</ulink> button
+      url="../../click-api/org/apache/click/control/Submit.html">Submit</ulink>
       to the form. A page method is also set as a control listener on the
       form. Also note in this example the page's public
       <varname>form</varname> field is automatically added to its list of
@@ -546,7 +546,7 @@
-    <section>
+    <section id="section-advanced-form-example">
       <title>Advanced Form Example</title>
       <para>The <classname>AdvancedForm</classname> page below provides
a more
@@ -555,9 +555,9 @@
       <para>First we have an <classname>AdvancedForm</classname> class
       setups up a <ulink
-      url="click-api/net/sf/click/control/Form.html">Form</ulink> in its
+      url="../../click-api/org/apache/click/control/Form.html">Form</ulink> in its
       constructor. The form's investment <ulink
-      url="click-api/net/sf/click/control/Select.html">Select</ulink> list is
+      url="../../click-api/org/apache/click/control/Select.html">Select</ulink>
list is
       populated in the page's <methodname>onInit()</methodname> method. At
       this point any page dependencies such as the CustomerService should be
@@ -678,7 +678,7 @@
       <para>If the user clicks on the Cancel button the request is redirected
       to the applications HomePage.</para>
-      <section>
+      <section id="section-form-layout">
         <title>Form Layout</title>
         <para>In the example above the Form control automatically renders the
@@ -692,7 +692,7 @@
         and fields in your page template. See the <link
         linkend="section-template-layout">Template Layout</link> section and
-        url="click-api/net/sf/click/control/Form.html#form-layout">Form</ulink>
+        url="../../click-api/org/apache/click/control/Form.html#form-layout">Form</ulink>
         Javadoc for more details.</para>
         <para>An alternative approach to page template design is using a

View raw message