Permalink
Browse files

Merge pull request #1593 from ojii/document-cms-constants

added docs for cms.constants
  • Loading branch information...
2 parents fcde60c + fcd69f9 commit eb884c643004ab638407428d81bcaef8ac7600fd @digi604 digi604 committed Jan 17, 2013
Showing with 22 additions and 0 deletions.
  1. +13 −0 docs/extending_cms/api_references.rst
  2. +9 −0 docs/upgrade/2.4.rst
@@ -171,6 +171,19 @@ add a text plugin with the content ``'hello world'``. This is done in English::
add_plugin(placeholder, 'TextPlugin', 'en', body='hello world')
+*************
+cms.constants
+*************
+
+.. module:: cms.constants
+
+.. data:: TEMPLATE_INHERITANCE_MAGIC
+
+ The token used to identify when a user selects "inherit" as template for a
+ page.
+
+
+
***************
cms.plugin_base
***************
@@ -308,6 +308,15 @@ Should be replaced with the new API::
get_cms_setting('PLACEHOLDER_FRONTEND_EDITING')
+Added ``cms.constants`` module
+==============================
+
+This release adds the ``cms.constants`` module which will hold generic django
+CMS constant values. Currently it only contains ``TEMPLATE_INHERITANCE_MAGIC``
+which used to live in ``cms.conf.global_settings`` but was moved to the new
+``cms.constants`` module in the settings overhaul mentioned above.
+
+
******************************
Backwards incompatible changes
******************************

0 comments on commit eb884c6

Please sign in to comment.