KEP-0014.txt

[Georg Greve]

 KEP-0014.txt |   15 ++++++---------
 1 file changed, 6 insertions(+), 9 deletions(-)

New commits:
commit 13e091b2446c9f86ffd2414c985e7e271ed05a78
Author: Georg Greve <greve at kolabsys.com>
Date:   Wed Oct 12 22:34:15 2011 +0200

    Removed requirement on variables extension, which is not supported by Cyrus

diff --git a/KEP-0014.txt b/KEP-0014.txt
index 92de687..0037bfc 100644
--- a/KEP-0014.txt
+++ b/KEP-0014.txt
@@ -106,7 +106,7 @@ MASTER, [[#MANAGEMENT|MANAGEMENT]] and [[#USER|USER]] '''SHALL''' be receiving t
 MANAGEMENT is the script written by the management system of the platform, USER is the script intended for controling the execution of individual scripts by a user. General sieve editors available to users and platform management systems '''MUST NOT''' alter this script.
 
 === MANAGEMENT ===
-Management systems '''SHALL''' define the variables 'management_system' and 'management_system_version' to correspond to their name/platform and version somewhere in the MANAGEMENT script by using the Variables Extension according to {{rfc|5229}}<ref name="variables">{{rfc|5229|title=Sieve Email Filtering: Variables Extension}}</ref>.
+Management systems '''SHALL''' define the variables 'MANAGEMENT_SYSTEM' and 'MANAGEMENT_SYSTEM_VERSION' through comments '# MANAGEMENT_SYSTEM: <value>' and '# MANAGEMENT_SYSTEM_VALUES: <value>' in the comment block above the first Sieve script commands. 
 
 Otherwise management systems are free to write to each user's MANAGEMENT script as required and appropriate.
 
@@ -149,9 +149,9 @@ The order of entries '''SHALL''' always be preserved unless explicitly changed b
 === User specific scripts ===
 User specific scripts contain the actual Sieve commands as defined by the user through the editors. 
 
-When creating a new script, editor '''SHALL''' define the variables 'editor' and 'editor_version' to correspond to their name and version somewhere in the user specific script by using the Variables Extension according to {{rfc|5229}}<ref name="variables" />.
+When creating a new script, editor '''SHALL''' define the variables 'EDITOR' and 'EDITOR_VERSION' through comments '# EDITOR: <value>' and '# EDITOR_VERSION: <value>' in the comment block above the first Sieve script commands. 
 
-When parsing an existing script, editor '''SHALL''' parse for the variables 'editor' and 'editor_version' and based on their values behave as follows:
+When parsing an existing script, editor '''SHALL''' parse for the variables 'EDITOR' and 'EDITOR_VERSION' and based on their values behave as follows:
 * '''Same editor, same version'''
 : If the variables are set and match their name and version, editor '''SHALL''' parse the script as usual and present it to the user for display/editing as required.
 * '''Same editor, different version'''
@@ -191,9 +191,9 @@ A manual script example:
 The same script as an explicit '''read only, do not touch''' script:
 
   # Spam Rules, manually defined
-  require ["variables", "fileinto", "comparator-i;ascii-numeric", "imapflags", "regex"];
-  set "editor" "READONLY"; 
-  set "editor_version" "NONE"; 
+  # EDITOR: READONLY
+  # EDITOR_VERSION: NONE
+  require ["fileinto", "comparator-i;ascii-numeric", "imapflags", "regex"];
  
   if anyof ( not exists ["From","Date"],
            header :comparator "i;ascii-casemap" :contains "X-Spam-Level" "*****",
@@ -204,7 +204,6 @@ The same script as an explicit '''read only, do not touch''' script:
   }
 
 === Protected Names ===
-
 All protected names '''SHALL''' be protected in their basename and all extensions, e.g. the listing of MASTER in the table below '''MUST''' be read to also protect MASTER.sieve, MASTER.siv explicitly, and more generally MASTER.*.
 
 Protected names under this KEP '''SHALL''' be
@@ -214,8 +213,6 @@ Protected names under this KEP '''SHALL''' be
 
 All considerations of protected names '''SHALL''' be case-insensitive, e.g. MASTER, master, mAster and Master are '''all''' considered protected names regardless of their extension (if any). 
 
-
-
 == Upgrade Path ==
 
 This KEP introduces new conventions.