starting permission docs

This commit is contained in:
Leo Germani 2018-02-20 23:01:38 -03:00
parent 9bba1b560d
commit 8b8ff5e400
1 changed files with 121 additions and 0 deletions

121
docs/permissions.md Normal file
View File

@ -0,0 +1,121 @@
# Tainacan Users Permissions
This page explains how permissions are handled in Tainacan. What are the users roles available and what each one of them can do.
Tainacan handles user permissions in the very same way WordPress does, so if you are used to WordPress Roles and Permissions, you wont have any trouble.
Default WordPress roles are assigned with new capabilities to work with Collections, Items and other Tainacan specific operations. Additionaly Tainacan creates new roles, relative to the core WordPress roles, that have the same Tainacan specific capabilities, but dont have acces to the rest of the administrative panel of WordPress. For example, WordPress Editor can manage everything inside Tainacan, and they can also create and publish pages, in the other hand, Tainacan Editors can't.
If you want to change permissions for specific roles or users, or even create new roles, you can allways use one of the many WordPress plugins available for that.
In short, these are the roles and their main characteristics. A detailed description can be found in the next session.
* Subscriber: Can't really do anything inside tainacan.
* Colaborator / Tainacan Colaborator: Can create items, but not to publish them.
* Author / Tainacan Author: Can create and publish items, but can not edit published items nor edit other user's items.
* Editor / Tainacan Editor: Can create, publish and edit other users's items.
* Administrator: Rules the world.
## Roles and permissions
Here you will find a detailed explanation of what each role can do with each part of Tainacan.
### Collections
These are the capabilities related to collection management.
**Note about Collection moderators**: Collection moderators have the same capabilities an editor has, but only in relation to the collections he or she is moderating. Even if the user is a subscriber, he will act as if he/she was an editor for that specific collection.
| | Admin | Editor | Author | Collaborator |
|------------------------------|-------|--------|--------|--------------|
| Edit Collections | y | y | y | y |
| Delete Collections | y | y | y | y |
| Publish Collections | y | y | y | |
| Edit Published Collections | y | y | y | |
| Delete Published Collections | y | y | y | |
| Edit Others Collections | y | y | | |
| Delete Others Collections | y | y | | |
| Read Private Collections | y | y | | |
| Edit Private Collections | y | y | | |
| Delete Private Collections | y | y | | |
#### Edit Collections
> Capability name: edit_tainacan-collections
Who's got it: Everyone but subscribers
Allows to create and edit one's own collections. Does not allow to publish them.
#### Edit Others Collections
> Capability name: edit_others_tainacan-collections
Who's got it: Administrators, Editors and Tainacan Editors
Allows to edit other user's Collections (and items)
#### Edit Published Collections
> Capability name: edit_published_tainacan-collections
Who's got it: Administrators, Editors and Tainacan Editors
Allows to edit collections details after it was published
#### Edit Private Collections
> Capability name: edit_private_tainacan-collections
Who's got it: Administrators, Editors and Tainacan Editors
Allows to edit collections marked as private
#### Publish Collections
> Capability name: publish_tainacan-collections
Who's got it: Administrators, Editors, Tainacan Editors, Authors and Tainacan Authors
Allows to edit collections marked as private
#### Delete Collections
> Capability name: delete_tainacan-collections
Who's got it: Everyone but subscribers
Allows to delete one's own collections.
#### Delete Others Collections
> Capability name: delete_others_tainacan-collections
Who's got it: Administrators, Editors and Tainacan Editors
Allows to delete other user's Collections (and items)
#### Delete Published Collections
> Capability name: delete_published_tainacan-collections
Who's got it: Administrators, Editors and Tainacan Editors
Allows to delete collections after it was published
#### Delete Private Collections
> Capability name: delete_private_tainacan-collections
Who's got it: Administrators, Editors and Tainacan Editors
Allows to delete collections marked as private
#### Read Private Collections
> Capability name: read_private_tainacan-collections
Who's got it: Administrators, Editors and Tainacan Editors
Allows to view collections marked as private and its items.
### Items
### Categories
### Fields
### Filters