Changes between Version 1 and Version 2 of ExtraPermissionsProvider

Timestamp:

Jun 3, 2011, 10:03:45 AM (12 years ago)

Author:

Peter Suter

Comment:

Add documentation from source docstring

ExtraPermissionsProvider

@@ -1 +1 @@
 == [source:trunk/tracopt/perm/config_perm_provider.py tracopt.perm.config_perm_provider.ExtraPermissionsProvider]
 
-Optional component which makes it possible to easily add new permissions using an `[extra-permissions]` section in the TracIni.
+Optional component which makes it possible to easily add new permissionsto to a Trac environment. These can be used for example in configurable TracWorkflow``s, when one wants to add a permission specific to a transition, via the `.permissions` key.
 
-This can be used for example in configurable TracWorkflow``s, when one wants to add a permission specific to a transition, via the `.permissions` key.
+To add new permissions, create a new section `[extra-permissions]` in [TracIni#extra-permissions-section trac.ini]. Every entry in that section defines a meta-permission and a comma-separated list of permissions. For example:
+{{{
+[extra-permissions]
+extra_admin = extra_view, extra_modify, extra_delete
+}}}
+This entry will define three new permissions `EXTRA_VIEW`, `EXTRA_MODIFY` and `EXTRA_DELETE`, as well as a meta-permissions `EXTRA_ADMIN` that grants all three permissions.
 
-See also: #9392.
+If you don't want a meta-permission, start the meta-name with an underscore (`_`):
+{{{
+[extra-permissions]
+_perms = extra_view, extra_modify
+}}}
+
+
+See also: #9392, [source:trunk/tracopt/perm/config_perm_provider.py#L18 config_perm_provider.py]