Skip to content

Commit

Permalink
Documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
adaptivelogic committed Oct 22, 2012
1 parent a04946f commit e398ea1
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 27 deletions.
8 changes: 4 additions & 4 deletions docs/advanced/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,15 +58,15 @@ It has two subcommands:


******************
Moderator commands
Moderation commands
******************

``cms moderator``
=================

If you turn :setting:`CMS_MODERATOR` to ``True`` on an existing project, you
should use the ``cms moderator on`` command to make the required changes in the
database, otherwise you will have problems with invisible pages.
If you migrate from an earlier version, you should use the ``cms moderator on``
command to ensure that your published pages are up to date, whether or not you
used moderation in the past.

.. warning::

Expand Down
4 changes: 2 additions & 2 deletions docs/extending_cms/api_references.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Functions and constants
:param boolean grant_all: Grant all permissions to the user


.. function:: assign_user_to_page(page, user, grant_on=ACCESS_PAGE_AND_DESCENDANTS, can_add=False, can_change=False, can_delete=False, can_change_advanced_settings=False, can_publish=False, can_change_permissions=False, can_move_page=False, can_moderate=False, grant_all=False)
.. function:: assign_user_to_page(page, user, grant_on=ACCESS_PAGE_AND_DESCENDANTS, can_add=False, can_change=False, can_delete=False, can_change_advanced_settings=False, can_publish=False, can_change_permissions=False, can_move_page=False, grant_all=False)

Assigns a user to a page and gives them some permissions. Returns the
:class:`cms.models.permissionmodels.PagePermission` object that gets
Expand All @@ -132,7 +132,7 @@ Functions and constants
:param user: The user to assign to the page
:type user: :class:`django.contrib.auth.models.User` instance
:param grant_on: Controls which pages are affected
:type grant_on: :data:`cms.models.moderatormodels.ACCESS_PAGE`, :data:`cms.models.moderatormodels.ACCESS_CHILDREN`, :data:`cms.models.moderatormodels.ACCESS_DESCENDANTS` or :data:`cms.models.moderatormodels.ACCESS_PAGE_AND_DESCENDANTS`
:type grant_on: :data:`cms.models.permissionmodels.ACCESS_PAGE`, :data:`cms.models.permissionmodels.ACCESS_CHILDREN`, :data:`cms.models.permissionmodels.ACCESS_DESCENDANTS` or :data:`cms.models.permissionmodels.ACCESS_PAGE_AND_DESCENDANTS`
:param can_*: Permissions to grant
:param boolean grant_all: Grant all permissions to the user

Expand Down
21 changes: 0 additions & 21 deletions docs/getting_started/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -477,27 +477,6 @@ Default: ``all``
Decides if pages without any view restrictions are public by default or staff
only. Possible values are ``all`` and ``staff``.

.. setting:: CMS_MODERATOR

CMS_MODERATOR
=============

Default: ``False``

If set to ``True``, gives you a new "moderation" column in the tree view.

You can select to moderate pages or whole trees. If a page is under moderation
you will receive an email if somebody changes a page and you will be asked to
approve the changes. Only after you approve the changes will they be updated
on the "live" site. If you make changes to a page you moderate yourself, you
will need to approve it anyway. This allows you to change a lot of pages for
a new version of the site, for example, and go live with all the changes at the
same time.

.. note:: When switching this value to ``True`` on an existing site, you have
to run the ``cms moderator on`` command to make the required database
changes.

.. setting:: CMS_SHOW_START_DATE
.. setting:: CMS_SHOW_END_DATE

Expand Down
8 changes: 8 additions & 0 deletions docs/upgrade/2.4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,14 @@ CMS_FLAT_URLS

Was marked deprecated in 2.3 and has now been removed.

CMS_MODERATOR
=============
Has been deprecated since it is no longer in use. From 2.4 onwards, all pages
exist in a public and draft version. Users with the ``publish_page`` permission
can publish changes to the public site.

To ensure that a site that was set up using a previous version is up to date,
run ``manage.py moderator on``.

..
Feature description
Expand Down

0 comments on commit e398ea1

Please sign in to comment.