ietf-mta-filters
[Top] [All Lists]

[draft-freed-sieve-in-xml-02] Minor Improvements

2009-01-30 11:56:05

(Some minor suggestions, typos, etc. I've batched these up since they
are not substantial.)

In "3. Grammatical structure of Sieve"
======================================
Original
--------
   Finally, comments are allowed between lexical elements in a Sieve
   script.  It is very important that comments be preserved in the XML
   representation.

Comment
-------
This is covered later but perhaps a little justification should be
offered at this point for the last remark

Suggested
---------
   Finally, comments are allowed between lexical elements in a Sieve
   script. One important use case for comments is encoding meta-data
   about the script, a facility which is lacking in the Sieve language.
   Therefore comments should be preserved in the XML representation.


In "4.1. XML Display Directives"
================================
Original
--------
   However, such information can be represented in XML very easily so it
   makes sense to define a framework to do this as part of the XML
   format.  Implementations may choose to use structured comments to
   retain this information when the script is converted to normal Sieve
   format.

Comment
-------
I think "may" should be "MAY"

Suggested
---------
   However, such information can be represented in XML very easily so it
   makes sense to define a framework to do this as part of the XML
   format.  Implementations MAY choose to use structured comments to
   retain this information when the script is converted to normal Sieve
   format.


In "4.2. Structured Comments"
=============================
Original
--------
   2.  Displaydata elements are placed in Sieve bracketed comments
       begining with the string "/* [|" and ending with the string "|]
       */".

Comments
--------
Typo (begining)
Easier to read when quoted text is not split

Suggested
---------
   2.  Displaydata elements are placed in Sieve bracketed comments
       beginning with the string "/* [|" and ending with the string
       "|] */".

Original
--------
   3.  The begininng of a displayblock element is mapped to a bracketed
       Sieve comment beginning with the string "/* [*" which then lists
       any displayblock attribute names and values in XML format.  The
       end of a displaydata element is mapped to a comment of the form
       "/* *] */".

Comments
--------
Typo (begininng)

Suggested
---------
   3.  The beginning of a displayblock element is mapped to a bracketed
       Sieve comment beginning with the string "/* [*" which then lists
       any displayblock attribute names and values in XML format.  The
       end of a displaydata element is mapped to a comment of the form
       "/* *] */".

<Prev in Thread] Current Thread [Next in Thread>