Author: rdonkin
Date: Thu Apr 9 09:23:14 2009
New Revision: 763575
URL: http://svn.apache.org/viewvc?rev=763575&view=rev
Log:
Document progress on sieve-in-xml JSIEVE-50
https://issues.apache.org/jira/browse/JSIEVE-50
Added:
james/jsieve/trunk/util/src/main/java/org/apache/jsieve/util/package.html
(with props)
Modified:
james/jsieve/trunk/src/site/xdoc/index.xml
james/jsieve/trunk/util/src/main/java/org/apache/jsieve/util/OutputUtils.java
james/jsieve/trunk/util/src/site/xdoc/index.xml
Modified: james/jsieve/trunk/src/site/xdoc/index.xml
URL:
http://svn.apache.org/viewvc/james/jsieve/trunk/src/site/xdoc/index.xml?rev=763575&r1=763574&r2=763575&view=diff
==============================================================================
--- james/jsieve/trunk/src/site/xdoc/index.xml (original)
+++ james/jsieve/trunk/src/site/xdoc/index.xml Thu Apr 9 09:23:14 2009
@@ -77,6 +77,16 @@
</p>
</subsection>
</section>
+ <section name='Extensions Supported'>
+ <subsection name='Sieve-In-Xml'>
+ <p>
+ <a href='http://tools.ietf.org/html/draft-freed-sieve-in-xml-04'
rel='tag'>Sieve-in-xml</a> is an Internet Draft.
+ It describes a method for converting Sieve scripts to and from XML
fragments.
+ <a href='util/index.html'>JSieve Utilities</a> contains an experimental
preview of a subset of this draft
+ to allow early feedback. <a href='util/index.html#Sieve In Xml'>More...</a>
+ </p>
+ </subsection>
+ </section>
<section name="News">
<subsection name="2008">
<h4>Aug/2008 - jSieve-0.2 released</h4>
Modified:
james/jsieve/trunk/util/src/main/java/org/apache/jsieve/util/OutputUtils.java
URL:
http://svn.apache.org/viewvc/james/jsieve/trunk/util/src/main/java/org/apache/jsieve/util/OutputUtils.java?rev=763575&r1=763574&r2=763575&view=diff
==============================================================================
---
james/jsieve/trunk/util/src/main/java/org/apache/jsieve/util/OutputUtils.java
(original)
+++
james/jsieve/trunk/util/src/main/java/org/apache/jsieve/util/OutputUtils.java
Thu Apr 9 09:23:14 2009
@@ -32,8 +32,13 @@
public class OutputUtils {
/**
- * Writes the given node as xml.
+ * <p>Writes the given node as xml.
* This convenience method first writes a prolog before calling {...@link
#toXml(Node, Writer)}.
+ * </p><p>
+ * The output format is a subset of the
+ * <a
href='http://tools.ietf.org/html/draft-freed-sieve-in-xml-04'>sieve-in-xml</a>
+ * Internet Draft.
+ * </p>
* @param node not null
* @param writer not null
* @throws IOException when prolog cannot be written
@@ -46,10 +51,15 @@
}
/**
- * Writes the given node as xml.
+ * <p>Writes the given node as xml.
* Note that the xml will be written as a fragment.
* An appropriate prolog must be added to convert this fragment
* to a document.
+ * </p><p>
+ * The output format is a subset of the
+ * <a
href='http://tools.ietf.org/html/draft-freed-sieve-in-xml-04'>sieve-in-xml</a>
+ * Internet Draft. Note that this support is experimental.
+ * </p>
* @param node not null
* @param writer not null
* @throws SieveException when script cannot be converted to xml
Added: james/jsieve/trunk/util/src/main/java/org/apache/jsieve/util/package.html
URL:
http://svn.apache.org/viewvc/james/jsieve/trunk/util/src/main/java/org/apache/jsieve/util/package.html?rev=763575&view=auto
==============================================================================
--- james/jsieve/trunk/util/src/main/java/org/apache/jsieve/util/package.html
(added)
+++ james/jsieve/trunk/util/src/main/java/org/apache/jsieve/util/package.html
Thu Apr 9 09:23:14 2009
@@ -0,0 +1,34 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<HTML>
+<HEAD>
+<!--
+
+ @(#)package.html
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+</HEAD>
+<BODY>
+
+<p>Useful utilities for Sieve.</p>
+<p>The general design approach has been to create finely grained flexible
POJOs,
+and then use coursely grained static utilities (<code>XYZUtils</code>) to
offer
+an easy interface to recommended defaults.</p>
+</BODY>
+</HTML>
\ No newline at end of file
Propchange:
james/jsieve/trunk/util/src/main/java/org/apache/jsieve/util/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Modified: james/jsieve/trunk/util/src/site/xdoc/index.xml
URL:
http://svn.apache.org/viewvc/james/jsieve/trunk/util/src/site/xdoc/index.xml?rev=763575&r1=763574&r2=763575&view=diff
==============================================================================
--- james/jsieve/trunk/util/src/site/xdoc/index.xml (original)
+++ james/jsieve/trunk/util/src/site/xdoc/index.xml Thu Apr 9 09:23:14 2009
@@ -25,15 +25,17 @@
</properties>
<body>
-<section name="What is jSieve?">
+<section name="Introduction">
<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>
-Sieve Utilities a collection of lightweight frameworks and utilities useful
when
-working with <a href='../main/'>JSieve</a>.
+</p>
+<p>
+JSieve Utilities collects lightweight frameworks and utilities useful when
+working with Sieve (in general) and
+<a href='http://james.apache.org/jsieve'>JSieve</a> (in particular).
</p>
<subsection name='What is Sieve?'>
<p>
@@ -49,5 +51,25 @@
</p>
</subsection>
</section>
+<section name='Highlights'>
+ <subsection name='Script Checker'>
+ <p>
+ Checks Sieve scripts. Includes monitoring controlled execution of a
script against a message.
+ </p>
+ </subsection>
+ <subsection name='Sieve In Xml'>
+ <p>
+ <a href='http://tools.ietf.org/html/draft-freed-sieve-in-xml-04'
rel='tag'>Sieve-in-xml</a> is an
+ <a href='http://dbpedia.org/resource/Internet_Draft' rel='tag'>Internet
Draft</a>.
+ It describes a method to convert Sieve scripts to and from an XML format
suitable
+ for editing by a UI. A typical use case is as the payload for a web based
editor backed by web services.
+ </p><p>
+ <code>OutputUtils</code> contains an experimental preview of a subset of
this draft. It allows a
+ JSieve node tree to be output as sieve-in-xml. Full support is planned but
feedback is
+ encouraged, through the <a
href='http://james.apache.org/mail.html'>mailing lists</a>
+ or the <a href='http://issues.apache.org/jira/browse/JSIEVE'>issue
tracker</a>.
+ </p>
+ </subsection>
+</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
