Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.rst #45

Merged
merged 3 commits into from
Sep 3, 2019
Merged

Update README.rst #45

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8401e6
Update README.rst
geoidesic Feb 12, 2019
639c2da
Update README.rst
geoidesic Feb 12, 2019
f809250
Update README.rst
geoidesic Feb 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 19 additions & 13 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
****************

******************************
django CMS Version Locking
****************
******************************

## Explanation
The version-locking addon is intended to modify the way djangocms-versioning works.
* The primary change is that it locks a version to its author when a draft is created.
* That version becomes automatically unlocked again once it is published.
* The lock prevents editing of the file by anyone other than the author.
* Locks can be removed by a user with the correct permission
* Unlocking an item sends a notification to the author to which it was locked.
* Manually unlocking a version does not lock it to the unlocking user, nor does it change the author.
* The Version admin view for each content-type registered with Version-locking will be edited to add in lock icons / buttons UI to the Actions column.
Explanation
------------
The version-locking addon is intended to modify the way djangocms-versioning works in the following way:

- The primary change is that it locks a version to its author when a draft is created.
Aiky30 marked this conversation as resolved.
Show resolved Hide resolved
- That version becomes automatically unlocked again once it is published.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure how a published version could be locked? I mean AFAIK a published version cannot be edited even without locking (if a draft version doesn't exist the edit button actually creates a new version).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well. Draft versions are locked. If we didn't remove the lock when publishing, then it would stay locked.

- The lock prevents editing of the file by anyone other than the author.
- Locks can be removed by a user with the correct permission
Aiky30 marked this conversation as resolved.
Show resolved Hide resolved
- Unlocking an item sends a notification to the author to which it was locked.
- Manually unlocking a version does not lock it to the unlocking user, nor does it change the author.
- The Version admin view for each content-type registered with Version-locking will be edited to add in lock icons / buttons UI to the Actions column.
Aiky30 marked this conversation as resolved.
Show resolved Hide resolved

## Installation
Installation
------------
The package djangocms-versioning and djangocms-moderation need to be installed for this project to function correctly.

## Configuration

Configuration
-------------
Aiky30 marked this conversation as resolved.
Show resolved Hide resolved
Version-locking makes use of the django-cms 4.x App Registration mechanism to allow models from other addon's (i.e. content-types) to be registered for use with version-locking.
`®`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

®?