Skip to content

Commit

Permalink
[fc] Repository: Products.CMFPlone
Browse files Browse the repository at this point in the history
Branch: refs/heads/master
Date: 2015-09-25T06:15:30-05:00
Author: David Bain (pigeonflight) <pigeonflight@gmail.com>
Commit: plone/Products.CMFPlone@5dbf553

Update README.rst

Files changed:
M Products/CMFPlone/controlpanel/README.rst
  • Loading branch information
pigeonflight committed Sep 25, 2015
1 parent b1c4a7b commit e4678c6
Showing 1 changed file with 8 additions and 37 deletions.
45 changes: 8 additions & 37 deletions last_commit.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,56 +2,27 @@ Repository: Products.CMFPlone


Branch: refs/heads/master
Date: 2015-09-25T06:15:01-05:00
Date: 2015-09-25T06:15:30-05:00
Author: David Bain (pigeonflight) <pigeonflight@gmail.com>
Commit: https://github.com/plone/Products.CMFPlone/commit/e29c280349ddd5b3650f2071b3785cfaabc6d172
Commit: https://github.com/plone/Products.CMFPlone/commit/5dbf55377b4bd8a714b8be15f4a25eb0fc18f330

Update README.rst

Files changed:
M Products/CMFPlone/controlpanel/README.rst

diff --git a/Products/CMFPlone/controlpanel/README.rst b/Products/CMFPlone/controlpanel/README.rst
index c52623e..056b964 100644
index 056b964..8221676 100644
--- a/Products/CMFPlone/controlpanel/README.rst
+++ b/Products/CMFPlone/controlpanel/README.rst
@@ -2,7 +2,7 @@ Plone Controlpanel
==================

All control panel related settings are stored in plone.app.registry and
-can be looked up like follow.
+can be looked up as follows.

First we lookup the registry utility::

@@ -10,22 +10,24 @@ First we lookup the registry utility::
>>> from plone.registry.interfaces import IRegistry
>>> registry = getUtility(IRegistry)

-Now we use the schema 'ISearchSchema' to lookup for a RecordProxy object with
+As an example, let's look for search related settings (defined by ISearchSchema).
+We use the schema 'ISearchSchema' to lookup a RecordProxy object with
all fields::

>>> from Products.CMFPlone.interfaces import ISearchSchema
>>> search_settings = registry.forInterface(ISearchSchema, prefix='plone')

-Now we an get and set all fields of the schema above like::
+Now we can get and set all fields of the schema above. For example the value for
+`enable_livesearch` can be retrieved as follows::

@@ -32,7 +32,7 @@ Now the `enable_livesearch` should be set to False, effectively disabling it::
>>> search_settings.enable_livesearch
True

-If you want to change a setting, just change the attribute::
+Changing a setting is a simple as just changing the attribute::
False

>>> search_settings.enable_livesearch = False
-For more informations about how to access and manipulate Plone registry entries, have a look at the `plone.registry documentation <https://github.com/plone/plone.registry/blob/master/plone/registry/registry.rst>`_:
+For more information about how to access and manipulate Plone registry entries, have a look at the `plone.registry documentation <https://github.com/plone/plone.registry/blob/master/plone/registry/registry.rst>`_:

-Now the enable_livesearch should disabled::
+Now the `enable_livesearch` should be set to False, effectively disabling it::

>>> search_settings.enable_livesearch
False
Editing Control Panel


0 comments on commit e4678c6

Please sign in to comment.