Changes between Version 37 and Version 38 of RowLevelPermissions

Timestamp:

Nov 23, 2006, 10:07:07 PM (18 years ago)

Author:

Adrian Holovaty

Comment:

Finished editing the page

RowLevelPermissions

@@ -163 +163 @@
 }}}
 
-Row-level permissions can be edited in the admin interface, on the change form for each object with row-level permissions enabled is a link beside History to edit row level permissions. To edit row level permissions, you must have the change RLP permission and change permission on the object. To add row level permissions, you must have the add RLP permisison and change permission on the object.
-
-By default, all instances of a model are shown to a user when they access the change list for a model. To turn off this behaviour, you must set the ''show_all_rows'' admin option to false. Doing this will increase the number of database queries made to the server, which is why the default option is that all rows are shown. An example:
-
-{{{
-#!python
-...
+Row-level permissions can be edited in the admin interface. On the change form for each object with row-level permissions enabled is a link beside History to edit row-level permissions. To edit row-level permissions, you must have the "change RLP" permission ''and'' change permission on the object. To add row-level permissions, you must have the "add RLP" permisison ''and'' change permission on the object.
+
+By default, all instances of a model are shown to a user when they access the change list for a model. To turn off this behavior, set the {{{show_all_rows}}} {{{class Admin}}} option to {{{False}}}. Doing this will increase the number of database queries made to the server, which is why the default option is that all rows are shown. Example:
+
+{{{
+#!python
 class Mineral(models.Model):
-...    
+    # ...
     class Admin:
         show_all_rows = False
@@ -177 +176 @@
     class Meta:
         row_level_permissions = True
-...
-}}}
-
-=== Accessing Row Level Permissions from a Model ===
-
-The relation name for row level permissions from a model is "row_level_permissions", this will return all row level permissions related to the instance of the object. For example, this will return all row level permissions related to the object quartz:
-{{{
-#!python
-...
+}}}
+
+=== Accessing row-level permissions from a model ===
+
+Use the {{{row_level_permissions}}} attribute on a model object to retrieve all row-level permissions related to the instance of the object. For example, this will return all row-level permissions related to the object {{{quartz}}}:
+
+{{{
+#!python
 rlp_list = quartz.row_level_permissions.all()
-...
-}}}
-
-=== Accessing the Owner and Model of a Row Level Permission ===
-
-To return the owner of a row level permission use the attribute "owner". For example:
-{{{
-#!python
-...
+}}}
+
+=== Accessing the owner and model of a row-level permission ===
+
+To return the owner of a row-level permission, use the {{{owner}}} attribute. For example:
+
+{{{
+#!python
 user = row_level_permission.owner
-...
-}}}
-
-To return the instance of a row level permission use the attribute "model". For example:
-{{{
-#!python
-...
+}}}
+
+To return the instance of a row-level permission, use the {{{model}}} attribute. For example:
+
+{{{
+#!python
 object = row_level_permission.model
-...
-}}}
-
-== Implementation Notes ==
-
-Please see RowLevelPermissionsDeveloper for more information on how row level permissions are implemented.
-
-== Known Bugs ==
- * Connecting more then one "owner" to the RLP model causes a M2M conflict, this is a bug with the generic relation code. Work around for now is to rename the related_name for each different owner. - ''This is a bug with generic relations, see ticket #2573''
- * Row level permissions can not have row level permissions enabled
- * Error message in admin interface is displayed with a checkmark not an error icon
-
-
-== Download ==
-
-Row Level Permissions are currently hosted in a branch on Django SVN. Please use: ''svn co http://code.djangoproject.com/svn/django/branches/per-object-permissions'' to download the current code.
+}}}
+
+== Implementation notes ==
+
+Please see RowLevelPermissionsDeveloper for more information on how row-level permissions are implemented.
+
+== Known bugs ==
+
+ * Connecting more then one "owner" to the RLP model causes a many-to-many conflict. This is a bug with the generic relation code. The workaround for now is to rename the {{{related_name}}} for each different owner. (See ticket #2573 for the bug with generic relations.)
+ * Row-level permission objects cannot have row-level permissions enabled.
+ * The error message in the admin interface is displayed with a checkmark, not an error icon.
 
 == Contact ==
 
-If there are any problems, please contact myself Chris at indirecthit[at]gmail.com
+If there are any problems, please contact Chris, the branch maintainer, at indirecthit [at] gmail.com.