JSIEVE-67 Re-indent JSIEVE website
authorbenwa <benwa@minet.net>
Wed, 20 Jan 2016 20:26:39 +0000 (21:26 +0100)
committerbenwa <benwa@minet.net>
Wed, 20 Jan 2016 20:28:20 +0000 (21:28 +0100)
core/src/site/xdoc/features.xml
core/src/site/xdoc/index.xml
core/src/site/xdoc/start.xml

index 9ccadd2..2d335a7 100644 (file)
   <author email="jsieve-dev@jakarta.apache.org">jSieve Project</author>
  </properties>
 
-<body>
-<section name='jSieve Features'>
-<subsection name='Sieve Features Supported By jSieve'>
-<p>
-jSieve is limited only by the platform on which it runs.
-</p>
-<table>
-<tr><th>Limits</th><th/></tr>
-<tr><td>Maximum Number Of Actions</td><td>No intrinsic limit</td></tr>
-<tr><td>Maximum Number Of Nested Blocks</td><td>No intrinsic limit</td></tr>
-<tr><td>Maximum Number Of Nested Test Lists</td><td>No intrinsic limit</td></tr>
-</table>
-<p>
-jSieve supports the standard control commands specified in RFC 3028.
-</p>
-<table>
-<tr>
-<th>Control Command</th><th>Specification</th><th>Supported</th>
-</tr>
-<tr>
-<td>If</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
-</tr>
-<td>Require</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
-<tr>
-<td>Stop</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
-</tr>
-</table>
-<p>
-jSieve supports all action commands (both required and optional) 
-specified in RFC 3028. 
-</p><p>
-<strong>Note</strong> that jSieve uses a pluggable 
-<code>MailAdapter</code> as an interface to the mail server.
-Not all implementations may fully support all actions.
-</p>  
-<table>
-<tr>
-<th>Action Command</th><th>Specification</th><th>Supported</th>
-</tr><tr>
-<td>reject</td><td>RFC 3028 (OPTIONAL)</td><td>yes</td>
-</tr><tr>
-<td>fileinto</td><td>RFC 3028 (OPTIONAL)</td><td>yes</td>
-</tr><tr>
-<td>redirect</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
-</tr><tr>
-<td>keep</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
-</tr><tr>
-<td>discard</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
-</tr>
-</table>
-<p>
-jSieve supports all tests commands specified in RFC 3028.
-</p>
-<table>
-<tr>
-<th>Test Command</th><th>Specification</th><th>Supported</th>
-</tr><tr>
-<td>address</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
-</tr><tr>
-<td>allof</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
-</tr><tr>
-<td>anyof</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
-</tr><tr>
-<td>envelope</td><td>RFC 3028 (OPTIONAL)</td><td>yes</td>
-</tr><tr>
-<td>exists</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
-</tr><tr>
-<td>false</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
-</tr><tr>
-<td>header</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
-</tr><tr>
-<td>not</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
-</tr><tr>
-<td>size</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
-</tr><tr>
-<td>true</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
-</tr><tr>
-<td>body</td><td><a href='http://tools.ietf.org/html/draft-ietf-sieve-body-00'>SIEVE body extension</a></td><td>partial</td>
-</tr>
-</table>
-</subsection>
-<subsection name='jSieve Extension Commands'>
-<p>
-jSieve allows extension commands to be developed
-and plugged in at run time.
-The following extension commands ship with jSieve:
-</p>
-<table>
-<tr><th>Name</th><th>Function</th></tr>
-<tr><td>Log</td><td>Logs messages</td></tr>
-</table>
-</subsection>
-</section>
-</body>
+ <body>
+  <section name='jSieve Features'>
+   <subsection name='Sieve Features Supported By jSieve'>
+    <p>
+     jSieve is limited only by the platform on which it runs.
+    </p>
+    <table>
+     <tr><th>Limits</th><th/></tr>
+     <tr><td>Maximum Number Of Actions</td><td>No intrinsic limit</td></tr>
+     <tr><td>Maximum Number Of Nested Blocks</td><td>No intrinsic limit</td></tr>
+     <tr><td>Maximum Number Of Nested Test Lists</td><td>No intrinsic limit</td></tr>
+    </table>
+    <p>
+     jSieve supports the standard control commands specified in RFC 3028.
+    </p>
+    <table>
+     <tr>
+      <th>Control Command</th><th>Specification</th><th>Supported</th>
+     </tr>
+     <tr>
+      <td>If</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
+     </tr>
+     <td>Require</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
+     <tr>
+      <td>Stop</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
+     </tr>
+    </table>
+    <p>
+     jSieve supports all action commands (both required and optional)
+     specified in RFC 3028.
+    </p>
+    <p>
+     <strong>Note</strong> that jSieve uses a pluggable
+     <code>MailAdapter</code> as an interface to the mail server.
+     Not all implementations may fully support all actions.
+    </p>
+    <table>
+     <tr>
+      <th>Action Command</th><th>Specification</th><th>Supported</th>
+     </tr>
+     <tr>
+      <td>reject</td><td>RFC 3028 (OPTIONAL)</td><td>yes</td>
+     </tr>
+     <tr>
+      <td>fileinto</td><td>RFC 3028 (OPTIONAL)</td><td>yes</td>
+     </tr>
+     <tr>
+      <td>redirect</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
+     </tr>
+     <tr>
+      <td>keep</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
+     </tr>
+     <tr>
+      <td>discard</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
+     </tr>
+    </table>
+    <p>
+     jSieve supports all tests commands specified in RFC 3028.
+    </p>
+    <table>
+     <tr>
+      <th>Test Command</th><th>Specification</th><th>Supported</th>
+     </tr>
+     <tr>
+      <td>address</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
+     </tr>
+     <tr>
+      <td>allof</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
+     </tr>
+     <tr>
+      <td>anyof</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
+     </tr>
+     <tr>
+      <td>envelope</td><td>RFC 3028 (OPTIONAL)</td><td>yes</td>
+     </tr>
+     <tr>
+      <td>exists</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
+     </tr>
+     <tr>
+      <td>false</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
+     </tr>
+     <tr>
+      <td>header</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
+     </tr>
+     <tr>
+      <td>not</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
+     </tr>
+     <tr>
+      <td>size</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
+     </tr>
+     <tr>
+      <td>true</td><td>RFC 3028 (REQUIRED)</td><td>yes</td>
+     </tr>
+     <tr>
+      <td>body</td><td><a href='http://tools.ietf.org/html/draft-ietf-sieve-body-00'>SIEVE body extension</a></td><td>partial</td>
+     </tr>
+    </table>
+   </subsection>
+   <subsection name='jSieve Extension Commands'>
+    <p>
+     jSieve allows extension commands to be developed
+     and plugged in at run time.
+     The following extension commands ship with jSieve:
+    </p>
+    <table>
+     <tr><th>Name</th><th>Function</th></tr>
+     <tr><td>Log</td><td>Logs messages</td></tr>
+    </table>
+   </subsection>
+  </section>
+ </body>
 </document>
index 49ba1e1..71811b3 100644 (file)
   <author email="jsieve-dev@jakarta.apache.org">jSieve Project</author>
  </properties>
 
-<body>
-<section name="What is jSieve?">
-<p>
-jSieve is a Java implementation of the Sieve mail filtering language defined by 
-<a href='http://www.rfc-editor.org/rfc/rfc3028.txt'>RFC 3028</a>. jSieve is implemented 
-as a language processor that can be plugged into any internet mail application to add 
-Sieve support.
-</p>
-<p>
-jSieve is a subproject of <a href='http://james.apache.org'>Apache JAMES</a>.
-All who are interested in developing jSieve and JAMES will be warmly
-welcomed on the <a href='mail-lists.html'>mailing lists</a>.
-</p>
-<subsection name='What is Sieve?'>
-<p>
-Sieve is an extensible mail filtering language. It's limited expressiveness (no loops
-or variables, no tests with side effects) allows user created scripts to be run 
-safely on email servers. Sieve is targeted at the final delivery phase 
-(where an incoming email is transferred to a user's mailbox).
-</p>
-<p>
-Sieve scripts are composed of commands. Control commands manage the execution of the script.
-Test commands define side-effect free criteria. 
-Action commands are mail operations to be performed.
-</p>
+ <body>
+  <section name="What is jSieve?">
+   <p>
+    jSieve is a Java implementation of the Sieve mail filtering language defined by
+    <a href='http://www.rfc-editor.org/rfc/rfc3028.txt'>RFC 3028</a>. jSieve is implemented
+    as a language processor that can be plugged into any internet mail application to add
+    Sieve support.
+   </p>
+   <p>
+    jSieve is a subproject of <a href='http://james.apache.org'>Apache JAMES</a>.
+    All who are interested in developing jSieve and JAMES will be warmly
+    welcomed on the <a href='mail-lists.html'>mailing lists</a>.
+   </p>
+   <subsection name='What is Sieve?'>
+    <p>
+     Sieve is an extensible mail filtering language. It's limited expressiveness (no loops
+     or variables, no tests with side effects) allows user created scripts to be run
+     safely on email servers. Sieve is targeted at the final delivery phase
+     (where an incoming email is transferred to a user's mailbox).
+    </p>
+    <p>
+     Sieve scripts are composed of commands. Control commands manage the execution of the script.
+     Test commands define side-effect free criteria.
+     Action commands are mail operations to be performed.
+    </p>
 
-</subsection>
-</section>
-</body>
+   </subsection>
+  </section>
+ </body>
 </document>
index 4d9deea..1fc8a03 100644 (file)
 -->
 <document>
 
- <properties>
-  <title>Overview</title>
-  <author email="jsieve-dev@jakarta.apache.org">jSieve Project</author>
- </properties>
   <properties>
+        <title>Overview</title>
+        <author email="jsieve-dev@jakarta.apache.org">jSieve Project</author>
   </properties>
 
-<body>
-<section name="Getting Started">
-<p>Until these pages are fleshed out, the best way to understand jSieve is read the 
-<a href='apidocs/index.html'>Javadocs</a> 
-and look at the <a href='xref/index.html'>source code</a>. 
-The jUnit tests illustrate many aspects
-of the implementation.
-</p>
-<subsection name='Using jSieve'>
-<subsection name='Standalone'>
-<p>
-<a href='xref/org/apache/jsieve/SieveFactory.html'>
-<code>org.apache.jsieve.SieveFactory</code></a> is the primary invocation
-point for all Sieve operations. The API is clean and simple.
-See the 
-<a href='apidocs/index.html'>javadocs</a> for more details.
-</p>
-</subsection>
-<subsection name='In JAMES'>
-<p>
-The <code>SieveToMultiMailbox</code> mailet is included in JAMES.
-It is integrated with the message delivery spool and provides per-user 
-Sieve scripting using jSieve. 
-</p>
-</subsection>
-</subsection>
-<subsection name='Implementing A Mail Adapter'>
-<p>
-<a href='xref/org/apache/jsieve/mail/MailAdapter.html'>
-<code>org.apache.jsieve.mail.MailAdapter</code></a> is the interface API used
-by jSieve to interact with a mail server. 
-</p><p>
-The mail adapter wraps an email
-and supplies information (required by the script) about the email. It is 
-responsible for accumulating <code>Action</code>s during the parsing of a
-script and for executing them once the parsing is complete.
-</p><p>
-See the 
-<a href='apidocs/index.html'>javadocs</a> for more details and this
-<a href='xref/org/apache/jsieve/samples/james/SieveMailAdapter.html'>sample</a>.
-</p>
-</subsection>
-<subsection name='Creating A Custom Extension Command'>
-<p>
-<a href='xref/org/apache/jsieve/commands/extensions/Log.html'>
-<code>org.apache.jsieve.commands.extensions.Log</code></a> is an example
-of a custom extension command. It is recommended that custom commands
-extend <a href='xref/org/apache/jsieve/commands/AbstractCommand.html'>
-<code>AbstractCommand</code></a>. See the 
-<a href='apidocs/index.html'>javadocs</a> for more details.
-</p><p>
-Custom commands need to be registered with 
-<a href='xref/org/apache/jsieve/ConfigurationManager.html'>
-<code>ConfigurationManager</code></a> before they can be used. This
-may be done programmatically but the recommended method is by altering
-the <code>org/apache/jsieve/commandsmap.properties</code>, <code>org/apache/jsieve/testsmap.properties</code>
-and <code>org/apache/jsieve/comparatorsmap.properties</code> resource files. 
-</p>
-</subsection>
-<subsection name='Building jSieve'>
-<p>
-jSieve uses <a href='http://ant.apache.org'>Ant</a>. <code>ant -projecthelp</code>
-describes appropriate targets. <code>ant</code> runs the default target.
-</p>
-</subsection>
-</section>
+    <body>
+        <section name="Getting Started">
+            <p>Until these pages are fleshed out, the best way to understand jSieve is read the
+                <a href='apidocs/index.html'>Javadocs</a>
+                and look at the <a href='xref/index.html'>source code</a>.
+                The jUnit tests illustrate many aspects
+                of the implementation.
+            </p>
+            <subsection name='Using jSieve'>
 
-<section name="Comments, Questions and Issues">
-<p>jSieve is a sub-project of Apache James. Please direct your comments and questions
-to the relevant James list.
-</p>
-<p>To report issues, such as bugs, go to the
-<a href="https://issues.apache.org/jira/browse/JSIEVE">jSieve Issue Tracker</a>.
-As jSieve comes with a fairly extensive suite of jUnit Tests, it would be most 
-helpful for bug reports to be accompanied by an illustrative jUnit test case.
-</p>
-<section name='Frequently Asked Question'>
-    <section name='Why Do Tests Using Non-ASCII Characters Fail?'>
-        <p>
-<code>SIEVE</code> specifies that <a href='http://ietf.org/rfc/rfc2278.txt'>UTF-8</a> 
-encoding is used for scripts. This format is an international standard and has wide 
-support but not all platforms use this encoding by default. 
-        </p>
-        <p>
-By default, JSieve expects that scripts are encoding using <code>UTF-8</code>.
-Either set the encoding programmatically or ensure that the script is encoded using
-<code>UTF-8</code>.
-        </p>
-    </section>
-</section>
-</section>
-</body>
+                <subsection name='Standalone'>
+                    <p>
+                        <a href='xref/org/apache/jsieve/SieveFactory.html'>
+                            <code>org.apache.jsieve.SieveFactory</code></a> is the primary invocation
+                        point for all Sieve operations. The API is clean and simple.
+                        See the
+                        <a href='apidocs/index.html'>javadocs</a> for more details.
+                    </p>
+                </subsection>
+                <subsection name='In JAMES'>
+                    <p>
+                        The <code>SieveToMultiMailbox</code> mailet is included in JAMES.
+                        It is integrated with the message delivery spool and provides per-user
+                        Sieve scripting using jSieve.
+                    </p>
+                </subsection>
+            </subsection>
+            <subsection name='Implementing A Mail Adapter'>
+                <p>
+                    <a href='xref/org/apache/jsieve/mail/MailAdapter.html'>
+                        <code>org.apache.jsieve.mail.MailAdapter</code></a> is the interface API used
+                    by jSieve to interact with a mail server.
+                </p><p>
+                The mail adapter wraps an email
+                and supplies information (required by the script) about the email. It is
+                responsible for accumulating <code>Action</code>s during the parsing of a
+                script and for executing them once the parsing is complete.
+            </p><p>
+                See the
+                <a href='apidocs/index.html'>javadocs</a> for more details and this
+                <a href='xref/org/apache/jsieve/samples/james/SieveMailAdapter.html'>sample</a>.
+            </p>
+            </subsection>
+            <subsection name='Creating A Custom Extension Command'>
+                <p>
+                    <a href='xref/org/apache/jsieve/commands/extensions/Log.html'>
+                        <code>org.apache.jsieve.commands.extensions.Log</code></a> is an example
+                    of a custom extension command. It is recommended that custom commands
+                    extend <a href='xref/org/apache/jsieve/commands/AbstractCommand.html'>
+                    <code>AbstractCommand</code></a>. See the
+                    <a href='apidocs/index.html'>javadocs</a> for more details.
+                </p><p>
+                Custom commands need to be registered with
+                <a href='xref/org/apache/jsieve/ConfigurationManager.html'>
+                    <code>ConfigurationManager</code></a> before they can be used. This
+                may be done programmatically but the recommended method is by altering
+                the <code>org/apache/jsieve/commandsmap.properties</code>, <code>org/apache/jsieve/testsmap.properties</code>
+                and <code>org/apache/jsieve/comparatorsmap.properties</code> resource files.
+            </p>
+            </subsection>
+            <subsection name='Building jSieve'>
+                <p>
+                    jSieve uses <a href='http://ant.apache.org'>Ant</a>. <code>ant -projecthelp</code>
+                    describes appropriate targets. <code>ant</code> runs the default target.
+                </p>
+            </subsection>
+        </section>
+
+        <section name="Comments, Questions and Issues">
+            <p>jSieve is a sub-project of Apache James. Please direct your comments and questions
+                to the relevant James list.
+            </p>
+            <p>To report issues, such as bugs, go to the
+                <a href="https://issues.apache.org/jira/browse/JSIEVE">jSieve Issue Tracker</a>.
+                As jSieve comes with a fairly extensive suite of jUnit Tests, it would be most
+                helpful for bug reports to be accompanied by an illustrative jUnit test case.
+            </p>
+            <section name='Frequently Asked Question'>
+                <section name='Why Do Tests Using Non-ASCII Characters Fail?'>
+                    <p>
+                        <code>SIEVE</code> specifies that <a href='http://ietf.org/rfc/rfc2278.txt'>UTF-8</a>
+                        encoding is used for scripts. This format is an international standard and has wide
+                        support but not all platforms use this encoding by default.
+                    </p>
+                    <p>
+                        By default, JSieve expects that scripts are encoding using <code>UTF-8</code>.
+                        Either set the encoding programmatically or ensure that the script is encoded using
+                        <code>UTF-8</code>.
+                    </p>
+                </section>
+            </section>
+        </section>
+    </body>
 </document>