Changeset 12926 for main/waeup.kofa/trunk/docs/source/userdocs/users.rst

Timestamp:

12 May 2015, 15:19:10 (9 years ago)

Author:

Henrik Bettermann

Message:

Enable temporary suspension of officer accounts. Plugins must be updated after restart.

File:

• main/waeup.kofa/trunk/docs/source/userdocs/users.rst (modified) (1 diff)

main/waeup.kofa/trunk/docs/source/userdocs/users.rst

@@ -52 +52 @@
    :ref:`Officers Doctests <userscontainer_txt>`
 
-Officers are users with a dedicated user account object stored in
-the ``users`` container (of type :py:class:`UsersContainer
-<waeup.kofa.userscontainer.UsersContainer>`) which is located in
-Kofa's root container. The officer account object has two more
-attributes than the principal instance which is created from the
-account data: (1) a `roles` attribute which is a list of global role
-names assigned to the officer, and (2) a private `_local_roles`
-attribute. The latter maps local role names to lists of objects the
-respective local role applies to. This information is important
-because local role assignment is originally stored only with the
-objects the role applies to and not with the user who got the role.
-When removing a user, Kofa iterates over the mapping and the list of
-objects in order to remove all these local role assignments denoted
-in the mapping.
+Officers are users with a dedicated user account object stored in the
+``users`` container (of type :py:class:`UsersContainer
+<waeup.kofa.userscontainer.UsersContainer>`) which is located in Kofa's root
+container. The account object has three more attributes than the principal
+instance which is created from the account data: (1) a `suspended` attribute
+which allows to deactivate an account, (2) a `roles` attribute which is a list
+of global role names assigned to the officer, and (3) a private `_local_roles`
+attribute which maps local role names to lists of objects the respective local
+role applies to. This information is important because local role assignment
+is originally stored only with the objects the role applies to and not with
+the user who got the role. When removing an officer, Kofa iterates over the
+mapping and the list of objects in order to remove all these local role
+assignments denoted in the mapping.
 
 The management of portal officers is done in the 'Officers' section
-of Kofa. The management page shoes all officers registered in the
+of Kofa. The management page shows all officers registered in the
 portal together with their global and local roles. The table can be
-easily sorted or filtered.
+easily sorted or filtered. Deactivated officer accounst are marked
+``(suspended)``.