forrest-site-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r527020 [6/20] - in /forrest/site: ./ docs_0_80/ docs_0_80/howto/ docs_0_80/howto/cvs-ssh/ docs_0_80/howto/multi/ dtdx/ plan/ pluginDocs/plugins_0_70/ pluginDocs/plugins_0_80/ procedures/ procedures/release/ skins/ tools/
Date Tue, 10 Apr 2007 04:44:05 GMT
Modified: forrest/site/docs_0_80/glossary.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/glossary.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/docs_0_80/glossary.html (original)
+++ forrest/site/docs_0_80/glossary.html Mon Apr  9 21:44:00 2007
@@ -347,9 +347,10 @@
 <div class="section">
 <introduction>
     
-<p>This is a glossary of terms and their definitions for the 
-    Apache Forrest project. Some plugins also have a glossary, for example
-    <a href="http://forrest.apache.org/pluginDocs/dev/org.apache.forrest.plugin.internal.dispatcher/">Dispatcher</a>.
+<p>
+      This is a glossary of terms and their definitions for the Apache Forrest
+      project. Some plugins also have a glossary, for example
+      <a href="http://forrest.apache.org/pluginDocs/dev/org.apache.forrest.plugin.internal.dispatcher/">Dispatcher</a>.
     </p>
   
 </introduction>
@@ -383,6 +384,7 @@
         
 <li>See Apache Cocoon
         <a href="http://wiki.apache.org/cocoon/AbbreviationsInMails">Abbreviations In Mails</a>
+        
 </li>
       
 </ul>
@@ -391,8 +393,7 @@
 <tr>
 <a name="ASF"></a><td class="term" id="ASF">The Apache Software Foundation (ASF)</td><td class="definitions">
 <p>
-        1. 
-        <a href="http://apache.org/">The Apache Software Foundation</a> is the home of Apache
+        1. <a href="http://apache.org/">The Apache Software Foundation</a> is the home of Apache
         Forrest.<br>
       
 </p>
@@ -400,7 +401,7 @@
 </tr>
 </table>
 </div>
-<a name="N10054"></a><a name="c"></a>
+<a name="N10055"></a><a name="c"></a>
 <h2 class="underlined_10">C</h2>
 <div class="section">
 <table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -420,10 +421,12 @@
         
 <li>See 
         <a href="http://www.w3.org/Style/CSS/">W3C</a>
+        
 </li>
         
 <li>See 
         <a href="http://www.csszengarden.com/">css Zen Garden</a>
+        
 </li>
       
 </ul>
@@ -431,7 +434,7 @@
 </tr>
 </table>
 </div>
-<a name="N1007F"></a><a name="r"></a>
+<a name="N10082"></a><a name="r"></a>
 <h2 class="underlined_10">R</h2>
 <div class="section">
 <table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -441,15 +444,14 @@
 <tr>
 <a name="ReleaseCandidate"></a><td class="term" id="ReleaseCandidate">Release Candidate</td><td class="definitions">
 <p>
-                1. A temporary Forrest package build from trunk during the <a href="../procedures/release/How_to_release.html">release process</a> to be tested and evaluated.<br>
-                
-            
+        1. A temporary Forrest package build from trunk during the <a href="../procedures/release/How_to_release.html">release process</a> to be tested and evaluated.<br>
+      
 </p>
 </td><td class="notes"></td>
 </tr>
 </table>
 </div>
-<a name="N1009C"></a><a name="s"></a>
+<a name="N1009F"></a><a name="s"></a>
 <h2 class="underlined_10">S</h2>
 <div class="section">
 <table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -467,14 +469,12 @@
 <ul>
         
 <li>
-          
 <a href="http://cocoon.apache.org/2.1/introduction.html#Separation+of+Concerns+(SoC)">
           Introducing Apache Cocoon</a>
         
 </li>
         
 <li>
-          
 <a href="http://excalibur.apache.org/developing/introduction.html#Separation_of_Concerns">
           Apache Excalibur Introduction and Overview</a>
         
@@ -494,17 +494,17 @@
 <tr>
 <a name="StandardDocumentFormat"></a><td class="term" id="StandardDocumentFormat">Standard Document Format</td><td class="definitions">
 <p>
-            1. Forrests <em>internal</em> document format (defined by an XML-grammar). This format ist the common denominator 
+        1. Forrests <em>internal</em> document format (defined by an XML-grammar). This format ist the common denominator 
                 for all things going into or coming out of Forrest's core processing. All input-plugins will translate their supported documents into this
                 format, all output-plugins will create the output by transforming this format into something else. Currently Forrest uses <a href="../docs_0_80/../dtdx/document-v13.dtdx.html">document-v13-dtd</a> as its internal format.
             <br>
-        
+      
 </p>
 </td><td class="notes"></td>
 </tr>
 </table>
 </div>
-<a name="N100E6"></a><a name="x"></a>
+<a name="N100E7"></a><a name="x"></a>
 <h2 class="underlined_10">X</h2>
 <div class="section">
 <table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -524,13 +524,11 @@
 <ul>
         
 <li>
-          
 <a href="../docs_0_80/../dtdx/dtd-docs.html">Reference docs</a>
         
 </li>
         
 <li>
-          
 <a href="../docs_0_80/../dtdx/document-v20.html">Sample xdoc</a>
         
 </li>

Modified: forrest/site/docs_0_80/howto/cvs-ssh/howto-cvs-ssh.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/howto/cvs-ssh/howto-cvs-ssh.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/docs_0_80/howto/cvs-ssh/howto-cvs-ssh.html (original)
+++ forrest/site/docs_0_80/howto/cvs-ssh/howto-cvs-ssh.html Mon Apr  9 21:44:00 2007
@@ -152,7 +152,11 @@
 	          &nbsp;<input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
 </div>
 <h1>CVS through SSH</h1>
-<div class="abstract">This How-To describes the steps necessary to configure an SSH enabled CVS connection. It is recommended to configure an SSH enabled CVS connection to work with Apache code repositories.</div>
+<div class="abstract">
+      This How-To describes the steps necessary to configure an SSH enabled CVS
+      connection. It is recommended to configure an SSH enabled CVS connection
+      to work with Apache code repositories.
+    </div>
 <div id="motd-area">
         This is documentation for development version v0.8
        (<a href="http://forrest.apache.org/versions/">More</a>)</div>
@@ -198,41 +202,52 @@
 <a name="N10013"></a><a name="Intended audience"></a>
 <h2 class="underlined_10">Intended audience</h2>
 <div class="section">
-<p>This How-to is aimed at developers who have been granted committer access to CVS repositories for particular projects.</p>
+<p>
+      This How-to is aimed at developers who have been granted committer access
+      to CVS repositories for particular projects.
+    </p>
 </div>
 <a name="N1001B"></a><a name="Purpose"></a>
 <h2 class="underlined_10">Purpose</h2>
 <div class="section">
-<p> 
-              Using SSH to access CVS repositories is recommended for security reasons. By configuring CVS to work with remote repository using private/public SSH keys you'll be able to run CVS commands without a need to enter your password every time you need access to CVS through SSH.
-        </p>
+<p>
+      Using SSH to access CVS repositories is recommended for security reasons.
+      By configuring CVS to work with remote repository using private/public SSH
+      keys you'll be able to run CVS commands without a need to enter your
+      password every time you need access to CVS through SSH.
+    </p>
 </div>
 <a name="N10023"></a><a name="Prerequisites"></a>
 <h2 class="underlined_10">Prerequisites</h2>
 <div class="section">
 <ul>
-            
+      
 <li>Account on the local machine.</li>
-            
+      
 <li>Commiter access to the project(s). <em>This also imply having account on the CVS host machine.</em>
-</li>        
-            
+</li>
+      
 <li>Cygwin - a Unix environment for Windows systems. You can get it <a href="http://www.redhat.com/software/tools/cygwin/">here</a>. <em>Not required for Linux/*nix users.</em>
 </li>
-            
+      
 <li>A CVS GUI application (for Windows users only), e.g. WinCVS. <em>It is not required, but can be very useful.</em>
 </li>
-        
+    
 </ul>
 <div class="note">
 <div class="label">Note</div>
-<div class="content">If you are behind a firewall check that you can communicate through the 22 port. For anonymous access you will need 2401 one.</div>
+<div class="content">
+      If you are behind a firewall check that you can communicate through the 22
+      port. For anonymous access you will need 2401 one.
+    </div>
 </div>
 </div>
 <a name="N10044"></a><a name="Steps"></a>
 <h2 class="underlined_10">Steps</h2>
 <div class="section">
-<p>How to proceed.</p>
+<p>
+      How to proceed.
+    </p>
 <a name="N1004C"></a><a name="Terms"></a>
 <h3 class="underlined_5">Terms</h3>
 <dl>
@@ -246,25 +261,33 @@
         
 <dd>Concurrent Version System See <a href="http://www.cvshome.org">CVS Home Page</a>
 </dd>
-         
+      
 </dl>
 <div class="note">
 <div class="label">Note</div>
 <div class="content">
-<strong>$</strong> represents local, <strong>%</strong> remote machine.</div>
+      
+<strong>$</strong> represents local, <strong>%</strong> remote machine.
+    </div>
 </div>
-<a name="N10070"></a><a name="Setting+up+domain+users"></a>
+<a name="N10071"></a><a name="Setting+up+domain+users"></a>
 <h3 class="underlined_5">Setting up domain users</h3>
 <div class="note">
 <div class="label">Note</div>
-<div class="content">This step is necessary only for Windows users. Linux users can happily skip this section and pass to <a href="#ssh_access">Setting up SSH access</a> section</div>
+<div class="content">
+        This step is necessary only for Windows users. Linux users can happily
+        skip this section and pass to <a href="#ssh_access">Setting up SSH
+        access</a> section
+      </div>
 </div>
-<p>If you are a domain user then you should be added to Cygwin users list (See <span class="codefrag">[cygwin-dir]/etc/passwd</span>). 
-            </p>
+<p>
+        If you are a domain user then you should be added to Cygwin users list
+        (See <span class="codefrag">[cygwin-dir]/etc/passwd</span>).
+      </p>
 <ul>
-              
+        
 <li>Start Cygwin, then enter following commands:</li>
-            
+      
 </ul>
 <pre class="code">
 $ whoami
@@ -275,20 +298,24 @@
     </pre>
 <div class="note">
 <div class="label">Note</div>
-<div class="content">Replace 'userxxx' by your account name</div>
+<div class="content">
+        Replace 'userxxx' by your account name
+      </div>
 </div>
 <ul>
-      
+        
 <li>Start Cygwin/shell again and check that everything's Ok:</li>
-    
+      
 </ul>
 <pre class="code">
 $ whoami
 userxxx
             </pre>
-<a name="N1009B"></a><a name="ssh_access"></a>
+<a name="N1009C"></a><a name="ssh_access"></a>
 <h3 class="underlined_5">Setting up SSH access</h3>
-<p>Start Cygwin/shell, then enter:</p>
+<p>
+        Start Cygwin/shell, then enter:
+      </p>
 <pre class="code">
 $ ssh-user-config
   Shall I create an SSH1 RSA identity file for you? (yes/no) no
@@ -303,15 +330,22 @@
   Configuration finished. Have fun!
     </pre>
 <p>
-      Now you have configured SSH on your machine. Next you have to setup access to the CVS machine.
-    </p>
+        Now you have configured SSH on your machine. Next you have to setup
+        access to the CVS machine.
+      </p>
 <div class="warning">
 <div class="label">Warning</div>
-<div class="content">Having an empty passphrase isn't recommended for security reasons. See <span class="codefrag">ssh-agent</span> documentation on how to configure automatic passphrase retaining.</div>
+<div class="content">
+        Having an empty passphrase isn't recommended for security reasons. See
+        <span class="codefrag">ssh-agent</span> documentation on how to configure automatic
+        passphrase retaining.
+      </div>
 </div>
-<a name="N100B2"></a><a name="Setting+up+passphrase+access"></a>
+<a name="N100B3"></a><a name="Setting+up+passphrase+access"></a>
 <h3 class="underlined_5">Setting up passphrase access</h3>
-<p>Perform the following:</p>
+<p>
+        Perform the following:
+      </p>
 <pre class="code">
 $ scp ~/.ssh/id_dsa.pub userxxx@cvs.apache.org:.
 $ ssh -l userxxx -L 2401:localhost:2401 cvs.apache.org
@@ -324,84 +358,96 @@
             </pre>
 <div class="note">
 <div class="label">Note</div>
-<div class="content">Note, that the account name on CVS machine can differ from your local account name.</div>
+<div class="content">
+        Note, that the account name on CVS machine can differ from your local
+        account name.
+      </div>
 </div>
 <p>
-            Check that your configuration is correct:
-            </p>
+        Check that your configuration is correct:
+      </p>
 <pre class="code">
 $ ssh userxxx@cvs.apache.org
             </pre>
 <div class="note">
 <div class="label">Note</div>
-<div class="content">If this command doesn't work then it can mean that you have an old version of SSH. In this case try <span class="codefrag">ssh -l userxxx cvs.apache.org</span>. Run <span class="codefrag">ssh --help</span> to get all available options.</div>
+<div class="content">
+        If this command doesn't work then it can mean that you have an old
+        version of SSH. In this case try <span class="codefrag">ssh -l userxxx
+        cvs.apache.org</span>. Run <span class="codefrag">ssh --help</span> to get all available
+        options.
+      </div>
 </div>
 <p>
-            If now you are logged in to the to the CVS machine without entering the password then everything's Ok.
-            </p>
-<a name="N100D6"></a><a name="Getting+the+project+from+CVS"></a>
+        If now you are logged in to the to the CVS machine without entering the
+        password then everything's Ok.
+      </p>
+<a name="N100D7"></a><a name="Getting+the+project+from+CVS"></a>
 <h3 class="underlined_5">Getting the project from CVS</h3>
-<p>Now you are ready to get a project from CVS using SSH connection.</p>
-<p>E.g. how it is done using Cygwin/shell</p>
+<p>
+        Now you are ready to get a project from CVS using SSH connection.
+      </p>
+<p>
+        E.g. how it is done using Cygwin/shell
+      </p>
 <pre class="code">
 $ export CVS_RSH=/bin/ssh
 $ cvs -d :ext:userxxx@cvs.apache.org:/home/cvs co xml-cocoon2            
             </pre>
-<a name="N100E7"></a><a name="How+to+setup+WinCVS"></a>
+<a name="N100E8"></a><a name="How+to+setup+WinCVS"></a>
 <h3 class="underlined_5">How to setup WinCVS</h3>
 <ul>
-                
+        
 <li>Add ssh.exe directory to your system PATH environment variable. Say: <br>
-                
 <span class="codefrag">C:\&gt;set PATH=%PATH%;C:\cygwin\bin</span>
 </li>
-                
+        
 <li>Add <span class="codefrag">CVS_RSH=ssh</span> environment variable</li>
-            
+      
 </ul>
 <p>
-            Start WinCVS, then:
-            </p>
+        Start WinCVS, then:
+      </p>
 <ul>
-                
+        
 <li>From the main menu select <strong>Admin</strong>
 </li>
-                
+        
 <li>Then select <strong>Preferences</strong>
 </li>
-                
+        
 <li>In the dialog that comes up: <br>
                 Set the CVSROOT to <span class="codefrag">userxxx@cvs.apache.org:/home/cvs</span>
 </li>
-                
-<li>Set the Authentication to SSH Server</li>                
-                
+        
+<li>Set the Authentication to SSH Server</li>
+        
 <li>Click Ok</li>
-            
+      
 </ul>
 <a name="N1011B"></a><a name="References"></a>
 <h3 class="underlined_5">References</h3>
 <p>
-                You can find more on CVS, SSH and WinCVS here:
-            </p>
+        You can find more on CVS, SSH and WinCVS here:
+      </p>
 <ul>
-                
+        
 <li>
 <a href="http://www.cvshome.org">CVS Home Page</a>
-</li>            
-                
+</li>
+        
 <li>
 <a href="http://www.openssh.org">OpenSSH</a>
-</li>            
-                
+</li>
+        
 <li>
 <a href="http://www.redhat.com/software/tools/cygwin/">Cygwin Home Page</a>
-</li>            
-                
+</li>
+        
 <li>
 <a href="http://odin.himinbi.org/wincvs-over-ssh/">WinCVS over SSH</a>
 </li>
-            
+      
 </ul>
 </div>
 <span class="version">1.0</span>

Modified: forrest/site/docs_0_80/howto/cvs-ssh/howto-cvs-ssh.pdf
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/howto/cvs-ssh/howto-cvs-ssh.pdf?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
Binary files - no diff available.

Modified: forrest/site/docs_0_80/howto/howto-asf-mirror.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/howto/howto-asf-mirror.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/docs_0_80/howto/howto-asf-mirror.html (original)
+++ forrest/site/docs_0_80/howto/howto-asf-mirror.html Mon Apr  9 21:44:00 2007
@@ -317,9 +317,10 @@
 	          &nbsp;<input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
 </div>
 <h1>Generate an ASF mirrors page using interactive web form</h1>
-<div class="abstract">Include html form elements
-    into a forrest-generated html page. For example, this enables building
-    automated download mirror pages for ASF project websites.
+<div class="abstract">
+      Include html form elements into a forrest-generated html page. For
+      example, this enables building automated download mirror pages for ASF
+      project websites.
     </div>
 <div id="motd-area">
         This is documentation for development version v0.8
@@ -373,15 +374,15 @@
 <a name="N1001E"></a><a name="Purpose"></a>
 <h2 class="underlined_10">Purpose</h2>
 <div class="section">
-<p>All Apache projects use dynamically generated download pages
-    which determine the closest mirror and provide an interactive list of
-    the current alternative mirrors.
-    This HowTo describes the procedure to generate the template page
-    that is utilised by the mirrors.cgi script.
+<p>
+      All Apache projects use dynamically generated download pages which
+      determine the closest mirror and provide an interactive list of the
+      current alternative mirrors. This HowTo describes the procedure to
+      generate the template page that is utilised by the mirrors.cgi script.
     </p>
-<p>The mirrors.cgi and mirrors.html are "extra" documents,
-    i.e. have no links from anywhere in the site. So we explain
-    how to process additional files.
+<p>
+      The mirrors.cgi and mirrors.html are "extra" documents, i.e. have no links
+      from anywhere in the site. So we explain how to process additional files.
     </p>
 </div>
 <a name="N10029"></a><a name="Prerequisites"></a>
@@ -407,51 +408,60 @@
 <div class="section">
 <a name="N10047"></a><a name="cgi"></a>
 <h3 class="underlined_5">Add the mirrors.cgi as a raw file</h3>
-<p>As explained in the mirrors document, there will be a two-line CGI
-      wrapper script at the top-level of your website called
-      <span class="codefrag">mirrors.cgi</span>
+<p>
+        As explained in the mirrors document, there will be a two-line CGI
+        wrapper script at the top-level of your website called
+        <span class="codefrag">mirrors.cgi</span>
+      
 </p>
-<p>Utilising the Forrest concept of raw un-processed content,
-       add the file as <span class="codefrag">src/documentation/mirrors.cgi</span>
-       (copy the Forrest project's
+<p>
+        Utilising the Forrest concept of raw un-processed content, add the file
+        as <span class="codefrag">src/documentation/mirrors.cgi</span> (copy the Forrest
+        project's
         <a href="http://svn.apache.org/repos/asf/forrest/trunk/site-author/content/mirrors.cgi">mirrors.cgi</a>)
       </p>
-<a name="N1005D"></a><a name="html"></a>
+<a name="N1005E"></a><a name="html"></a>
 <h3 class="underlined_5">Add the mirrors.html to xdocs directory</h3>
-<p>This file contains the html content of your mirror page, including
-        the html form elements which drive the mirror selection. It also
-        contains the specific tokens that are interpreted by the mirrors.cgi
-        script to add the list of mirrors and select the closest.
+<p>
+        This file contains the html content of your mirror page, including the
+        html form elements which drive the mirror selection. It also contains
+        the specific tokens that are interpreted by the mirrors.cgi script to
+        add the list of mirrors and select the closest.
       </p>
 <p>
-        Add the file as <span class="codefrag">src/documentation/xdocs/mirrors.html</span>
-        (Use the Forrest project's
+        Add the file as <span class="codefrag">src/documentation/xdocs/mirrors.html</span> (Use
+        the Forrest project's
         <a href="http://svn.apache.org/repos/asf/forrest/trunk/site-author/content/xdocs/mirrors.html">mirrors.html</a>
         as a template and edit it to suit.)
       </p>
 <p>
-        Note that the special tokens (e.g. [if-any http] [for http]) need to
-        be encompassed by xml comments.
+        Note that the special tokens (e.g. [if-any http] [for http]) need to be
+        encompassed by xml comments.
       </p>
-<a name="N10074"></a><a name="menu"></a>
+<a name="N10075"></a><a name="menu"></a>
 <h3 class="underlined_5">Add a menu entry for Download</h3>
-<p>Add an entry to your site.xml navigation. For example ...
+<p>
+        Add an entry to your site.xml navigation. For example ...
       </p>
 <pre class="code">
+
  &lt;about label="About"&gt;
   &lt;index label="Index" href="index.html"/&gt;
   &lt;license label="License" href="license.html"/&gt;
   &lt;download label="Download" href="http://forrest.apache.org/mirrors.cgi"/&gt;
   &lt;download_html href="mirrors.html"/&gt;&lt;!-- so the page is part of a tab --&gt;
-  ...</pre>
-<a name="N10082"></a><a name="link"></a>
+  ...
+      </pre>
+<a name="N10083"></a><a name="link"></a>
 <h3 class="underlined_5">Cause the mirrors.html to be processed as an extra file</h3>
-<p>Forrest gathers the links that are to be crawled, by reading site.xml
-        and by finding any other internal links in the actual documents.
-        There is no link to mirrors.html because it is an extra file that needs
-        to be generated and skinned, but not linked in any way.
+<p>
+        Forrest gathers the links that are to be crawled, by reading site.xml
+        and by finding any other internal links in the actual documents. There
+        is no link to mirrors.html because it is an extra file that needs to be
+        generated and skinned, but not linked in any way.
       </p>
-<p>The Cocoon command-line interface
+<p>
+        The Cocoon command-line interface
         (<a href="http://cocoon.apache.org/2.1/userdocs/offline/">CLI</a>)
         to the rescue. Add an entry to your project's cli.xconf by copying the
         default one from
@@ -460,10 +470,12 @@
         ${forrest.conf-dir} points). Add the following entry ...
       </p>
 <pre class="code">
+
 &lt;uris name="mirrors" follow-links="false"&gt;
   &lt;uri type="append" src="mirrors.html"/&gt;
-&lt;/uris&gt;</pre>
-<a name="N1009D"></a><a name="forrest"></a>
+&lt;/uris&gt;
+      </pre>
+<a name="N1009E"></a><a name="forrest"></a>
 <h3 class="underlined_5">Run 'forrest' to build your site</h3>
 <p>
         That is all that you need to do, Forrest will take care of it from
@@ -473,11 +485,11 @@
 <div class="note">
 <div class="label">Note</div>
 <div class="content">
-Due to Issue
-<a href="http://issues.apache.org/jira/browse/FOR-480">FOR-480</a>,
-the generated mirror.html will end up in forrest/main/site/mirrors.html
-rather than in the project's build directory.
-</div>
+        Due to Issue
+        <a href="http://issues.apache.org/jira/browse/FOR-480">FOR-480</a>,
+        the generated mirror.html will end up in forrest/main/site/mirrors.html
+        rather than in the project's build directory.
+      </div>
 </div>
 </div>
 </div>

Modified: forrest/site/docs_0_80/howto/howto-asf-mirror.pdf
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/howto/howto-asf-mirror.pdf?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
Binary files - no diff available.

Modified: forrest/site/docs_0_80/howto/howto-buildPlugin.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/howto/howto-buildPlugin.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/docs_0_80/howto/howto-buildPlugin.html (original)
+++ forrest/site/docs_0_80/howto/howto-buildPlugin.html Mon Apr  9 21:44:00 2007
@@ -317,13 +317,15 @@
 	          &nbsp;<input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
 </div>
 <h1>How to Build a Plugin</h1>
-<div class="abstract">This How-To describes the steps necessary to build a plugin for 
-    Forrest. Forrest uses plugins to add new input formats, output formats
-    and to change its default behaviour. Since plugins are downloaded when
-    needed and can be hosted at any location, plugin code can be developed 
-    independently of Apache Forrest. This how-to describes each of the major
-    steps in creating a plugin and then works through some examples of 
-    plugin creation in order to illustrate the materials.</div>
+<div class="abstract">
+      This How-To describes the steps necessary to build a plugin for Forrest.
+      Forrest uses plugins to add new input formats, output formats and to
+      change its default behaviour. Since plugins are downloaded when needed and
+      can be hosted at any location, plugin code can be developed independently
+      of Apache Forrest. This how-to describes each of the major steps in
+      creating a plugin and then works through some examples of plugin creation
+      in order to illustrate the materials.
+    </div>
 <div id="motd-area">
         This is documentation for development version v0.8
        (<a href="http://forrest.apache.org/versions/">More</a>)</div>
@@ -437,24 +439,32 @@
 <a name="N10013"></a><a name="Intended Audience"></a>
 <h2 class="underlined_10">Intended Audience</h2>
 <div class="section">
-<p>Users needing to add additional input formats or output formats or
-    to change the operation of the Forrest internals.</p>
+<p>
+      Users needing to add additional input formats or output formats or to
+      change the operation of the Forrest internals.
+    </p>
 <div class="warning">
 <div class="label">Warning</div>
-<div class="content">Please make sure that you are using forrest 0.8 or above if you want use 
-    plugins. Forrest 0.6 will not work!!!</div>
+<div class="content">
+      Please make sure that you are using forrest 0.8 or above if you want use
+      plugins. Forrest 0.6 will not work!!!
+    </div>
 </div>
 </div>
 <a name="N1001E"></a><a name="Purpose"></a>
 <h2 class="underlined_10">Purpose</h2>
 <div class="section">
-<p>This How-To will illustrate how to build a plugin, publish a plugin
-    and configure a Forrest project to use their plugin.</p>
+<p>
+      This How-To will illustrate how to build a plugin, publish a plugin and
+      configure a Forrest project to use their plugin.
+    </p>
 </div>
 <a name="N10026"></a><a name="Prerequisites"></a>
 <h2 class="underlined_10">Prerequisites</h2>
 <div class="section">
-<p>Plugin developers should have:</p>
+<p>
+      Plugin developers should have:
+    </p>
 <ul>
       
 <li>a basic knowledge of XML, XSLT and Cocoon pipelines</li>
@@ -463,7 +473,6 @@
       
 <li>read
         <a href="../../pluginDocs/plugins_0_80/pluginInfrastructure.html">Plugin Infrastructure</a>
-      
 </li>
       
 <li>verified with the Apache Forrest developer community that the
@@ -471,271 +480,349 @@
     
 </ul>
 </div>
-<a name="N10041"></a><a name="Steps"></a>
+<a name="N10040"></a><a name="Steps"></a>
 <h2 class="underlined_10">Steps</h2>
 <div class="section">
-<p>Here is how to proceed.</p>
-<a name="N10049"></a><a name="typeOfPlugin"></a>
+<p>
+      Here is how to proceed.
+    </p>
+<a name="N10048"></a><a name="typeOfPlugin"></a>
 <h3 class="underlined_5">Type of Plugin</h3>
-<p>There are three types of plugin, each with a clear purpose, you
-      must first decide which 
-      <a href="../../pluginDocs/plugins_0_80/pluginInfrastructure.html">type of plugin</a>
-      you need to build.</p>
-<a name="N10057"></a><a name="ant"></a>
+<p>
+        There are three types of plugin, each with a clear purpose, you must
+        first decide which <a href="../../pluginDocs/plugins_0_80/pluginInfrastructure.html">type of
+        plugin</a> you need to build.
+      </p>
+<a name="N10056"></a><a name="ant"></a>
 <h3 class="underlined_5">Make ant available on the command-line</h3>
 <p>
         The following instructions rely heavily on
-        <a href="http://ant.apache.org/">Apache Ant</a>
-        to automate some steps in the process. Since ant
-        is distributed as part of Forrest, all you need to do
-        is add Forrest's 'ant' executable directory to your system path. The
-        name of this directory is <span class="codefrag">tools/ant/bin</span>
-        in your Forrest program directory.
-        Alternatively you can prefix all calls to ant in
-        the following instructions with the full path of the ant binary directory, i.e.
-        $FORREST_HOME/tools/ant/bin/ant
-      </p>
-<p>
-        If instead you really want to use your own version of Ant,
-        then you will need to copy
-        forrest/lib/core/xml-commons-resolver.jar
-        to $ANT_HOME/lib directory, otherwise the building of your plugins will go across
-        the network to get the DTDs on every xml parse. Be aware that Forrest
-        might be relying on some Ant features in its version.
+        <a href="http://ant.apache.org/">Apache Ant</a> to automate some steps
+        in the process. Since ant is distributed as part of Forrest, all you
+        need to do is add Forrest's 'ant' executable directory to your system
+        path. The name of this directory is <span class="codefrag">tools/ant/bin</span> in your
+        Forrest program directory. Alternatively you can prefix all calls to ant
+        in the following instructions with the full path of the ant binary
+        directory, i.e. $FORREST_HOME/tools/ant/bin/ant
+      </p>
+<p>
+        If instead you really want to use your own version of Ant, then you will
+        need to copy forrest/lib/core/xml-commons-resolver.jar to $ANT_HOME/lib
+        directory, otherwise the building of your plugins will go across the
+        network to get the DTDs on every xml parse. Be aware that Forrest might
+        be relying on some Ant features in its version.
       </p>
-<a name="N1006B"></a><a name="seed"></a>
+<a name="N1006A"></a><a name="seed"></a>
 <h3 class="underlined_5">Seed a New Plugin</h3>
-<p>Regardless of the type of plugin you are building, the directory
-      structure is almost identical, as are most of the required
-      configuration files. In this How-To we will assume that you are creating a 
-      plugin in the Forrest source tree. All plugins are developed in the
-      <span class="codefrag">forrest/plugins</span> directory or the 
-      <span class="codefrag">forrest/whiteboard/plugins</span> directory.</p>
-<p class="instruction">Run the following set of commands:</p>
+<p>
+        Regardless of the type of plugin you are building, the directory
+        structure is almost identical, as are most of the required configuration
+        files. In this How-To we will assume that you are creating a plugin in
+        the Forrest source tree. All plugins are developed in the
+        <span class="codefrag">forrest/plugins</span> directory or the
+        <span class="codefrag">forrest/whiteboard/plugins</span> directory.
+      </p>
+<p class="instruction">
+        Run the following set of commands:
+      </p>
 <pre class="code">
       cd [path_to_forrest]/whiteboard/plugins
       ant seedPlugin
       </pre>
-<p>The above ant target will ask you the name of the plugin and some
-      additional information such as a brief description and will
-      build a minimal plugin directory structure and configuration. You will 
-      need to customise these files to build your plugin.</p>
+<p>
+        The above ant target will ask you the name of the plugin and some
+        additional information such as a brief description and will build a
+        minimal plugin directory structure and configuration. You will need to
+        customise these files to build your plugin.
+      </p>
 <div class="note">
 <div class="label">Note</div>
-<div class="content">Although you can name your project anything you like we do have 
-      some <a href="../../pluginDocs/plugins_0_80/pluginInfrastructure.html">naming 
-      conventions</a> that we recommend you follow. Plugins intended to be
-      held at forrest.apache.org must follow the naming convention.</div>
-</div>
-<p>You can also build your plugins from a location outside of the Forrest directory
-      structure, for example from within your own project.
-	      If you don't already have one, create a plugins directory, for example:</p>
+<div class="content">
+        Although you can name your project anything you like we do have some
+        <a href="../../pluginDocs/plugins_0_80/pluginInfrastructure.html">naming conventions</a> that we
+        recommend you follow. Plugins intended to be held at forrest.apache.org
+        must follow the naming convention.
+      </div>
+</div>
+<p>
+        You can also build your plugins from a location outside of the Forrest
+        directory structure, for example from within your own project. If you
+        don't already have one, create a plugins directory, for example:
+      </p>
 <pre class="code">
       cd $PROJECT_HOME
       mkdir plugins
       </pre>
-<p> Then copy $FORREST_HOME/whiteboard/plugins/build.xml to $PROJECT_HOME/plugins.
-      There are a couple of changes you now need to make to the newly copied
-      build.xml file. Open up 'build.xml' for editing. You can change the project
-      name value to something more suitable.Find the property name for
-      forrest.plugins.dir and change the location to read</p>
+<p>
+        Then copy $FORREST_HOME/whiteboard/plugins/build.xml to
+        $PROJECT_HOME/plugins. There are a couple of changes you now need to
+        make to the newly copied build.xml file. Open up 'build.xml' for
+        editing. You can change the project name value to something more
+        suitable.Find the property name for forrest.plugins.dir and change the
+        location to read
+      </p>
 <pre class="code">location="."</pre>
-<p class="instruction">So, revised commands for $PROJECT_HOME/plugins:</p>
+<p class="instruction">
+        So, revised commands for $PROJECT_HOME/plugins:
+      </p>
 <pre class="code">
       cd [path_to_project_home]/plugins
       ant seedPlugin
       </pre>
-<p>See 
-      <a href="../../pluginDocs/plugins_0_80/pluginInfrastructure.html">Plugin
-      Infrastructure</a> for more information about the plugin
-      directory structure and configuration files.</p>
-<a name="N100A9"></a><a name="edit-template"></a>
+<p>
+        See <a href="../../pluginDocs/plugins_0_80/pluginInfrastructure.html">Plugin Infrastructure</a> for
+        more information about the plugin directory structure and configuration
+        files.
+      </p>
+<a name="N100A8"></a><a name="edit-template"></a>
 <h4>Edit the Plugin Template</h4>
-<p>You now have a skeleton plugin project. However, it doesn't do 
-        anything useful yet. Now is a good time to edit some of the files
-        provided.</p>
-<p>Here are some general notes:</p>
-<a name="N100B5"></a><a name="status"></a>
+<p>
+          You now have a skeleton plugin project. However, it doesn't do
+          anything useful yet. Now is a good time to edit some of the files
+          provided.
+        </p>
+<p>
+          Here are some general notes:
+        </p>
+<a name="N100B4"></a><a name="status"></a>
 <h5>status.xml</h5>
-<p>This file is used to track changes to the plugin
-          project and to manage lists of things that still need to be done.
-          At this stage you should correct the <span class="codefrag">person</span> entry
-          near the top of the file. It is also a good idea to add a few key
-          milestones in the task list towards the bottom of the file.</p>
-<p>As you work on the plugin you should record all major changes in
-          this file so that it can then be used as a changelog for your
-          plugin.</p>
-<a name="N100C5"></a><a name="forrest-properties"></a>
+<p>
+            This file is used to track changes to the plugin project and to
+            manage lists of things that still need to be done. At this stage you
+            should correct the <span class="codefrag">person</span> entry near the top of the
+            file. It is also a good idea to add a few key milestones in the task
+            list towards the bottom of the file.
+          </p>
+<p>
+            As you work on the plugin you should record all major changes in
+            this file so that it can then be used as a changelog for your
+            plugin.
+          </p>
+<a name="N100C4"></a><a name="forrest-properties"></a>
 <h5>forrest.properties</h5>
-<p>This file defines many configuration parameters for Forrest. It
-          does not need to be customised in most cases. However, see
-          for more details.</p>
-<a name="N100CF"></a><a name="skinconf"></a>
+<p>
+            This file defines many configuration parameters for Forrest. It does
+            not need to be customised in most cases. However, see for more
+            details.
+          </p>
+<a name="N100CE"></a><a name="skinconf"></a>
 <h5>src/documentation/skinconf.xml</h5>
-<p>This configures the skin for your plugins documentation. There
-          are some items that need to be configured in here, for example, the
-          copyright information. The file is heavily commented so probably
-          best to read through it, changing what you need to.</p>
-<a name="N100D9"></a><a name="doc"></a>
+<p>
+            This configures the skin for your plugins documentation. There are
+            some items that need to be configured in here, for example, the
+            copyright information. The file is heavily commented so probably
+            best to read through it, changing what you need to.
+          </p>
+<a name="N100D8"></a><a name="doc"></a>
 <h5>Documentation</h5>
-<p>It is also a good idea to start writing the documentation at this
-          stage. The above process created a very simple plugin documentation
-          site for you. All you have to do is add the content.</p>
-<a name="N100E3"></a><a name="hosted"></a>
+<p>
+            It is also a good idea to start writing the documentation at this
+            stage. The above process created a very simple plugin documentation
+            site for you. All you have to do is add the content.
+          </p>
+<a name="N100E2"></a><a name="hosted"></a>
 <h5>Style notes for plugins hosted at forrest.apache.org</h5>
 <p>
-            After seeding a new plugin, copy the configuration from an
-            existing plugin (e.g. org.apache.forrest.plugin.input.projectInfo).
-            Copy src/documentation/skinconf.xml (and edit to suit) and 
+            After seeding a new plugin, copy the configuration from an existing
+            plugin (e.g. org.apache.forrest.plugin.input.projectInfo). Copy
+            src/documentation/skinconf.xml (and edit to suit) and
             src/documentation/content/xdocs/images/project-logo.gif
           </p>
-<a name="N100EF"></a><a name="edit-sitemap"></a>
+<a name="N100EE"></a><a name="edit-sitemap"></a>
 <h3 class="underlined_5">Edit the Plugin sitemap file(s)</h3>
-<p>The plugin <span class="codefrag">xmap</span> file is a Cocoon sitemap that is mounted
-      at a strategic place in the Forrest pipeline. It is in this file
-      that you will instruct Forrest how to operate. An input plugin
-      must provide a <span class="codefrag">input.xmap</span> file, an output plugin
-      must provide a <span class="codefrag">output.xmap</span> file, whilst an internal
-      plugin provides a <span class="codefrag">internal.xmap</span> file. In addition, an
-      input plugin may provide a <span class="codefrag">resources.xmap</span> file to
-      allow the plugin to handle items such as JavaScript files.</p>
+<p>
+        The plugin <span class="codefrag">xmap</span> file is a Cocoon sitemap that is mounted at
+        a strategic place in the Forrest pipeline. It is in this file that you
+        will instruct Forrest how to operate. An input plugin must provide a
+        <span class="codefrag">input.xmap</span> file, an output plugin must provide a
+        <span class="codefrag">output.xmap</span> file, whilst an internal plugin provides a
+        <span class="codefrag">internal.xmap</span> file. In addition, an input plugin may
+        provide a <span class="codefrag">resources.xmap</span> file to allow the plugin to handle
+        items such as JavaScript files.
+      </p>
 <div class="note">
 <div class="label">Note</div>
-<div class="content">All input plugins should allow the original source to be retrieved
-      by requesting the document with a <span class="codefrag">*.source.xml</span> extension. So
-      you should ensure that you provide such a match.</div>
-</div>
-<p>It is beyond the scope of this How-To to give details about how to 
-      build your plugins XMap. See the 
-      <a href="../../docs_0_80/sitemap-ref.html">Sitemap Reference</a> for general
-      information. See also 
-      <a href="../../pluginDocs/plugins_0_80/pluginInfrastructure.html">Plugin Infrastructure</a>
-      for some hints and tips on creating plugin sitemaps. In addition, as with
-      all development work on Forrest, you will find
-      the <a href="../../mail-lists.html#forrest-dev">developer mailing list</a>
-      a very good resource (check the archives before posting, please).</p>
-<a name="N1011C"></a><a name="components"></a>
+<div class="content">
+        All input plugins should allow the original source to be retrieved by
+        requesting the document with a <span class="codefrag">*.source.xml</span> extension. So
+        you should ensure that you provide such a match.
+      </div>
+</div>
+<p>
+        It is beyond the scope of this How-To to give details about how to build
+        your plugins XMap. See the <a href="../../docs_0_80/sitemap-ref.html">Sitemap
+        Reference</a> for general information. See also
+        <a href="../../pluginDocs/plugins_0_80/pluginInfrastructure.html">Plugin Infrastructure</a> for some
+        hints and tips on creating plugin sitemaps. In addition, as with all
+        development work on Forrest, you will find the
+        <a href="../../mail-lists.html#forrest-dev">developer mailing list</a> a very
+        good resource (check the archives before posting, please).
+      </p>
+<a name="N1011B"></a><a name="components"></a>
 <h4>Components, Actions and Resources</h4>
-<p>If your plugin uses any components (i.e. generators, transformers or
-        serializers), actions or resources they must
-        be defined in either the xmap for this plugin or one of its parents. The parents
-        of an <span class="codefrag">input.xmap</span> are <span class="codefrag">sitemap.xmap</span> and
-        <span class="codefrag">forrest.xmap</span>, whilst the parent of both 
-        <span class="codefrag">output.xmap</span> and <span class="codefrag">internal.xmap</span> are 
-        <span class="codefrag">sitemap.xmap</span>
+<p>
+          If your plugin uses any components (i.e. generators, transformers or
+          serializers), actions or resources they must be defined in either the
+          xmap for this plugin or one of its parents. The parents of an
+          <span class="codefrag">input.xmap</span> are <span class="codefrag">sitemap.xmap</span> and
+          <span class="codefrag">forrest.xmap</span>, whilst the parent of both
+          <span class="codefrag">output.xmap</span> and <span class="codefrag">internal.xmap</span> are
+          <span class="codefrag">sitemap.xmap</span>
+        
 </p>
-<p>If you want to use the realpath where the sitemap.xmap of your plugin 
-        resides then you need to use 
-        <span class="codefrag">{forrest:forrest.plugins}/PLUGIN_NAME</span> instead of <span class="codefrag">{realpath:/}</span>.
+<p>
+          If you want to use the realpath where the sitemap.xmap of your plugin
+          resides then you need to use
+          <span class="codefrag">{forrest:forrest.plugins}/PLUGIN_NAME</span> instead of
+          <span class="codefrag">{realpath:/}</span>.
+        </p>
+<p>
+          See the examples below for more details.
         </p>
-<p>See the examples below for more details.</p>
 <a name="N10144"></a><a name="resources"></a>
 <h3 class="underlined_5">Create the Necessary Resource Files</h3>
 <div class="fixme">
 <div class="label">Fixme (open)</div>
-<div class="content">Discuss the XSL files and other such resources</div>
+<div class="content">
+        Discuss the XSL files and other such resources
+      </div>
 </div>
 <a name="N1014E"></a><a name="dtd-catalog"></a>
 <h4>Entity catalog for DTDs and other resources</h4>
-<p>If the plugin uses non-core DTDs and other entities, then add them to  the
-          <span class="codefrag">resources/schema</span> directory and configure a catalog.xcat file.
-          The best way to do this is to copy an example from another plugin (e.g.
-          "listLocations" has a simple example; "glossary" has a more complex example)
-          and edit it to suit.</p>
+<p>
+          If the plugin uses non-core DTDs and other entities, then add them to
+          the <span class="codefrag">resources/schema</span> directory and configure a
+          catalog.xcat file. The best way to do this is to copy an example from
+          another plugin (e.g. "listLocations" has a simple example; "glossary"
+          has a more complex example) and edit it to suit.
+        </p>
 <a name="N1015C"></a><a name="samples"></a>
 <h3 class="underlined_5">Create Samples in the Documentation</h3>
-<p>Plugin documentation should provide (as a minimum) an
-      index page that provides an overview and a set of samples that demonstrate
-      the functionality of the plugin. Typically these samples will be
-      provided in a <span class="codefrag">samples</span> subdirectory in the plugin 
-      documentation and will be referenced from both <span class="codefrag">site.xml</span>
-      and <span class="codefrag">tabs.xml</span> configuration files.</p>
-<p>Try to provide a sample for all the major functions of your plugin
-      and document any configuration that is available.</p>
+<p>
+        Plugin documentation should provide (as a minimum) an index page that
+        provides an overview and a set of samples that demonstrate the
+        functionality of the plugin. Typically these samples will be provided in
+        a <span class="codefrag">samples</span> subdirectory in the plugin documentation and will
+        be referenced from both <span class="codefrag">site.xml</span> and <span class="codefrag">tabs.xml</span>
+        configuration files.
+      </p>
+<p>
+        Try to provide a sample for all the major functions of your plugin and
+        document any configuration that is available.
+      </p>
 <a name="N10172"></a><a name="test"></a>
 <h3 class="underlined_5">Testing a Plugin</h3>
-<p>Since your documentation for the plugin illustrates all of its 
-      functionality, you can use that site for testing the plugin. However, you
-      must first deploy in your local install of Forrest. Each plugin contains
-      a buildfile that includes a <span class="codefrag">test</span> target. This target, by
-      default, builds the documentation for your plugin.</p>
-<p class="instruction">Run the command <span class="codefrag">ant test</span> in
-      the plugins directory.</p>
-<p>Of course, the build should complete without errors.</p>
+<p>
+        Since your documentation for the plugin illustrates all of its
+        functionality, you can use that site for testing the plugin. However,
+        you must first deploy in your local install of Forrest. Each plugin
+        contains a buildfile that includes a <span class="codefrag">test</span> target. This
+        target, by default, builds the documentation for your plugin.
+      </p>
+<p class="instruction">
+        Run the command <span class="codefrag">ant test</span> in the plugins directory.
+      </p>
+<p>
+        Of course, the build should complete without errors.
+      </p>
 <div class="note">
 <div class="label">Note</div>
-<div class="content">You can also use <span class="codefrag">forrest run</span> to interactively examine
-      your documentation (point your browser at 
-      <a href="http://localhost:8888">http://localhost:8888</a>).</div>
-</div>
-<p>It is also a really good idea to build proper tests for your 
-      plugins using a suitable testing framework, for example, 
-      <a href="http://webtest.canoo.com/">WebTest</a>. We recommend that you
-      extend the <span class="codefrag">test</span> target in your plugins build file because
-      this target is also used when performing integration tests on Forrest.
-      In addition, we recommend that you use the samples in your documentation 
-      for your tests, this way you are documenting your plugin at the same time 
-      as writing your tests.</p>
-<p>Ensure that your sitemaps are robust and handle matches for files
-      in sub-directories, as well as those at the root level.</p>
+<div class="content">
+        You can also use <span class="codefrag">forrest run</span> to interactively examine your
+        documentation (point your browser at
+        <a href="http://localhost:8888">http://localhost:8888</a>).
+      </div>
+</div>
+<p>
+        It is also a really good idea to build proper tests for your plugins
+        using a suitable testing framework, for example,
+        <a href="http://webtest.canoo.com/">WebTest</a>. We recommend that you
+        extend the <span class="codefrag">test</span> target in your plugins build file because
+        this target is also used when performing integration tests on Forrest.
+        In addition, we recommend that you use the samples in your documentation
+        for your tests, this way you are documenting your plugin at the same
+        time as writing your tests.
+      </p>
+<p>
+        Ensure that your sitemaps are robust and handle matches for files in
+        sub-directories, as well as those at the root level.
+      </p>
 <a name="N1019F"></a><a name="Testing+During+Development"></a>
 <h4>Testing During Development</h4>
-<p>In the current plugin system plugins are not used from their
-        src directories, they must first be deployed locally. To do this
-        run the command
-        <span class="codefrag">$FORREST_HOME/tools/ant/bin/ant local-deploy</span>
+<p>
+          In the current plugin system plugins are not used from their src
+          directories, they must first be deployed locally. To do this run the
+          command <span class="codefrag">$FORREST_HOME/tools/ant/bin/ant local-deploy</span>
+        
 </p>
 <div class="note">
 <div class="label">Note</div>
-<div class="content">The "test" target will do this deployment automatically for you.
-        You need only run it manually if you wish to test the plugin whilst
-        editing content in a live Forrest instance.</div>
-</div>
-<p>When you make changes to the plugin while doing its development,
-        then you need to do the local-deploy again for those changes to have effect.</p>
-<p>In most cases you can locally deploy a plugin without having to 
-        restart Forrest. However, if your plugin changes any configuration
-        files in the <span class="codefrag">conf</span> directory you will, most likely, have 
-        to restart Forrest to see these changes.</p>
-<a name="N101B8"></a><a name="release"></a>
+<div class="content">
+          The "test" target will do this deployment automatically for you. You
+          need only run it manually if you wish to test the plugin whilst
+          editing content in a live Forrest instance.
+        </div>
+</div>
+<p>
+          When you make changes to the plugin while doing its development, then
+          you need to do the local-deploy again for those changes to have
+          effect.
+        </p>
+<p>
+          In most cases you can locally deploy a plugin without having to
+          restart Forrest. However, if your plugin changes any configuration
+          files in the <span class="codefrag">conf</span> directory you will, most likely, have
+          to restart Forrest to see these changes.
+        </p>
+<a name="N101B9"></a><a name="release"></a>
 <h3 class="underlined_5">Releasing a Plugin</h3>
-<a name="N101BE"></a><a name="register"></a>
+<a name="N101BF"></a><a name="register"></a>
 <h4>Register the Plugin with Apache Forrest</h4>
 <div class="fixme">
 <div class="label">Fixme (rdg)</div>
-<div class="content">Describe making a request of Forrest devs for 
-        inclusion</div>
+<div class="content">
+          Describe making a request of Forrest devs for inclusion
+        </div>
 </div>
-<a name="N101C9"></a><a name="deploy"></a>
+<a name="N101CA"></a><a name="deploy"></a>
 <h4>Deploying the Plugin</h4>
-<p>To deploy the plugin so that others can use it, it must be made 
-        available as a zip from the URL indicated in the 
-        <span class="codefrag">plugins.xml</span> file. The plugins build file provides targets 
-        to assist with this task.</p>
-<p class="instruction">To deploy a plugin simply run the command
-        <span class="codefrag">ant deploy</span> from within the plugin directory.</p>
-<p>This command will, by default, deploy to the Apache Forrest web site.
-        In order to do this you need commit access to Forrest. If you want to
-        deploy your plugin to a different location you 
-        can build the zip of your plugin with <span class="codefrag">ant dist</span>
-        and then copy the zip file from <span class="codefrag">build/dist</span> to wherever
-        you intend to host the plugin.</p>
+<p>
+          To deploy the plugin so that others can use it, it must be made
+          available as a zip from the URL indicated in the
+          <span class="codefrag">plugins.xml</span> file. The plugins build file provides targets
+          to assist with this task.
+        </p>
+<p class="instruction">
+          To deploy a plugin simply run the command <span class="codefrag">ant deploy</span> from
+          within the plugin directory.
+        </p>
+<p>
+          This command will, by default, deploy to the Apache Forrest web site.
+          In order to do this you need commit access to Forrest. If you want to
+          deploy your plugin to a different location you can build the zip of
+          your plugin with <span class="codefrag">ant dist</span> and then copy the zip file from
+          <span class="codefrag">build/dist</span> to wherever you intend to host the plugin.
+        </p>
 <div class="note">
 <div class="label">Note</div>
-<div class="content">Running this command on any plugin will also deploy any
-        changes to the <span class="codefrag">plugins.xml</span> file. If you are deploying to
-        your own website you will have to request changes to the 
-        <span class="codefrag">plugins.xml</span> and ask the Forrest committers to publish the new
-        document.</div>
+<div class="content">
+          Running this command on any plugin will also deploy any changes to the
+          <span class="codefrag">plugins.xml</span> file. If you are deploying to your own
+          website you will have to request changes to the
+          <span class="codefrag">plugins.xml</span> and ask the Forrest committers to publish the
+          new document.
+        </div>
 </div>
 <div class="warning">
 <div class="label">Warning</div>
-<div class="content">Running the <span class="codefrag">deploy</span> or <span class="codefrag">dist</span> targets
-        will always run the <span class="codefrag">test</span> target first. This is to ensure
-        that you only deploy working plugins. This adds a little time to
-        the deploy cycle, but we feel the peace of mind is worth it.</div>
+<div class="content">
+          Running the <span class="codefrag">deploy</span> or <span class="codefrag">dist</span> targets will
+          always run the <span class="codefrag">test</span> target first. This is to ensure that
+          you only deploy working plugins. This adds a little time to the deploy
+          cycle, but we feel the peace of mind is worth it.
+        </div>
 </div>
-<a name="N101FB"></a><a name="descriptor"></a>
+<a name="N101FC"></a><a name="descriptor"></a>
 <h4>Managing the plugins descriptors</h4>
 <p>
           The files plugins/plugins.xml and whiteboard/plugins/plugins.xml are
@@ -744,89 +831,106 @@
           are deployed to the forrest website.
         </p>
 <p>
-          Each plugin has a build.xml file which defines its version information.
-          Please keep that synchronised with the plugins.xml files.
+          Each plugin has a build.xml file which defines its version
+          information. Please keep that synchronised with the plugins.xml files.
           Later
           <a href="http://issues.apache.org/jira/browse/FOR-533">FOR-533</a>
-           will generate this from the various build.xml files.
+          will generate this from the various build.xml files.
         </p>
 <p>
           The Apache Forrest committers manage these files in SVN and publish
           them as needed. Here are some notes.
         </p>
 <p>
-          When a plugin gains new functionality, then it will be dependent on
-          a more recent version of Forrest. Deploy the plugin one final time
-          before implementing the new work. For example, if current release
-          is 0.7 then ...
+          When a plugin gains new functionality, then it will be dependent on a
+          more recent version of Forrest. Deploy the plugin one final time
+          before implementing the new work. For example, if current release is
+          0.7 then ...
         </p>
 <ul>
-           
+          
 <li>Review the docs and ensure any version numbers in text are "0.7"</li>
-           
+          
 <li>Edit the skinconf.xml to ensure that all version numbers are "0.7", e.g. the MOTD.</li>
-           
+          
 <li>Edit the plugin's descriptors to ensure that the "forrestVersion" is 0.7 and that the "version" is appropriate. </li>
-           
+          
 <li>Ensure that the "website" parameter includes "pluginDocs/plugins_0_70"</li>
-           
+          
 <li>Edit status.xml to set the release date. Ensure that the changes notes are complete.</li>
         
 </ul>
 <p>
-          Now the plugin gains functionality that binds it to 0.8-dev
-          (e.g. converted to use locationmap) so ...
+          Now the plugin gains functionality that binds it to 0.8-dev (e.g.
+          converted to use locationmap) so ...
         </p>
 <ul>
-           
+          
 <li>Review the docs and ensure any version numbers in text are
              "0.8"</li>
-           
+          
 <li>Edit the skinconf.xml to ensure that all version numbers are
              "0.8-dev", e.g. the MOTD.</li>
-           
+          
 <li>Edit the plugin's descriptors to ensure that the "forrestVersion" is
              0.8 and that the "version" is incremented. </li>
-           
+          
 <li>Ensure that the "website" parameter includes "pluginDocs/plugins_0_80"</li>
-           
+          
 <li>Edit status.xml to add a new section and set the release date.
              Start adding changes notes.</li>
         
 </ul>
-<a name="N1023A"></a><a name="experimental"></a>
+<a name="N1023B"></a><a name="experimental"></a>
 <h3 class="underlined_5">Experimental Functionality</h3>
 <div class="warning">
 <div class="label">Warning</div>
-<div class="content">This section describes functionality that is considered experimental.
-      This functionality may be defective and is not part of the official release at
-      this time, use at your own risk. If you do choose to use this functionality then
-      we recomend that you join the Forrest dev list in order to keep abreast of the
-      changes as they occur.</div>
+<div class="content">
+        This section describes functionality that is considered experimental.
+        This functionality may be defective and is not part of the official
+        release at this time, use at your own risk. If you do choose to use this
+        functionality then we recomend that you join the Forrest dev list in
+        order to keep abreast of the changes as they occur.
+      </div>
 </div>
 <div class="note">
 <div class="label">Note</div>
-<div class="content">For an example of each of these features in use see the 
-      <span class="codefrag">org.apache.forrest.internal.NoteTaking</span> plugin.</div>
+<div class="content">
+        For an example of each of these features in use see the
+        <span class="codefrag">org.apache.forrest.internal.NoteTaking</span> plugin.
+      </div>
 </div>
-<a name="N10249"></a><a name="Locationmap"></a>
+<a name="N1024A"></a><a name="Locationmap"></a>
 <h4>Locationmap</h4>
-<p>Plugins can use the Forrest locationmap to expose resources to your
-        project and other plgins. To use this functionality add your 
-        <span class="codefrag">locationmap.xml</span> file to the root of the plugin directory.</p>
-<p>We have an <a href="http://issues.apache.org/jira/browse/FOR-200">issue</a>
-        for the status of locationmap development.</p>
-<a name="N1025D"></a><a name="Dispatcher"></a>
+<p>
+          Plugins can use the Forrest locationmap to expose resources to your
+          project and other plgins. To use this functionality add your
+          <span class="codefrag">locationmap.xml</span> file to the root of the plugin directory.
+        </p>
+<p>
+          We have an
+          <a href="http://issues.apache.org/jira/browse/FOR-200">issue</a> for
+          the status of locationmap development.
+        </p>
+<a name="N1025E"></a><a name="Dispatcher"></a>
 <h4>Dispatcher</h4>
-<p>Dispatcher (previous codename Forrest Views) is the collective name for the various pieces of functionality
-        that are intended to replace skins in the future. They allow for a much more
-        configurable system of defining the contents and look and feel of a site.</p>
-<p>Plugins can expose contracts, resources  and tiles for use in structurer files used within
-        Dispatcher-based sites. In order to do this you should develop your contracts
-        as normal and place them in <span class="codefrag">PLUGIN_HOME/resources/themes</span>. However,
-        this, by itself, is not sufficient to export your contracts. You will also need to
-        add the following match to your plugin's <span class="codefrag">locationmap.xml</span> file:</p>
+<p>
+          Dispatcher (previous codename Forrest Views) is the collective name
+          for the various pieces of functionality that are intended to replace
+          skins in the future. They allow for a much more configurable system of
+          defining the contents and look and feel of a site.
+        </p>
+<p>
+          Plugins can expose contracts, resources and tiles for use in
+          structurer files used within Dispatcher-based sites. In order to do
+          this you should develop your contracts as normal and place them in
+          <span class="codefrag">PLUGIN_HOME/resources/themes</span>. However, this, by itself,
+          is not sufficient to export your contracts. You will also need to add
+          the following match to your plugin's <span class="codefrag">locationmap.xml</span>
+          file:
+        </p>
 <pre class="code">
+
     &lt;match pattern="resolvePluginContract.*.**"&gt;
       &lt;select type="exists"&gt;
         &lt;location src="{forrest:forrest.plugins}/PLUGIN_NAME/resources/themes/{properties:dispatcher.theme}/{1}/{2}.ft" /&gt;
@@ -844,40 +948,59 @@
         &lt;location src="{forrest:forrest.plugins}/PLUGIN_NAME/resources/themes/{properties:dispatcher.theme}/html/{1}.vt.xml" /&gt;
         &lt;location src="{forrest:forrest.plugins}/PLUGIN_NAME/resources/themes/{properties:dispatcher.fallback.theme}/html/{1}.vt.xml" /&gt;
       &lt;/select&gt;
-    &lt;/match&gt;</pre>
-<p>Of course, you should replace <span class="codefrag">PLUGIN_NAME</span> with the name of 
-        your plugin.</p>
-<p>Once Dispatcher becomes stable we will add this matches to the default locationmap
-        which is generated when you seed a new plugin, but for now it must be done manually.</p>
-<a name="N1027D"></a><a name="Plugin+Properties"></a>
+    &lt;/match&gt;
+        </pre>
+<p>
+          Of course, you should replace <span class="codefrag">PLUGIN_NAME</span> with the name
+          of your plugin.
+        </p>
+<p>
+          Once Dispatcher becomes stable we will add this matches to the default
+          locationmap which is generated when you seed a new plugin, but for now
+          it must be done manually.
+        </p>
+<a name="N1027E"></a><a name="Plugin+Properties"></a>
 <h4>Plugin Properties</h4>
-<p>Plugins can define properties that each project can over-ride.
-        For more information see the issue below.</p>
-<p>We have an <a href="http://issues.apache.org/jira/browse/FOR-588">issue</a>
-        for the status of this new configuration system.</p>
-<a name="N1028F"></a><a name="examples"></a>
+<p>
+          Plugins can define properties that each project can over-ride. For
+          more information see the issue below.
+        </p>
+<p>
+          We have an
+          <a href="http://issues.apache.org/jira/browse/FOR-588">issue</a> for
+          the status of this new configuration system.
+        </p>
+<a name="N10290"></a><a name="examples"></a>
 <h3 class="underlined_5">Examples</h3>
-<p>This section will provide some example plugins to help illustrate the
-      steps discussed above.</p>
-<a name="N10298"></a><a name="input"></a>
+<p>
+        This section will provide some example plugins to help illustrate the
+        steps discussed above.
+      </p>
+<a name="N10299"></a><a name="input"></a>
 <h4>Input Plugin</h4>
 <div class="fixme">
 <div class="label">Fixme (RDG)</div>
-<div class="content">Discuss OpenOffice.org plugin here</div>
+<div class="content">
+          Discuss OpenOffice.org plugin here
+        </div>
 </div>
-<a name="N102A3"></a><a name="output"></a>
+<a name="N102A4"></a><a name="output"></a>
 <h4>Output Plugin</h4>
 <div class="fixme">
 <div class="label">Fixme (RDG)</div>
-<div class="content">Discuss s5 plugin here</div>
+<div class="content">
+          Discuss s5 plugin here
+        </div>
 </div>
-<a name="N102AE"></a><a name="internal"></a>
+<a name="N102AF"></a><a name="internal"></a>
 <h4>Internal Plugin</h4>
 <div class="fixme">
 <div class="label">Fixme (RDG)</div>
-<div class="content">Discuss IMSManifest plugin here</div>
+<div class="content">
+          Discuss IMSManifest plugin here
+        </div>
 </div>
-<a name="N102BA"></a><a name="extension"></a>
+<a name="N102BB"></a><a name="extension"></a>
 <h3 class="underlined_5">Further Reading</h3>
 <ul>
         
@@ -888,12 +1011,14 @@
 <a href="../../pluginDocs/plugins_0_80/">Plugins Documentation</a> for users</li>
       
 </ul>
-<a name="N102D0"></a><a name="summarise"></a>
+<a name="N102D1"></a><a name="summarise"></a>
 <h3 class="underlined_5">Summarise the Entire Process</h3>
 <div class="fixme">
 <div class="label">Fixme (open)</div>
-<div class="content">In a few sentences, remind the reader what they have just learned.
-      This helps to reinforce the main points of your How-To.</div>
+<div class="content">
+        In a few sentences, remind the reader what they have just learned. This
+        helps to reinforce the main points of your How-To.
+      </div>
 </div>
 </div>
 <span class="version">0.3.0</span>

Modified: forrest/site/docs_0_80/howto/howto-buildPlugin.pdf
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/howto/howto-buildPlugin.pdf?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
Binary files - no diff available.

Modified: forrest/site/docs_0_80/howto/howto-corner-images.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/howto/howto-corner-images.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/docs_0_80/howto/howto-corner-images.html (original)
+++ forrest/site/docs_0_80/howto/howto-corner-images.html Mon Apr  9 21:44:00 2007
@@ -318,9 +318,9 @@
 </div>
 <h1>How to modify the color of generated corner images</h1>
 <div class="abstract">
-    This How-To describes how to modify the corner images that appear in
-    the menu and tabs of the skins.
-  </div>
+      This How-To describes how to modify the corner images that appear in the
+      menu and tabs of the skins.
+    </div>
 <div id="motd-area">
         This is documentation for development version v0.8
        (<a href="http://forrest.apache.org/versions/">More</a>)</div>
@@ -358,12 +358,12 @@
 <h2 class="underlined_10">Intended Audience</h2>
 <div class="section">
 <p>
-      Users who want to change the colors of the corner images in the
-      output html documents.
+      Users who want to change the colors of the corner images in the output
+      html documents.
     </p>
 <p>
-      This explanation is also useful for skin developers to understand
-      the corner image generation process.
+      This explanation is also useful for skin developers to understand the
+      corner image generation process.
     </p>
 </div>
 <a name="N1001B"></a><a name="Purpose"></a>
@@ -371,9 +371,9 @@
 <div class="section">
 <p>
       Forrest renders the corner images through
-      <a href="http://www.w3.org/TR/SVG/">Scalable Vector Graphics (SVG)</a>.
-      It may be necessary to change the color of
-      the corner images to be suitable for your own skin colors.
+      <a href="http://www.w3.org/TR/SVG/">Scalable Vector Graphics (SVG)</a>. It
+      may be necessary to change the color of the corner images to be suitable
+      for your own skin colors.
     </p>
 </div>
 <a name="N10027"></a><a name="Prerequisites"></a>
@@ -395,15 +395,15 @@
 <div class="section">
 <p>
       The procedure outlined below provides an understanding of how corner
-      images are named (the contract) and then shows how to define new
-      colors for these images by modifying the
+      images are named (the contract) and then shows how to define new colors
+      for these images by modifying the
       <span class="codefrag">src/documentation/skinconf.xml</span> of a project.
     </p>
 <a name="N10048"></a><a name="css-files"></a>
 <h3 class="underlined_5">Understand how corner images are named (the contract)</h3>
 <p>
-        The corner images are referenced in some .css files of the
-        above-named skins; for example, in screen.css of the pelt skin:
+        The corner images are referenced in some .css files of the above-named
+        skins; for example, in screen.css of the pelt skin:
       </p>
 <pre class="code">
 /*Example from screen.css of pelt*/
@@ -419,8 +419,8 @@
 ...
       </pre>
 <p>
-        The naming follows a contract which is described below. In general,
-        the naming looks like:
+        The naming follows a contract which is described below. In general, the
+        naming looks like:
       </p>
 <pre class="code">
 images/{$name}-{$v-orientation}-{$h-orientation}-{$size}-1{$backgroundColor}-2{$strokeColor}-3{$foregroundColor}
@@ -433,8 +433,8 @@
         (<span class="codefrag">-1{$backgroundColor}-2{$strokeColor}-3{$foregroundColor}</span>)
         identifies the coloring of each portion of the image. The input
         parameter for the second part comes from the color profile of
-        <span class="codefrag">src/documentation/skinconf.xml</span>. The second part is
-        easily identifiable through the numbering 1-2-3.
+        <span class="codefrag">src/documentation/skinconf.xml</span>. The second part is easily
+        identifiable through the numbering 1-2-3.
       </p>
 <p>
         Let us get into details:
@@ -448,9 +448,7 @@
 <dd>
           Path to the xslt that creates the corner.
           <br>
-          
 <span class="codefrag">images/ = {$FORREST_HOME}/main/webapp/skins/common/images/</span>
-        
 </dd>
         
 <dt>
@@ -462,23 +460,18 @@
           <ul>
             
 <li>
-              
 <span class="codefrag">rc.svg.xslt</span>: handles rounded corners
             </li>
             
 <li>
-              
 <span class="codefrag">dc.svg.xslt</span>: handles diagonal 45-degree corners
             </li>
           
 </ul>
-          
 <span class="codefrag">name = [rc|dc]</span>
           
 <br>
-          
-<em>e.g.</em> <span class="codefrag">rc</span>
-        
+<em>e.g.</em><span class="codefrag">rc</span>
 </dd>
         
 <dt>
@@ -488,13 +481,10 @@
 <dd>
           Vertical orientation of the corner images (top or bottom).
           <br>
-          
 <span class="codefrag">v-orientation = [t|b]</span>
           
 <br>
-          
-<em>e.g.</em> <span class="codefrag">t</span>
-        
+<em>e.g.</em><span class="codefrag">t</span>
 </dd>
         
 <dt>
@@ -504,13 +494,10 @@
 <dd>
           Horizontal orientation of the corner images (left or right).
           <br>
-          
 <span class="codefrag">h-orientation = [l|r]</span>
           
 <br>
-          
-<em>e.g.</em> <span class="codefrag">r</span>
-        
+<em>e.g.</em><span class="codefrag">r</span>
 </dd>
         
 <dt>
@@ -520,13 +507,10 @@
 <dd>
           Pixels size of the width <strong>and</strong> height of the corner image.
           <br>
-          
 <span class="codefrag">size=x</span>
           
 <br>
-          
-<em>e.g.</em> <span class="codefrag">5</span>
-        
+<em>e.g.</em><span class="codefrag">5</span>
 </dd>
         
 <dt>
@@ -537,9 +521,7 @@
           Any <span class="codefrag">&lt;color name=""/&gt;</span> element in the <span class="codefrag">skinconf.xml</span> (the <span class="codefrag">value="{$color}"</span>
           attribute will be applied).
           <br>
-          
-<em>e.g.</em> <span class="codefrag">header</span>
-        
+<em>e.g.</em><span class="codefrag">header</span>
 </dd>
         
 <dt>
@@ -550,9 +532,7 @@
           Any <span class="codefrag">&lt;color name=""/&gt;</span> element in the <span class="codefrag">skinconf.xml</span> (the <span class="codefrag">value="{$color}"</span>
           attribute will be applied).
           <br>
-          
-<em>e.g.</em> <span class="codefrag">searchbox</span>
-        
+<em>e.g.</em><span class="codefrag">searchbox</span>
 </dd>
         
 <dt>
@@ -563,33 +543,38 @@
           Any <span class="codefrag">&lt;color name=""/&gt;</span> element in the <span class="codefrag">skinconf.xml</span> (the <span class="codefrag">value="{$color}"</span>
           attribute will be applied).
           <br>
-          
-<em>e.g.</em> <span class="codefrag">searchbox</span>
-        
+<em>e.g.</em><span class="codefrag">searchbox</span>
 </dd>
       
 </dl>
-<p>The corner images are made by generating a dymanic <a href="/skin/images/rc-t-r-50-1body-2menu-3menu.svg">svg image</a> to 
-        add the colors and size. Then this svg is serialize to <a href="/skin/images/rc-t-r-50-1body-2menu-3menu.png">the png image</a> 
-        via the <a href="http://cocoon.apache.org/2.1/apidocs/org/apache/cocoon/serialization/SVGSerializer.html">org.apache.cocoon.serialization.SVGSerializer</a>
-        (see <a href="http://cocoon.apache.org/2.1/userdocs/svg-serializer.html">docs</a>).
+<p>
+        The corner images are made by generating a dymanic
+        <a href="/skin/images/rc-t-r-50-1body-2menu-3menu.svg">svg
+        image</a> to add the colors and size. Then this svg is serialize to
+        <a href="/skin/images/rc-t-r-50-1body-2menu-3menu.png">the png
+        image</a> via the
+        <a href="http://cocoon.apache.org/2.1/apidocs/org/apache/cocoon/serialization/SVGSerializer.html">org.apache.cocoon.serialization.SVGSerializer</a>
+        (see
+        <a href="http://cocoon.apache.org/2.1/userdocs/svg-serializer.html">docs</a>).
       </p>
 <div class="fixme">
 <div class="label">Fixme (thorsten)</div>
-<div class="content">The following link is for pure debugging 
-        reason. <a href="/skin/images/rc-t-r-50-1body-2menu-3menu.test.png">test png 
-        image</a> - this image is taken from the svg pipe instead of directly 
-        generating it. </div>
+<div class="content">
+        The following link is for pure debugging reason.
+        <a href="/skin/images/rc-t-r-50-1body-2menu-3menu.test.png">test
+        png image</a> - this image is taken from the svg pipe instead of
+        directly generating it.
+      </div>
 </div>
-<a name="N1013E"></a><a name="skinconfig"></a>
+<a name="N10121"></a><a name="skinconfig"></a>
 <h3 class="underlined_5">Modifying the skinconf.xml of your project</h3>
 <p>
-        modifying the <span class="codefrag">skinconf.xml</span> of your project (by
-        default you find it at <span class="codefrag">[project-dir]/src/documentation/</span>).
+        modifying the <span class="codefrag">skinconf.xml</span> of your project (by default you
+        find it at <span class="codefrag">[project-dir]/src/documentation/</span>).
       </p>
 <p>
-        Starting about line 155 you find a <span class="codefrag">&lt;colors&gt;</span>
-        ... <span class="codefrag">&lt;/colors&gt;</span> element with content commented-out:
+        Starting about line 155 you find a <span class="codefrag">&lt;colors&gt;</span> ...
+        <span class="codefrag">&lt;/colors&gt;</span> element with content commented-out:
       </p>
 <pre class="code">
 &lt;colors&gt;
@@ -611,10 +596,10 @@
 &lt;/colors&gt;
       </pre>
 <p>
-        To modify the colors of the corner images, you can either define
-        your own <span class="codefrag">&lt;color name=.../&gt;</span> elements or uncomment
-        one of the existing <span class="codefrag">&lt;color name=.../&gt;</span> elements
-        and adjust the color value to your needs.
+        To modify the colors of the corner images, you can either define your
+        own <span class="codefrag">&lt;color name=.../&gt;</span> elements or uncomment one of
+        the existing <span class="codefrag">&lt;color name=.../&gt;</span> elements and adjust
+        the color value to your needs.
       </p>
 <p>
         
@@ -625,8 +610,9 @@
 &lt;color name="tab-selected" value="#FF0000"/&gt;
       </pre>
 <p>
-        This affects all corner images whose <span class="codefrag">{$backgroundColor}</span>, <span class="codefrag">{$strokeColor}</span> or
-        <span class="codefrag">{$foregroundColor}</span> is set to <span class="codefrag">tab-selected</span>.
+        This affects all corner images whose <span class="codefrag">{$backgroundColor}</span>,
+        <span class="codefrag">{$strokeColor}</span> or <span class="codefrag">{$foregroundColor}</span> is set to
+        <span class="codefrag">tab-selected</span>.
         <br>
         For example, in <span class="codefrag">screen.css</span> (of the "pelt" skin) you find:
       </p>
@@ -639,15 +625,14 @@
       </pre>
 <p>
         Now the stroke color (<span class="codefrag">-2tab-selected</span>) and the foreground
-        color (<span class="codefrag">-3tab-selected</span>) are set to red (remember: we
-        defined <span class="codefrag">#FF0000</span> as the "color" value of
-        <span class="codefrag">tab-selected</span>).
+        color (<span class="codefrag">-3tab-selected</span>) are set to red (remember: we defined
+        <span class="codefrag">#FF0000</span> as the "color" value of <span class="codefrag">tab-selected</span>).
       </p>
-<a name="N10195"></a><a name="css_modify"></a>
+<a name="N10178"></a><a name="css_modify"></a>
 <h3 class="underlined_5">Modifying .css files</h3>
 <p>
-        In addition to the modification of <span class="codefrag">skinconf.xml</span>
-        you can also modify the respective .css file of your skin.
+        In addition to the modification of <span class="codefrag">skinconf.xml</span> you can
+        also modify the respective .css file of your skin.
       </p>
 <p>
         Here's another example:
@@ -672,13 +657,13 @@
 &lt;/colors&gt;
       </pre>
 <p>
-        Here we have created our own color tags (in the .css file) and
-        defined the respective values for them (in <span class="codefrag">skinconf.xml</span>). 
-        Now you have color images with a red background and a green
-        foreground. Horrible, isn't it?
+        Here we have created our own color tags (in the .css file) and defined
+        the respective values for them (in <span class="codefrag">skinconf.xml</span>). Now you
+        have color images with a red background and a green foreground.
+        Horrible, isn't it?
       </p>
 </div>
-<a name="N101C5"></a><a name="Feedback"></a>
+<a name="N101A8"></a><a name="Feedback"></a>
 <h2 class="underlined_10">Feedback</h2>
 <div class="section">
 <p>

Modified: forrest/site/docs_0_80/howto/howto-corner-images.pdf
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/howto/howto-corner-images.pdf?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
Binary files - no diff available.



Mime
View raw message