changeset 4874:7b181a7e35b2

groups/dicts: improved docs/CHANGES and snippets
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Tue, 21 Jul 2009 21:11:57 +0200
parents eb86881788ce
children 28077e7631a7
files docs/CHANGES wiki/config/more_samples/dicts_wikiconfig_snippet wiki/config/more_samples/groups_wikiconfig_snippet
diffstat 3 files changed, 40 insertions(+), 38 deletions(-) [+]
line wrap: on
line diff
--- a/docs/CHANGES	Tue Jul 21 17:51:56 2009 +0200
+++ b/docs/CHANGES	Tue Jul 21 21:11:57 2009 +0200
@@ -16,36 +16,7 @@
     editor_force = True
     editor_default = 'text'  # internal default, just for completeness
 
-Version 1.9-groups-dmilajevs:
-
-   New features:
-   * Group and dict backends.
-     * WikiGroups and WikiDicts backends get data from wikipages. They
-       work similar to old wikidicts code.
-     * ConfigGroups and ConfigDicts backends get data from a
-       dictionary defined in a configuration file.
-     * CompositeGroups and CompositeDicts compose several backens,
-       so data may be retrieved from several sources. For example,
-       groups may be defined in configuration file and in wiki pages.
-   * cfg.groups is new and by default initializes wiki_groups backend.
-     See wiki/config/more_samples/groups_wikiconfig_snippet.
-   * cfg.dicts is new and by default initializes wiki_dicts backend.
-     See wiki/config/more_samples/groups_wikiconfig_snippet.
-   * http://master19.moinmo.in/HelpOnDictionaries was updated.
-   * New help page http://master19.moinmo.in/HelpOnGroups
-
-   Developer notes:
-   * request.groups provides access to groups.
-   * request.dicts provides access to dicts.
-   * Removed MoinMoin.wikidicts module. It was refactored and became
-     MoinMoin.datastruct.
-   * LazyGroup and LazyGroupsBackend base classes for implementing
-     backends which deal with huge amount of data. (Like LDAP
-     directory). Use MoinMoin/datastruct/backends/config_lazy_groups.py
-     as a draft for new  backends.
-   * See http://moinmo.in/Groups2009 for more details.
-
-Version 1.9.0beta2:
+Version 1.9.0.current:
 
   Please note:
   * This is a BETA version, not meant for production usage, but just to
@@ -59,6 +30,37 @@
     Please see http://master19.moinmo.in/ and help cleaning up there.
 
   New features:
+  * New modular group and dict data access, you can use group and dict 
+    backend modules to access group and dict data stored anywhere you like.
+    Currently we provide these backends:
+      * WikiGroups and WikiDicts backends get data from wikipages. They work
+        similar to old wikidicts code (but with less caching issues :).
+      * ConfigGroups and ConfigDicts backends get data from a dictionary
+        defined in the wiki config.
+      * CompositeGroups and CompositeDicts compose several backends, so data
+        may be retrieved from several sources. For example, groups may be
+        defined in the wiki config and on wiki pages.
+    * Using cfg.groups and cfg.dicts, you can define the backend to use to
+      access group and dict information (default: WikiGroups / WikiDicts
+      backend).
+      See wiki/config/more_samples/ directory (groups_wikiconfig_snippet and
+      dicts_wikiconfig_snippet).
+    * See also the new HelpOnDictionaries and HelpOnGroups help pages.
+
+  Developer notes:
+  * groups and dicts API changes:
+    * request.groups and request.dicts provide access to groups and dicts.
+    * MoinMoin.wikidicts is gone, please use MoinMoin.datastruct.
+    * LazyGroup and LazyGroupsBackend base classes for implementing backends
+      which potentially deal with huge amounts of data (like a LDAP directory).
+      Use MoinMoin/datastruct/backends/config_lazy_groups.py as a draft for
+      new backends.
+    * See http://moinmo.in/Groups2009 for more details.
+
+
+Version 1.9.0beta2:
+
+  New features:
   * Added modernized_cms theme (hides most wiki widgets from modernized if the
     user is not logged in).
   * Static file serving built-in (moved wiki/htdocs to MoinMoin/web/static/htdocs).
--- a/wiki/config/more_samples/dicts_wikiconfig_snippet	Tue Jul 21 17:51:56 2009 +0200
+++ b/wiki/config/more_samples/dicts_wikiconfig_snippet	Tue Jul 21 21:11:57 2009 +0200
@@ -1,12 +1,12 @@
-    # This is a sample configuration snippet that shows moin's dicts configuration
+    # This is a sample configuration snippet that shows moin's dicts configuration.
     # See HelpOnConfiguration for more info.
 
-    # The wiki_dicts backend is used by default.
+    # WikiDicts backend gets dicts from wiki pages and is used by default.
     def dicts(self, request):
         from MoinMoin.datastruct import WikiDicts
         return WikiDicts(request)
 
-    # Use only dicts defined in the configuration file.
+    # ConfigDicts backend uses dicts defined in the configuration file.
     def dicts(self, request):
         from MoinMoin.datastruct import ConfigDicts
         dicts = {u'OneDict': {u'first_key': u'first item',
@@ -15,7 +15,7 @@
                                   u'2': 'Two'}}
         return ConfigDicts(request, dicts)
 
-    # Use both config_dicts and wiki_dicts backends.
+    # CompositeDicts to use both ConfigDicts and WikiDicts.
     def dicts(self, request):
         from MoinMoin.datastruct import ConfigDicts, WikiDicts, CompositeDicts
         dicts = {u'OneDict': {u'first_key': u'first item',
--- a/wiki/config/more_samples/groups_wikiconfig_snippet	Tue Jul 21 17:51:56 2009 +0200
+++ b/wiki/config/more_samples/groups_wikiconfig_snippet	Tue Jul 21 21:11:57 2009 +0200
@@ -1,12 +1,12 @@
-    # This is a sample configuration snippet that shows moin's groups configuration
+    # This is a sample configuration snippet that shows moin's groups configuration.
     # See HelpOnConfiguration for more info.
 
-    # The wiki_groups backend is used by default.
+    # WikiGroups backend gets groups from wiki pages and is used by default.
     def groups(self, request):
         from MoinMoin.datastruct import WikiGroups
         return WikiGroups(request)
 
-    # Use only groups defined in the configuration file.
+    # ConfigGroups uses groups defined in the configuration file.
     def groups(self, request):
         from MoinMoin.datastruct import ConfigGroups
         # Groups are defined here.
@@ -14,7 +14,7 @@
                   u'AdminGroup': [u'Admin1', u'Admin2', u'John']}
         return ConfigGroups(request, groups)
 
-    # Use both config_groups and wiki_groups backends.
+    # CompositeGroups to use both ConfigGroups and WikiGroups backends.
     def groups(self, request):
         from MoinMoin.datastruct import ConfigGroups, WikiGroups, CompositeGroups
         groups = {u'EditorGroup': [u'AdminGroup', u'John', u'JoeDoe', u'Editor1'],