[Checkins] SVN: Products.CMFDefault/trunk/ - added a buildout to create a working ``sphinx-build`` script for
Jens Vagelpohl
cvs-admin at zope.org
Wed Apr 4 09:14:31 UTC 2012
Log message for revision 124942:
- added a buildout to create a working ``sphinx-build`` script for
building the Sphinx documentation
- cleaned up many Sphinx complaints
Changed:
_U Products.CMFDefault/trunk/
A Products.CMFDefault/trunk/bootstrap.py
A Products.CMFDefault/trunk/buildout.cfg
_U Products.CMFDefault/trunk/docs/
U Products.CMFDefault/trunk/docs/api/CMFDefault.browser.admin.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.browser.admin.tests.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.browser.content.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.browser.content.tests.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.browser.membership.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.browser.membership.tests.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.browser.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.browser.search.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.browser.search.tests.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.browser.skins.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.browser.skins.tests.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.browser.widgets.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.browser.workflow.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.formlib.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.interfaces.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.locales.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.skin.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.tests.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.upgrade.rst
U Products.CMFDefault/trunk/docs/api/CMFDefault.upgrade.tests.rst
A Products.CMFDefault/trunk/docs/api/index.rst
D Products.CMFDefault/trunk/docs/api/modules.rst
U Products.CMFDefault/trunk/docs/conf.py
U Products.CMFDefault/trunk/docs/index.rst
U Products.CMFDefault/trunk/docs/narrative/Actor_Reviewer.rst
U Products.CMFDefault/trunk/docs/narrative/Actor_SiteDesigner.rst
U Products.CMFDefault/trunk/docs/narrative/ApproveForPublication.rst
U Products.CMFDefault/trunk/docs/narrative/BecomeAMember.rst
U Products.CMFDefault/trunk/docs/narrative/ChangeContent.rst
U Products.CMFDefault/trunk/docs/narrative/ConfigurePersonalization.rst
U Products.CMFDefault/trunk/docs/narrative/CreateCMFFolder.rst
U Products.CMFDefault/trunk/docs/narrative/CreateCMFSite.rst
U Products.CMFDefault/trunk/docs/narrative/CreateCMFTopic.rst
U Products.CMFDefault/trunk/docs/narrative/CreateNewContent.rst
U Products.CMFDefault/trunk/docs/narrative/LoginAsMember.rst
U Products.CMFDefault/trunk/docs/narrative/ManageLocalRoles.rst
U Products.CMFDefault/trunk/docs/narrative/ProvideFeedback.rst
U Products.CMFDefault/trunk/docs/narrative/RemoveContent.rst
U Products.CMFDefault/trunk/docs/narrative/RenameContent.rst
U Products.CMFDefault/trunk/docs/narrative/SearchCMFSite.rst
U Products.CMFDefault/trunk/docs/narrative/SubmitContentForPublication.rst
U Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Overview.rst
U Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Policies.rst
U Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Properties.rst
U Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Reporting.rst
U Products.CMFDefault/trunk/docs/narrative/TODO.rst
U Products.CMFDefault/trunk/docs/narrative/UndoChanges.rst
U Products.CMFDefault/trunk/docs/narrative/UnpublishContent.rst
U Products.CMFDefault/trunk/docs/narrative/ViewMyContent.rst
U Products.CMFDefault/trunk/setup.py
-=-
Property changes on: Products.CMFDefault/trunk
___________________________________________________________________
Modified: svn:ignore
- build
dist
*.egg-info
*.pyc
eggtestinfo-*.egg
+ build
dist
*.egg-info
*.pyc
eggtestinfo-*.egg
develop-eggs
parts
.installed.cfg
bin
Added: Products.CMFDefault/trunk/bootstrap.py
===================================================================
--- Products.CMFDefault/trunk/bootstrap.py (rev 0)
+++ Products.CMFDefault/trunk/bootstrap.py 2012-04-04 09:14:27 UTC (rev 124942)
@@ -0,0 +1,121 @@
+##############################################################################
+#
+# Copyright (c) 2006 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Bootstrap a buildout-based project
+
+Simply run this script in a directory containing a buildout.cfg.
+The script accepts buildout command-line options, so you can
+use the -c option to specify an alternate configuration file.
+
+$Id$
+"""
+
+import os, shutil, sys, tempfile, urllib2
+from optparse import OptionParser
+
+tmpeggs = tempfile.mkdtemp()
+
+is_jython = sys.platform.startswith('java')
+
+# parsing arguments
+parser = OptionParser()
+parser.add_option("-v", "--version", dest="version",
+ help="use a specific zc.buildout version")
+parser.add_option("-d", "--distribute",
+ action="store_true", dest="distribute", default=False,
+ help="Use Disribute rather than Setuptools.")
+
+parser.add_option("-c", None, action="store", dest="config_file",
+ help=("Specify the path to the buildout configuration "
+ "file to be used."))
+
+options, args = parser.parse_args()
+
+# if -c was provided, we push it back into args for buildout' main function
+if options.config_file is not None:
+ args += ['-c', options.config_file]
+
+if options.version is not None:
+ VERSION = '==%s' % options.version
+else:
+ VERSION = ''
+
+USE_DISTRIBUTE = options.distribute
+args = args + ['bootstrap']
+
+to_reload = False
+try:
+ import pkg_resources
+ if not hasattr(pkg_resources, '_distribute'):
+ to_reload = True
+ raise ImportError
+except ImportError:
+ ez = {}
+ if USE_DISTRIBUTE:
+ exec urllib2.urlopen('http://python-distribute.org/distribute_setup.py'
+ ).read() in ez
+ ez['use_setuptools'](to_dir=tmpeggs, download_delay=0, no_fake=True)
+ else:
+ exec urllib2.urlopen('http://peak.telecommunity.com/dist/ez_setup.py'
+ ).read() in ez
+ ez['use_setuptools'](to_dir=tmpeggs, download_delay=0)
+
+ if to_reload:
+ reload(pkg_resources)
+ else:
+ import pkg_resources
+
+if sys.platform == 'win32':
+ def quote(c):
+ if ' ' in c:
+ return '"%s"' % c # work around spawn lamosity on windows
+ else:
+ return c
+else:
+ def quote (c):
+ return c
+
+cmd = 'from setuptools.command.easy_install import main; main()'
+ws = pkg_resources.working_set
+
+if USE_DISTRIBUTE:
+ requirement = 'distribute'
+else:
+ requirement = 'setuptools'
+
+if is_jython:
+ import subprocess
+
+ assert subprocess.Popen([sys.executable] + ['-c', quote(cmd), '-mqNxd',
+ quote(tmpeggs), 'zc.buildout' + VERSION],
+ env=dict(os.environ,
+ PYTHONPATH=
+ ws.find(pkg_resources.Requirement.parse(requirement)).location
+ ),
+ ).wait() == 0
+
+else:
+ assert os.spawnle(
+ os.P_WAIT, sys.executable, quote (sys.executable),
+ '-c', quote (cmd), '-mqNxd', quote (tmpeggs), 'zc.buildout' + VERSION,
+ dict(os.environ,
+ PYTHONPATH=
+ ws.find(pkg_resources.Requirement.parse(requirement)).location
+ ),
+ ) == 0
+
+ws.add_entry(tmpeggs)
+ws.require('zc.buildout' + VERSION)
+import zc.buildout.buildout
+zc.buildout.buildout.main(args)
+shutil.rmtree(tmpeggs)
Property changes on: Products.CMFDefault/trunk/bootstrap.py
___________________________________________________________________
Added: svn:keywords
+ Id
Added: svn:eol-style
+ native
Added: Products.CMFDefault/trunk/buildout.cfg
===================================================================
--- Products.CMFDefault/trunk/buildout.cfg (rev 0)
+++ Products.CMFDefault/trunk/buildout.cfg 2012-04-04 09:14:27 UTC (rev 124942)
@@ -0,0 +1,15 @@
+[buildout]
+develop = .
+parts =
+ sphinx
+
+unzip = true
+
+
+[sphinx]
+recipe = zc.recipe.egg
+eggs =
+ Products.CMFDefault[docs]
+dependent-scripts = true
+scripts =
+ sphinx-build
Property changes on: Products.CMFDefault/trunk/docs
___________________________________________________________________
Added: svn:ignore
+ _build
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.browser.admin.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.browser.admin.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.browser.admin.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`admin` Package
--------------------
-.. automodule:: CMFDefault.browser.admin
+.. automodule:: Products.CMFDefault.browser.admin
:members:
:undoc-members:
:show-inheritance:
@@ -12,7 +12,7 @@
:mod:`config` Module
--------------------
-.. automodule:: CMFDefault.browser.admin.config
+.. automodule:: Products.CMFDefault.browser.admin.config
:members:
:undoc-members:
:show-inheritance:
@@ -20,7 +20,7 @@
:mod:`interfaces` Module
------------------------
-.. automodule:: CMFDefault.browser.admin.interfaces
+.. automodule:: Products.CMFDefault.browser.admin.interfaces
:members:
:undoc-members:
:show-inheritance:
@@ -28,7 +28,7 @@
:mod:`syndication` Module
-------------------------
-.. automodule:: CMFDefault.browser.admin.syndication
+.. automodule:: Products.CMFDefault.browser.admin.syndication
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.browser.admin.tests.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.browser.admin.tests.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.browser.admin.tests.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`test_config` Module
-------------------------
-.. automodule:: CMFDefault.browser.admin.tests.test_config
+.. automodule:: Products.CMFDefault.browser.admin.tests.test_config
:members:
:undoc-members:
:show-inheritance:
@@ -12,7 +12,7 @@
:mod:`test_syndication` Module
------------------------------
-.. automodule:: CMFDefault.browser.admin.tests.test_syndication
+.. automodule:: Products.CMFDefault.browser.admin.tests.test_syndication
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.browser.content.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.browser.content.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.browser.content.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`content` Package
----------------------
-.. automodule:: CMFDefault.browser.content
+.. automodule:: Products.CMFDefault.browser.content
:members:
:undoc-members:
:show-inheritance:
@@ -12,7 +12,7 @@
:mod:`document` Module
----------------------
-.. automodule:: CMFDefault.browser.content.document
+.. automodule:: Products.CMFDefault.browser.content.document
:members:
:undoc-members:
:show-inheritance:
@@ -20,7 +20,7 @@
:mod:`favorite` Module
----------------------
-.. automodule:: CMFDefault.browser.content.favorite
+.. automodule:: Products.CMFDefault.browser.content.favorite
:members:
:undoc-members:
:show-inheritance:
@@ -28,7 +28,7 @@
:mod:`file` Module
------------------
-.. automodule:: CMFDefault.browser.content.file
+.. automodule:: Products.CMFDefault.browser.content.file
:members:
:undoc-members:
:show-inheritance:
@@ -36,7 +36,7 @@
:mod:`folder` Module
--------------------
-.. automodule:: CMFDefault.browser.content.folder
+.. automodule:: Products.CMFDefault.browser.content.folder
:members:
:undoc-members:
:show-inheritance:
@@ -44,7 +44,7 @@
:mod:`image` Module
-------------------
-.. automodule:: CMFDefault.browser.content.image
+.. automodule:: Products.CMFDefault.browser.content.image
:members:
:undoc-members:
:show-inheritance:
@@ -52,7 +52,7 @@
:mod:`interfaces` Module
------------------------
-.. automodule:: CMFDefault.browser.content.interfaces
+.. automodule:: Products.CMFDefault.browser.content.interfaces
:members:
:undoc-members:
:show-inheritance:
@@ -60,7 +60,7 @@
:mod:`link` Module
------------------
-.. automodule:: CMFDefault.browser.content.link
+.. automodule:: Products.CMFDefault.browser.content.link
:members:
:undoc-members:
:show-inheritance:
@@ -68,7 +68,7 @@
:mod:`metadata` Module
----------------------
-.. automodule:: CMFDefault.browser.content.metadata
+.. automodule:: Products.CMFDefault.browser.content.metadata
:members:
:undoc-members:
:show-inheritance:
@@ -76,7 +76,7 @@
:mod:`newsitem` Module
----------------------
-.. automodule:: CMFDefault.browser.content.newsitem
+.. automodule:: Products.CMFDefault.browser.content.newsitem
:members:
:undoc-members:
:show-inheritance:
@@ -84,7 +84,7 @@
:mod:`rss` Module
-----------------
-.. automodule:: CMFDefault.browser.content.rss
+.. automodule:: Products.CMFDefault.browser.content.rss
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.browser.content.tests.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.browser.content.tests.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.browser.content.tests.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`tests` Package
--------------------
-.. automodule:: CMFDefault.browser.content.tests
+.. automodule:: Products.CMFDefault.browser.content.tests
:members:
:undoc-members:
:show-inheritance:
@@ -12,7 +12,7 @@
:mod:`test_btreefolder` Module
------------------------------
-.. automodule:: CMFDefault.browser.content.tests.test_btreefolder
+.. automodule:: Products.CMFDefault.browser.content.tests.test_btreefolder
:members:
:undoc-members:
:show-inheritance:
@@ -20,7 +20,7 @@
:mod:`test_document` Module
---------------------------
-.. automodule:: CMFDefault.browser.content.tests.test_document
+.. automodule:: Products.CMFDefault.browser.content.tests.test_document
:members:
:undoc-members:
:show-inheritance:
@@ -28,7 +28,7 @@
:mod:`test_favorite` Module
---------------------------
-.. automodule:: CMFDefault.browser.content.tests.test_favorite
+.. automodule:: Products.CMFDefault.browser.content.tests.test_favorite
:members:
:undoc-members:
:show-inheritance:
@@ -36,7 +36,7 @@
:mod:`test_file` Module
-----------------------
-.. automodule:: CMFDefault.browser.content.tests.test_file
+.. automodule:: Products.CMFDefault.browser.content.tests.test_file
:members:
:undoc-members:
:show-inheritance:
@@ -44,7 +44,7 @@
:mod:`test_folder` Module
-------------------------
-.. automodule:: CMFDefault.browser.content.tests.test_folder
+.. automodule:: Products.CMFDefault.browser.content.tests.test_folder
:members:
:undoc-members:
:show-inheritance:
@@ -52,7 +52,7 @@
:mod:`test_image` Module
------------------------
-.. automodule:: CMFDefault.browser.content.tests.test_image
+.. automodule:: Products.CMFDefault.browser.content.tests.test_image
:members:
:undoc-members:
:show-inheritance:
@@ -60,7 +60,7 @@
:mod:`test_link` Module
-----------------------
-.. automodule:: CMFDefault.browser.content.tests.test_link
+.. automodule:: Products.CMFDefault.browser.content.tests.test_link
:members:
:undoc-members:
:show-inheritance:
@@ -68,7 +68,7 @@
:mod:`test_metadata` Module
---------------------------
-.. automodule:: CMFDefault.browser.content.tests.test_metadata
+.. automodule:: Products.CMFDefault.browser.content.tests.test_metadata
:members:
:undoc-members:
:show-inheritance:
@@ -76,7 +76,7 @@
:mod:`utils` Module
-------------------
-.. automodule:: CMFDefault.browser.content.tests.utils
+.. automodule:: Products.CMFDefault.browser.content.tests.utils
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.browser.membership.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.browser.membership.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.browser.membership.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`membership` Package
-------------------------
-.. automodule:: CMFDefault.browser.membership
+.. automodule:: Products.CMFDefault.browser.membership
:members:
:undoc-members:
:show-inheritance:
@@ -12,7 +12,7 @@
:mod:`authentication` Module
----------------------------
-.. automodule:: CMFDefault.browser.membership.authentication
+.. automodule:: Products.CMFDefault.browser.membership.authentication
:members:
:undoc-members:
:show-inheritance:
@@ -20,7 +20,7 @@
:mod:`join` Module
------------------
-.. automodule:: CMFDefault.browser.membership.join
+.. automodule:: Products.CMFDefault.browser.membership.join
:members:
:undoc-members:
:show-inheritance:
@@ -28,7 +28,7 @@
:mod:`members` Module
---------------------
-.. automodule:: CMFDefault.browser.membership.members
+.. automodule:: Products.CMFDefault.browser.membership.members
:members:
:undoc-members:
:show-inheritance:
@@ -36,7 +36,7 @@
:mod:`password` Module
----------------------
-.. automodule:: CMFDefault.browser.membership.password
+.. automodule:: Products.CMFDefault.browser.membership.password
:members:
:undoc-members:
:show-inheritance:
@@ -44,7 +44,7 @@
:mod:`preferences` Module
-------------------------
-.. automodule:: CMFDefault.browser.membership.preferences
+.. automodule:: Products.CMFDefault.browser.membership.preferences
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.browser.membership.tests.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.browser.membership.tests.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.browser.membership.tests.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`test_authentication` Module
---------------------------------
-.. automodule:: CMFDefault.browser.membership.tests.test_authentication
+.. automodule:: Products.CMFDefault.browser.membership.tests.test_authentication
:members:
:undoc-members:
:show-inheritance:
@@ -12,7 +12,7 @@
:mod:`test_join` Module
-----------------------
-.. automodule:: CMFDefault.browser.membership.tests.test_join
+.. automodule:: Products.CMFDefault.browser.membership.tests.test_join
:members:
:undoc-members:
:show-inheritance:
@@ -20,7 +20,7 @@
:mod:`test_members` Module
--------------------------
-.. automodule:: CMFDefault.browser.membership.tests.test_members
+.. automodule:: Products.CMFDefault.browser.membership.tests.test_members
:members:
:undoc-members:
:show-inheritance:
@@ -28,7 +28,7 @@
:mod:`test_password` Module
---------------------------
-.. automodule:: CMFDefault.browser.membership.tests.test_password
+.. automodule:: Products.CMFDefault.browser.membership.tests.test_password
:members:
:undoc-members:
:show-inheritance:
@@ -36,7 +36,7 @@
:mod:`test_preferences` Module
------------------------------
-.. automodule:: CMFDefault.browser.membership.tests.test_preferences
+.. automodule:: Products.CMFDefault.browser.membership.tests.test_preferences
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.browser.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.browser.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.browser.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`browser` Package
----------------------
-.. automodule:: CMFDefault.browser
+.. automodule:: Products.CMFDefault.browser
:members:
:undoc-members:
:show-inheritance:
@@ -12,7 +12,7 @@
:mod:`test_utils` Module
------------------------
-.. automodule:: CMFDefault.browser.test_utils
+.. automodule:: Products.CMFDefault.browser.test_utils
:members:
:undoc-members:
:show-inheritance:
@@ -20,7 +20,7 @@
:mod:`utils` Module
-------------------
-.. automodule:: CMFDefault.browser.utils
+.. automodule:: Products.CMFDefault.browser.utils
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.browser.search.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.browser.search.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.browser.search.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`interfaces` Module
------------------------
-.. automodule:: CMFDefault.browser.search.interfaces
+.. automodule:: Products.CMFDefault.browser.search.interfaces
:members:
:undoc-members:
:show-inheritance:
@@ -12,7 +12,7 @@
:mod:`search` Module
--------------------
-.. automodule:: CMFDefault.browser.search.search
+.. automodule:: Products.CMFDefault.browser.search.search
:members:
:undoc-members:
:show-inheritance:
@@ -20,7 +20,7 @@
:mod:`vocab` Module
-------------------
-.. automodule:: CMFDefault.browser.search.vocab
+.. automodule:: Products.CMFDefault.browser.search.vocab
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.browser.search.tests.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.browser.search.tests.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.browser.search.tests.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`test_search` Module
-------------------------
-.. automodule:: CMFDefault.browser.search.tests.test_search
+.. automodule:: Products.CMFDefault.browser.search.tests.test_search
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.browser.skins.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.browser.skins.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.browser.skins.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`skins` Package
--------------------
-.. automodule:: CMFDefault.browser.skins
+.. automodule:: Products.CMFDefault.browser.skins
:members:
:undoc-members:
:show-inheritance:
@@ -12,7 +12,7 @@
:mod:`icons` Module
-------------------
-.. automodule:: CMFDefault.browser.skins.icons
+.. automodule:: Products.CMFDefault.browser.skins.icons
:members:
:undoc-members:
:show-inheritance:
@@ -20,7 +20,7 @@
:mod:`ursa` Module
------------------
-.. automodule:: CMFDefault.browser.skins.ursa
+.. automodule:: Products.CMFDefault.browser.skins.ursa
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.browser.skins.tests.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.browser.skins.tests.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.browser.skins.tests.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`test_icons` Module
------------------------
-.. automodule:: CMFDefault.browser.skins.tests.test_icons
+.. automodule:: Products.CMFDefault.browser.skins.tests.test_icons
:members:
:undoc-members:
:show-inheritance:
@@ -12,7 +12,7 @@
:mod:`test_ursa` Module
-----------------------
-.. automodule:: CMFDefault.browser.skins.tests.test_ursa
+.. automodule:: Products.CMFDefault.browser.skins.tests.test_ursa
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.browser.widgets.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.browser.widgets.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.browser.widgets.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`widgets` Package
----------------------
-.. automodule:: CMFDefault.browser.widgets
+.. automodule:: Products.CMFDefault.browser.widgets
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.browser.workflow.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.browser.workflow.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.browser.workflow.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`history` Module
---------------------
-.. automodule:: CMFDefault.browser.workflow.history
+.. automodule:: Products.CMFDefault.browser.workflow.history
:members:
:undoc-members:
:show-inheritance:
@@ -12,7 +12,7 @@
:mod:`workflow` Module
----------------------
-.. automodule:: CMFDefault.browser.workflow.workflow
+.. automodule:: Products.CMFDefault.browser.workflow.workflow
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.formlib.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.formlib.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.formlib.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`formlib` Package
----------------------
-.. automodule:: CMFDefault.formlib
+.. automodule:: Products.CMFDefault.formlib
:members:
:undoc-members:
:show-inheritance:
@@ -12,7 +12,7 @@
:mod:`form` Module
------------------
-.. automodule:: CMFDefault.formlib.form
+.. automodule:: Products.CMFDefault.formlib.form
:members:
:undoc-members:
:show-inheritance:
@@ -20,7 +20,7 @@
:mod:`schema` Module
--------------------
-.. automodule:: CMFDefault.formlib.schema
+.. automodule:: Products.CMFDefault.formlib.schema
:members:
:undoc-members:
:show-inheritance:
@@ -28,7 +28,7 @@
:mod:`tests` Module
-------------------
-.. automodule:: CMFDefault.formlib.tests
+.. automodule:: Products.CMFDefault.formlib.tests
:members:
:undoc-members:
:show-inheritance:
@@ -36,7 +36,7 @@
:mod:`vocabulary` Module
------------------------
-.. automodule:: CMFDefault.formlib.vocabulary
+.. automodule:: Products.CMFDefault.formlib.vocabulary
:members:
:undoc-members:
:show-inheritance:
@@ -44,7 +44,7 @@
:mod:`widgets` Module
---------------------
-.. automodule:: CMFDefault.formlib.widgets
+.. automodule:: Products.CMFDefault.formlib.widgets
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.interfaces.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.interfaces.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.interfaces.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`interfaces` Package
-------------------------
-.. automodule:: CMFDefault.interfaces
+.. automodule:: Products.CMFDefault.interfaces
:members:
:undoc-members:
:show-inheritance:
@@ -12,7 +12,7 @@
:mod:`_content` Module
----------------------
-.. automodule:: CMFDefault.interfaces._content
+.. automodule:: Products.CMFDefault.interfaces._content
:members:
:undoc-members:
:show-inheritance:
@@ -20,7 +20,7 @@
:mod:`_tools` Module
--------------------
-.. automodule:: CMFDefault.interfaces._tools
+.. automodule:: Products.CMFDefault.interfaces._tools
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.locales.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.locales.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.locales.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`locales` Package
----------------------
-.. automodule:: CMFDefault.locales
+.. automodule:: Products.CMFDefault.locales
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`CMFDefault` Package
-------------------------
-.. automodule:: CMFDefault.__init__
+.. automodule:: Products.CMFDefault.__init__
:members:
:undoc-members:
:show-inheritance:
@@ -12,7 +12,7 @@
:mod:`DefaultWorkflow` Module
-----------------------------
-.. automodule:: CMFDefault.DefaultWorkflow
+.. automodule:: Products.CMFDefault.DefaultWorkflow
:members:
:undoc-members:
:show-inheritance:
@@ -20,7 +20,7 @@
:mod:`DiscussionItem` Module
----------------------------
-.. automodule:: CMFDefault.DiscussionItem
+.. automodule:: Products.CMFDefault.DiscussionItem
:members:
:undoc-members:
:show-inheritance:
@@ -28,7 +28,7 @@
:mod:`DiscussionTool` Module
----------------------------
-.. automodule:: CMFDefault.DiscussionTool
+.. automodule:: Products.CMFDefault.DiscussionTool
:members:
:undoc-members:
:show-inheritance:
@@ -36,7 +36,7 @@
:mod:`Document` Module
----------------------
-.. automodule:: CMFDefault.Document
+.. automodule:: Products.CMFDefault.Document
:members:
:undoc-members:
:show-inheritance:
@@ -44,7 +44,7 @@
:mod:`DublinCore` Module
------------------------
-.. automodule:: CMFDefault.DublinCore
+.. automodule:: Products.CMFDefault.DublinCore
:members:
:undoc-members:
:show-inheritance:
@@ -52,7 +52,7 @@
:mod:`Favorite` Module
----------------------
-.. automodule:: CMFDefault.Favorite
+.. automodule:: Products.CMFDefault.Favorite
:members:
:undoc-members:
:show-inheritance:
@@ -60,7 +60,7 @@
:mod:`File` Module
------------------
-.. automodule:: CMFDefault.File
+.. automodule:: Products.CMFDefault.File
:members:
:undoc-members:
:show-inheritance:
@@ -68,7 +68,7 @@
:mod:`Image` Module
-------------------
-.. automodule:: CMFDefault.Image
+.. automodule:: Products.CMFDefault.Image
:members:
:undoc-members:
:show-inheritance:
@@ -76,7 +76,7 @@
:mod:`Link` Module
------------------
-.. automodule:: CMFDefault.Link
+.. automodule:: Products.CMFDefault.Link
:members:
:undoc-members:
:show-inheritance:
@@ -84,7 +84,7 @@
:mod:`MembershipTool` Module
----------------------------
-.. automodule:: CMFDefault.MembershipTool
+.. automodule:: Products.CMFDefault.MembershipTool
:members:
:undoc-members:
:show-inheritance:
@@ -92,7 +92,7 @@
:mod:`MetadataTool` Module
--------------------------
-.. automodule:: CMFDefault.MetadataTool
+.. automodule:: Products.CMFDefault.MetadataTool
:members:
:undoc-members:
:show-inheritance:
@@ -100,7 +100,7 @@
:mod:`NewsItem` Module
----------------------
-.. automodule:: CMFDefault.NewsItem
+.. automodule:: Products.CMFDefault.NewsItem
:members:
:undoc-members:
:show-inheritance:
@@ -108,7 +108,7 @@
:mod:`Portal` Module
--------------------
-.. automodule:: CMFDefault.Portal
+.. automodule:: Products.CMFDefault.Portal
:members:
:undoc-members:
:show-inheritance:
@@ -116,7 +116,7 @@
:mod:`PropertiesTool` Module
----------------------------
-.. automodule:: CMFDefault.PropertiesTool
+.. automodule:: Products.CMFDefault.PropertiesTool
:members:
:undoc-members:
:show-inheritance:
@@ -124,7 +124,7 @@
:mod:`RegistrationTool` Module
------------------------------
-.. automodule:: CMFDefault.RegistrationTool
+.. automodule:: Products.CMFDefault.RegistrationTool
:members:
:undoc-members:
:show-inheritance:
@@ -132,7 +132,7 @@
:mod:`SkinnedFolder` Module
---------------------------
-.. automodule:: CMFDefault.SkinnedFolder
+.. automodule:: Products.CMFDefault.SkinnedFolder
:members:
:undoc-members:
:show-inheritance:
@@ -140,7 +140,7 @@
:mod:`SyndicationInfo` Module
-----------------------------
-.. automodule:: CMFDefault.SyndicationInfo
+.. automodule:: Products.CMFDefault.SyndicationInfo
:members:
:undoc-members:
:show-inheritance:
@@ -148,7 +148,7 @@
:mod:`SyndicationTool` Module
-----------------------------
-.. automodule:: CMFDefault.SyndicationTool
+.. automodule:: Products.CMFDefault.SyndicationTool
:members:
:undoc-members:
:show-inheritance:
@@ -156,7 +156,7 @@
:mod:`URLTool` Module
---------------------
-.. automodule:: CMFDefault.URLTool
+.. automodule:: Products.CMFDefault.URLTool
:members:
:undoc-members:
:show-inheritance:
@@ -164,7 +164,7 @@
:mod:`exceptions` Module
------------------------
-.. automodule:: CMFDefault.exceptions
+.. automodule:: Products.CMFDefault.exceptions
:members:
:undoc-members:
:show-inheritance:
@@ -172,7 +172,7 @@
:mod:`factory` Module
---------------------
-.. automodule:: CMFDefault.factory
+.. automodule:: Products.CMFDefault.factory
:members:
:undoc-members:
:show-inheritance:
@@ -180,7 +180,7 @@
:mod:`permissions` Module
-------------------------
-.. automodule:: CMFDefault.permissions
+.. automodule:: Products.CMFDefault.permissions
:members:
:undoc-members:
:show-inheritance:
@@ -188,7 +188,7 @@
:mod:`setuphandlers` Module
---------------------------
-.. automodule:: CMFDefault.setuphandlers
+.. automodule:: Products.CMFDefault.setuphandlers
:members:
:undoc-members:
:show-inheritance:
@@ -196,7 +196,7 @@
:mod:`testing` Module
---------------------
-.. automodule:: CMFDefault.testing
+.. automodule:: Products.CMFDefault.testing
:members:
:undoc-members:
:show-inheritance:
@@ -204,7 +204,7 @@
:mod:`utils` Module
-------------------
-.. automodule:: CMFDefault.utils
+.. automodule:: Products.CMFDefault.utils
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.skin.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.skin.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.skin.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`skin` Package
-------------------
-.. automodule:: CMFDefault.skin
+.. automodule:: Products.CMFDefault.skin
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.tests.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.tests.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.tests.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`tests` Package
--------------------
-.. automodule:: CMFDefault.tests
+.. automodule:: Products.CMFDefault.tests
:members:
:undoc-members:
:show-inheritance:
@@ -12,7 +12,7 @@
:mod:`test_DefaultWorkflow` Module
----------------------------------
-.. automodule:: CMFDefault.tests.test_DefaultWorkflow
+.. automodule:: Products.CMFDefault.tests.test_DefaultWorkflow
:members:
:undoc-members:
:show-inheritance:
@@ -20,7 +20,7 @@
:mod:`test_DiscussionReply` Module
----------------------------------
-.. automodule:: CMFDefault.tests.test_DiscussionReply
+.. automodule:: Products.CMFDefault.tests.test_DiscussionReply
:members:
:undoc-members:
:show-inheritance:
@@ -28,7 +28,7 @@
:mod:`test_DiscussionTool` Module
---------------------------------
-.. automodule:: CMFDefault.tests.test_DiscussionTool
+.. automodule:: Products.CMFDefault.tests.test_DiscussionTool
:members:
:undoc-members:
:show-inheritance:
@@ -36,7 +36,7 @@
:mod:`test_Discussions` Module
------------------------------
-.. automodule:: CMFDefault.tests.test_Discussions
+.. automodule:: Products.CMFDefault.tests.test_Discussions
:members:
:undoc-members:
:show-inheritance:
@@ -44,7 +44,7 @@
:mod:`test_Document` Module
---------------------------
-.. automodule:: CMFDefault.tests.test_Document
+.. automodule:: Products.CMFDefault.tests.test_Document
:members:
:undoc-members:
:show-inheritance:
@@ -52,7 +52,7 @@
:mod:`test_DublinCore` Module
-----------------------------
-.. automodule:: CMFDefault.tests.test_DublinCore
+.. automodule:: Products.CMFDefault.tests.test_DublinCore
:members:
:undoc-members:
:show-inheritance:
@@ -60,7 +60,7 @@
:mod:`test_Favorite` Module
---------------------------
-.. automodule:: CMFDefault.tests.test_Favorite
+.. automodule:: Products.CMFDefault.tests.test_Favorite
:members:
:undoc-members:
:show-inheritance:
@@ -68,7 +68,7 @@
:mod:`test_File` Module
-----------------------
-.. automodule:: CMFDefault.tests.test_File
+.. automodule:: Products.CMFDefault.tests.test_File
:members:
:undoc-members:
:show-inheritance:
@@ -76,7 +76,7 @@
:mod:`test_Image` Module
------------------------
-.. automodule:: CMFDefault.tests.test_Image
+.. automodule:: Products.CMFDefault.tests.test_Image
:members:
:undoc-members:
:show-inheritance:
@@ -84,7 +84,7 @@
:mod:`test_Link` Module
-----------------------
-.. automodule:: CMFDefault.tests.test_Link
+.. automodule:: Products.CMFDefault.tests.test_Link
:members:
:undoc-members:
:show-inheritance:
@@ -92,7 +92,7 @@
:mod:`test_MembershipTool` Module
---------------------------------
-.. automodule:: CMFDefault.tests.test_MembershipTool
+.. automodule:: Products.CMFDefault.tests.test_MembershipTool
:members:
:undoc-members:
:show-inheritance:
@@ -100,7 +100,7 @@
:mod:`test_MetadataTool` Module
-------------------------------
-.. automodule:: CMFDefault.tests.test_MetadataTool
+.. automodule:: Products.CMFDefault.tests.test_MetadataTool
:members:
:undoc-members:
:show-inheritance:
@@ -108,7 +108,7 @@
:mod:`test_NewsItem` Module
---------------------------
-.. automodule:: CMFDefault.tests.test_NewsItem
+.. automodule:: Products.CMFDefault.tests.test_NewsItem
:members:
:undoc-members:
:show-inheritance:
@@ -116,7 +116,7 @@
:mod:`test_Portal` Module
-------------------------
-.. automodule:: CMFDefault.tests.test_Portal
+.. automodule:: Products.CMFDefault.tests.test_Portal
:members:
:undoc-members:
:show-inheritance:
@@ -124,7 +124,7 @@
:mod:`test_PropertiesTool` Module
---------------------------------
-.. automodule:: CMFDefault.tests.test_PropertiesTool
+.. automodule:: Products.CMFDefault.tests.test_PropertiesTool
:members:
:undoc-members:
:show-inheritance:
@@ -132,7 +132,7 @@
:mod:`test_RegistrationTool` Module
-----------------------------------
-.. automodule:: CMFDefault.tests.test_RegistrationTool
+.. automodule:: Products.CMFDefault.tests.test_RegistrationTool
:members:
:undoc-members:
:show-inheritance:
@@ -140,7 +140,7 @@
:mod:`test_SkinnedFolder` Module
--------------------------------
-.. automodule:: CMFDefault.tests.test_SkinnedFolder
+.. automodule:: Products.CMFDefault.tests.test_SkinnedFolder
:members:
:undoc-members:
:show-inheritance:
@@ -148,7 +148,7 @@
:mod:`test_SyndicationInfo` Module
----------------------------------
-.. automodule:: CMFDefault.tests.test_SyndicationInfo
+.. automodule:: Products.CMFDefault.tests.test_SyndicationInfo
:members:
:undoc-members:
:show-inheritance:
@@ -156,7 +156,7 @@
:mod:`test_SyndicationTool` Module
----------------------------------
-.. automodule:: CMFDefault.tests.test_SyndicationTool
+.. automodule:: Products.CMFDefault.tests.test_SyndicationTool
:members:
:undoc-members:
:show-inheritance:
@@ -164,7 +164,7 @@
:mod:`test_join` Module
-----------------------
-.. automodule:: CMFDefault.tests.test_join
+.. automodule:: Products.CMFDefault.tests.test_join
:members:
:undoc-members:
:show-inheritance:
@@ -172,7 +172,7 @@
:mod:`test_utils` Module
------------------------
-.. automodule:: CMFDefault.tests.test_utils
+.. automodule:: Products.CMFDefault.tests.test_utils
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.upgrade.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.upgrade.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.upgrade.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`upgrade` Package
----------------------
-.. automodule:: CMFDefault.upgrade
+.. automodule:: Products.CMFDefault.upgrade
:members:
:undoc-members:
:show-inheritance:
@@ -12,7 +12,7 @@
:mod:`to20` Module
------------------
-.. automodule:: CMFDefault.upgrade.to20
+.. automodule:: Products.CMFDefault.upgrade.to20
:members:
:undoc-members:
:show-inheritance:
@@ -20,7 +20,7 @@
:mod:`to21` Module
------------------
-.. automodule:: CMFDefault.upgrade.to21
+.. automodule:: Products.CMFDefault.upgrade.to21
:members:
:undoc-members:
:show-inheritance:
@@ -28,7 +28,7 @@
:mod:`to22` Module
------------------
-.. automodule:: CMFDefault.upgrade.to22
+.. automodule:: Products.CMFDefault.upgrade.to22
:members:
:undoc-members:
:show-inheritance:
@@ -36,7 +36,7 @@
:mod:`to23` Module
------------------
-.. automodule:: CMFDefault.upgrade.to23
+.. automodule:: Products.CMFDefault.upgrade.to23
:members:
:undoc-members:
:show-inheritance:
Modified: Products.CMFDefault/trunk/docs/api/CMFDefault.upgrade.tests.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CMFDefault.upgrade.tests.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/CMFDefault.upgrade.tests.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,7 +4,7 @@
:mod:`tests` Package
--------------------
-.. automodule:: CMFDefault.upgrade.tests
+.. automodule:: Products.CMFDefault.upgrade.tests
:members:
:undoc-members:
:show-inheritance:
@@ -12,7 +12,7 @@
:mod:`test_syndication_upgrade` Module
--------------------------------------
-.. automodule:: CMFDefault.upgrade.tests.test_syndication_upgrade
+.. automodule:: Products.CMFDefault.upgrade.tests.test_syndication_upgrade
:members:
:undoc-members:
:show-inheritance:
@@ -20,7 +20,7 @@
:mod:`test_upgrade` Module
--------------------------
-.. automodule:: CMFDefault.upgrade.tests.test_upgrade
+.. automodule:: Products.CMFDefault.upgrade.tests.test_upgrade
:members:
:undoc-members:
:show-inheritance:
Copied: Products.CMFDefault/trunk/docs/api/index.rst (from rev 124928, Products.CMFDefault/trunk/docs/api/modules.rst)
===================================================================
--- Products.CMFDefault/trunk/docs/api/index.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/index.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -0,0 +1,27 @@
+Products.CMFDefault API
+=======================
+
+.. toctree::
+ :maxdepth: 4
+
+ CMFDefault.browser.admin
+ CMFDefault.browser.admin.tests
+ CMFDefault.browser.content
+ CMFDefault.browser.content.tests
+ CMFDefault.browser.membership
+ CMFDefault.browser.membership.tests
+ CMFDefault.browser
+ CMFDefault.browser.search
+ CMFDefault.browser.search.tests
+ CMFDefault.browser.skins
+ CMFDefault.browser.skins.tests
+ CMFDefault.browser.widgets
+ CMFDefault.browser.workflow
+ CMFDefault.formlib
+ CMFDefault.interfaces
+ CMFDefault.locales
+ CMFDefault
+ CMFDefault.skin
+ CMFDefault.tests
+ CMFDefault.upgrade
+ CMFDefault.upgrade.tests
Deleted: Products.CMFDefault/trunk/docs/api/modules.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/modules.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/api/modules.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,7 +0,0 @@
-.
-=
-
-.. toctree::
- :maxdepth: 4
-
- CMFDefault
Modified: Products.CMFDefault/trunk/docs/conf.py
===================================================================
--- Products.CMFDefault/trunk/docs/conf.py 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/conf.py 2012-04-04 09:14:27 UTC (rev 124942)
@@ -11,8 +11,10 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
+import datetime
import os
-#import sys
+import pkginfo
+import sys
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@@ -46,17 +48,22 @@
master_doc = 'index'
# General information about the project.
-project = u'CMFDefault'
-copyright = u'2012, Zope Foundation & Contributors'
+parent = os.path.dirname(os.path.dirname(__file__))
+parent_dir = os.path.abspath(parent)
+sys.path.append(parent_dir)
+pkg_info = pkginfo.Develop(parent_dir)
+year = datetime.datetime.now().year
+project = u'%s' % pkg_info.name
+copyright = u'%s, CMF Developers' % year
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
-version = '2.3'
+version = pkg_info.version.replace('dev', '')
# The full version, including alpha/beta/rc tags.
-release = '2.3'
+release = pkg_info.version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -133,7 +140,7 @@
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
Modified: Products.CMFDefault/trunk/docs/index.rst
===================================================================
--- Products.CMFDefault/trunk/docs/index.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/index.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -4,4 +4,5 @@
.. toctree::
:maxdepth: 2
- narrative/index
\ No newline at end of file
+ narrative/index
+ api/index
Modified: Products.CMFDefault/trunk/docs/narrative/Actor_Reviewer.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/Actor_Reviewer.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/Actor_Reviewer.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -7,7 +7,7 @@
- :doc:`BrowseSubmittedForReview`
- Brief description of the Action box, with pointers back to where this is
- set up in the skin.
+ set up in the skin.
- Pending lists
Modified: Products.CMFDefault/trunk/docs/narrative/Actor_SiteDesigner.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/Actor_SiteDesigner.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/Actor_SiteDesigner.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -14,7 +14,7 @@
likely be a separate use case that refers back to this one.
- The theory behind customizing methods, but don't refer to specific
- layers or specific methods/images.
+ layers or specific methods/images.
- **XXX** :doc:`ChangeSkinLookAndFeel`
Modified: Products.CMFDefault/trunk/docs/narrative/ApproveForPublication.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/ApproveForPublication.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/ApproveForPublication.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,42 +1,42 @@
Use Case: Approve content for publication
=========================================
- Actor
- -----
+Actor
+-----
- - Reviewer
+ - Reviewer
- Overview
- --------
+Overview
+--------
- The Reviewer's job is to enforce the site's policies with respect
- to the quality and appropriateness of content published by Content
- Creators.
+ The Reviewer's job is to enforce the site's policies with respect
+ to the quality and appropriateness of content published by Content
+ Creators.
- Assumptions
- -----------
+Assumptions
+-----------
- - Reviewer has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+ - Reviewer has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
- - Content has been submitted for review (see "Submit content for
- publication":SubmitContentForPublication).
+ - Content has been submitted for review (see "Submit content for
+ publication":SubmitContentForPublication).
- - Reviewer has completed the Use Case: "Browse for content submitted
- for review and publication":BrowseSubmittedForReview.
+ - Reviewer has completed the Use Case: "Browse for content submitted
+ for review and publication":BrowseSubmittedForReview.
- Procedure
- ---------
+Procedure
+---------
- 1. Select the item from the list of content pending review.
+ 1. Select the item from the list of content pending review.
- 2. From the actions box, select the 'Publish' link.
+ 2. From the actions box, select the 'Publish' link.
- 3. Enter appropriate comments.
+ 3. Enter appropriate comments.
- 4. Select the Publish this item button.
+ 4. Select the Publish this item button.
- 5. The item has been published.
+ 5. The item has been published.
- 6. You can now "Browse for content submitted for review and
- publication":BrowseSubmittedForReview to repeat this process.
+ 6. You can now "Browse for content submitted for review and
+ publication":BrowseSubmittedForReview to repeat this process.
Modified: Products.CMFDefault/trunk/docs/narrative/BecomeAMember.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/BecomeAMember.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/BecomeAMember.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,46 +1,46 @@
Use Case: Become A Site Member
==============================
- Actor
- -----
+Actor
+-----
- - Site Visitor
+ - Site Visitor
- Overview
- --------
+Overview
+--------
- Becoming a member of a site allows you to access the additional
- services of the site. Often this includes a personal online
- work area (your "desktop"), the ability create and submit your
- own content for publication and the ability to personalize the
- look and behavior of the site to better meet your needs.
+ Becoming a member of a site allows you to access the additional
+ services of the site. Often this includes a personal online
+ work area (your "desktop"), the ability create and submit your
+ own content for publication and the ability to personalize the
+ look and behavior of the site to better meet your needs.
- Note that different sites have different purposes, and the specific
- services available to site members depends on the choices of the
- site administrators. By default, a CMF site provides members with a
- private "desktop", the ability to create certain types of basic
- content and the ability to select the visual style of the site that
- they see.
+ Note that different sites have different purposes, and the specific
+ services available to site members depends on the choices of the
+ site administrators. By default, a CMF site provides members with a
+ private "desktop", the ability to create certain types of basic
+ content and the ability to select the visual style of the site that
+ they see.
- Procedure
- ---------
+Procedure
+---------
- 1. To become a member of a site, visit the site homepage and click on
- the "Join" link in the menu located on the left side of the page.
+ 1. To become a member of a site, visit the site homepage and click on
+ the "Join" link in the menu located on the left side of the page.
- 2. Clicking the "Join" link will take you to a form. Complete
- the fields on the form and click the "Register" button to
- become a registered member of the site.
+ 2. Clicking the "Join" link will take you to a form. Complete
+ the fields on the form and click the "Register" button to
+ become a registered member of the site.
- 3. The exact information required by the registration form will
- vary from site to site. The form for a default CMF site
- requires visitors to provide at least a login name, a
- password and a valid email address to become a member. The
- default form also gives you an option to have the password
- you provided at registration time emailed to you for future
- reference.
+ 3. The exact information required by the registration form will
+ vary from site to site. The form for a default CMF site
+ requires visitors to provide at least a login name, a
+ password and a valid email address to become a member. The
+ default form also gives you an option to have the password
+ you provided at registration time emailed to you for future
+ reference.
- 4. After submitting the member registration form, you should
- see a page informing you that you have successfully been
- registered as a site member. This page also provides a link
- that you can use to log into the site immediately.
+ 4. After submitting the member registration form, you should
+ see a page informing you that you have successfully been
+ registered as a site member. This page also provides a link
+ that you can use to log into the site immediately.
Modified: Products.CMFDefault/trunk/docs/narrative/ChangeContent.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/ChangeContent.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/ChangeContent.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,44 +1,47 @@
Use Case: Update Existing Content
==================================
- Actor
+Actor
+-----
- - Content Creator
+ - Content Creator
- Assumptions
+Assumptions
+-----------
- - Content Creator has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+ - Content Creator has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
- Procedure
+Procedure
+---------
- 1. Navigate to a piece of content you have the permissions to
- modify.
+ 1. Navigate to a piece of content you have the permissions to
+ modify.
- To retrieve a list of the content you have authored, see
- "View personally authored content":ViewMyContent
+ To retrieve a list of the content you have authored, see
+ "View personally authored content":ViewMyContent
- 2. After selecting the piece of content you wish to update,
- select 'Edit' from the actions box.
+ 2. After selecting the piece of content you wish to update,
+ select 'Edit' from the actions box.
- 3. The 'Edit' link will take you to the edit form for your
- particular piece of content you wish to edit:
+ 3. The 'Edit' link will take you to the edit form for your
+ particular piece of content you wish to edit:
- - 'Body Textarea/File Upload' edit form (Documents)
+ - 'Body Textarea/File Upload' edit form (Documents)
- - 'Lead-in/Body' edit form (News Item)
+ - 'Lead-in/Body' edit form (News Item)
- - 'File Upload' edit form (Files, Images)
+ - 'File Upload' edit form (Files, Images)
- - 'Simple' edit form (Link, Favorite, Event)
+ - 'Simple' edit form (Link, Favorite, Event)
- Enter the changes you wish to make to the content in the form
- or browse to changed version of the content on your
- filesystem as appropriate.
+ Enter the changes you wish to make to the content in the form
+ or browse to changed version of the content on your
+ filesystem as appropriate.
- 4. Click the change button. The system will save your changes,
- and display a change notification on the edit form confirming
- that the change has taken place.
+ 4. Click the change button. The system will save your changes,
+ and display a change notification on the edit form confirming
+ that the change has taken place.
- 5. To view your changes, click the 'View' link from the actions
- box and view your content with the changes in place.
+ 5. To view your changes, click the 'View' link from the actions
+ box and view your content with the changes in place.
Modified: Products.CMFDefault/trunk/docs/narrative/ConfigurePersonalization.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/ConfigurePersonalization.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/ConfigurePersonalization.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,47 +1,51 @@
Use Case: Configure personalization options
============================================
- Actor
+Actor
+-----
- - Site Visitor
+ - Site Visitor
- Overview
+Overview
+--------
- One of the benefits of becoming a member of a CMF Site is the
- ability to create persistent personalizations of the way the
- site is displayed: in particular, this personalization allows
- the member to select from among the skins which have been
- configured by the Site Manager.
+ One of the benefits of becoming a member of a CMF Site is the
+ ability to create persistent personalizations of the way the
+ site is displayed: in particular, this personalization allows
+ the member to select from among the skins which have been
+ configured by the Site Manager.
- Assumptions
+Assumptions
+-----------
- - Site Visitor has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+ - Site Visitor has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
- Procedure
+Procedure
+---------
- 1. Click the 'Preferences' link in your top user actions bar.
+ 1. Click the 'Preferences' link in your top user actions bar.
- 2. On the personalization form, you have the option of
- modifying the following:
+ 2. On the personalization form, you have the option of
+ modifying the following:
- **E-mail address** --
- your contact email address, used to send you your password
- if you forget it. The site administrator may also use
- this email to contact you when necessary.
+ **E-mail address** --
+ your contact email address, used to send you your password
+ if you forget it. The site administrator may also use
+ this email to contact you when necessary.
- **Listing status (off/on)** --
- determines if you're login name is visible to other
- members when they select the 'members' link from the
- navigation bar.
+ **Listing status (off/on)** --
+ determines if you're login name is visible to other
+ members when they select the 'members' link from the
+ navigation bar.
- **Skin** --
- The 'look and feel' skin which is applied around the
- content of the site. The skin affects your 'view' while
- navigating the site.
+ **Skin** --
+ The 'look and feel' skin which is applied around the
+ content of the site. The skin affects your 'view' while
+ navigating the site.
- 3. Update these preferences as desired and select the change button.
+ 3. Update these preferences as desired and select the change button.
- 4. The system will save your preferences and redisplay the
- personalization form with the a message stating that your
- preferences have been changed.
+ 4. The system will save your preferences and redisplay the
+ personalization form with the a message stating that your
+ preferences have been changed.
Modified: Products.CMFDefault/trunk/docs/narrative/CreateCMFFolder.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/CreateCMFFolder.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/CreateCMFFolder.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,39 +1,44 @@
Use Case: Creating a CMF Folder
===============================
- Actor
+Actor
+-----
- - Site Manager
+ - Site Manager
- Overview
+Overview
+--------
- Folders may used in CMF to help organize content. Folders may contain
- any kind of content object, including subfolders.
+ Folders may used in CMF to help organize content. Folders may contain
+ any kind of content object, including subfolders.
- Assumptions
+Assumptions
+-----------
- - Foo
+ - Foo
- Procedure
+Procedure
+---------
- To create a new Folder at a given place in the site heirarchy, navigate
- to the place where you want to add the new Folder, then click the
- "Folder Contents" link in the actions box. This will bring up the
- "desktop" view of the current Folder, listing the content objects
- and subfolders. In the desktop view, click the "New..." button.
+ To create a new Folder at a given place in the site heirarchy, navigate
+ to the place where you want to add the new Folder, then click the
+ "Folder Contents" link in the actions box. This will bring up the
+ "desktop" view of the current Folder, listing the content objects
+ and subfolders. In the desktop view, click the "New..." button.
- You will now see the "Add Content" form. This form provides a list of
- the kinds of objects you can add at this location (based on the
- permissions you have), and descriptions of the available objects.
+ You will now see the "Add Content" form. This form provides a list of
+ the kinds of objects you can add at this location (based on the
+ permissions you have), and descriptions of the available objects.
- Select "Folder" from the listing, enter an id for the new folder in
- the "id" field located below the listing of available object, and
- click the "Add" button to add the new Folder.
+ Select "Folder" from the listing, enter an id for the new folder in
+ the "id" field located below the listing of available object, and
+ click the "Add" button to add the new Folder.
- After submitting the add form, you will be taken to the "desktop" view
- of the newly created Folder.
+ After submitting the add form, you will be taken to the "desktop" view
+ of the newly created Folder.
- Notes
+Notes
+-----
- - This use case is not specific to a Site Manager; it is
- properly a Content Creator use case.
+ - This use case is not specific to a Site Manager; it is
+ properly a Content Creator use case.
Modified: Products.CMFDefault/trunk/docs/narrative/CreateCMFSite.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/CreateCMFSite.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/CreateCMFSite.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,86 +1,90 @@
Use Case: Create a CMF Site
===========================
- Actor
+Actor
+-----
- - Site Manager
+ - Site Manager
- Overview
+Overview
+--------
- The top-level concept in the CMF is the idea of a "CMF Site". A
- CMF site is a content-oriented Web site with specific business
- goals, workflows, collaborations and audiences (content
- consumers).
+ The top-level concept in the CMF is the idea of a "CMF Site". A
+ CMF site is a content-oriented Web site with specific business
+ goals, workflows, collaborations and audiences (content
+ consumers).
- The "CMF Site" object is used in Zope to represent and manage a
- CMF Web site. The CMF Site object acts as a container for site
- components and content, and provides interfaces for configuring
- the functionality of the site.
+ The "CMF Site" object is used in Zope to represent and manage a
+ CMF Web site. The CMF Site object acts as a container for site
+ components and content, and provides interfaces for configuring
+ the functionality of the site.
- Assumptions
+Assumptions
+-----------
- - Site Manager is logged into the Zope Management Interface
- (ZMI) with a user ID having the "Add CMF Sites" permission
- at the desired location.
+ - Site Manager is logged into the Zope Management Interface
+ (ZMI) with a user ID having the "Add CMF Sites" permission
+ at the desired location.
- Procedure
+Procedure
+---------
- 1. From the ZMI, select "CMF Site" from the add list and click
- the "Add" button. This will bring up the "Add CMF Site" Web
- form. The elements on the add form are:
+ 1. From the ZMI, select "CMF Site" from the add list and click
+ the "Add" button. This will bring up the "Add CMF Site" Web
+ form. The elements on the add form are:
- **Id** --
- the id to be used for the new CMF Site object. This id
- will appear in URLs to the site and its subobjects. The id
- field is a required field.
+ **Id** --
+ the id to be used for the new CMF Site object. This id
+ will appear in URLs to the site and its subobjects. The id
+ field is a required field.
- **Title** --
- the title to be used for the new CMF Site object. The
- title provides a more human-friendly label for the site
- object. Providing a title is optional, but recommended.
+ **Title** --
+ the title to be used for the new CMF Site object. The
+ title provides a more human-friendly label for the site
+ object. Providing a title is optional, but recommended.
- **Membership Source** --
- the source of member information to be used by the new CMF
- Site. The default for this field is "Create a new user
- folder in the CMF Site". This option will create a new
- User Folder in the CMF Site to be used as the source of
- member data.
+ **Membership Source** --
+ the source of member information to be used by the new CMF
+ Site. The default for this field is "Create a new user
+ folder in the CMF Site". This option will create a new
+ User Folder in the CMF Site to be used as the source of
+ member data.
- You may also select "I have an existing user folder and
- want to use it instead". In this case, the CMF Site will
- draw its member information from a User Folder that
- already exists in the Zope object heirarchy above the new
- CMF Site.
+ You may also select "I have an existing user folder and
+ want to use it instead". In this case, the CMF Site will
+ draw its member information from a User Folder that
+ already exists in the Zope object heirarchy above the new
+ CMF Site.
- **Description** --
- a short description of the site. This description may be
- made available with syndicated content and may be used by
- some of the default user interface elements of the site.
- Providing a description is optional, but recommended.
+ **Description** --
+ a short description of the site. This description may be
+ made available with syndicated content and may be used by
+ some of the default user interface elements of the site.
+ Providing a description is optional, but recommended.
- After completing the Web form, click the "Add" button to
- create the new CMF Site object.
+ After completing the Web form, click the "Add" button to
+ create the new CMF Site object.
- 2. After submitting the form, the right frame of the ZMI should
- contain an administrative "welcome" page of the new CMF
- site. The welcome page provides links to:
+ 2. After submitting the form, the right frame of the ZMI should
+ contain an administrative "welcome" page of the new CMF
+ site. The welcome page provides links to:
- **The site configuration form** --
- This form allows you manage sitewide policies and
- configuration options. This should be your first stop
- after creating a CMF Site object.
+ **The site configuration form** --
+ This form allows you manage sitewide policies and
+ configuration options. This should be your first stop
+ after creating a CMF Site object.
- **The management interface** --
- The Zope management interface (ZMI) for CMF Site objects
- provides management-level access to the individual
- components of the site and provides for more advanced
- configuration options.
+ **The management interface** --
+ The Zope management interface (ZMI) for CMF Site objects
+ provides management-level access to the individual
+ components of the site and provides for more advanced
+ configuration options.
- **The site home page** --
- The default homepage of the new CMF site. This is what
- visitors and members of the site will initially see when
- they access the site through the Web.
+ **The site home page** --
+ The default homepage of the new CMF site. This is what
+ visitors and members of the site will initially see when
+ they access the site through the Web.
- 3. Now that the basic CMF Site object has been created, you
- should visit the site configuration form to continue setting
- up the new site.
+ 3. Now that the basic CMF Site object has been created, you
+ should visit the site configuration form to continue setting
+ up the new site.
Modified: Products.CMFDefault/trunk/docs/narrative/CreateCMFTopic.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/CreateCMFTopic.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/CreateCMFTopic.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,119 +1,124 @@
Use Case: Create CMF Topic
==========================
- Actor
+Actor
+-----
- - Site Manager[1]
+ - Site Manager[1]
- Overview
+Overview
+--------
- One of the ways you manage the structure of a CMF site is through
- the use of CMF Topics. Often a site is comprised of a large amount
- of content through which visitors are able to navigate. A Topic
- allows you to create a dynamic view onto the available content
- enabling visitors to drill down into that content.
+ One of the ways you manage the structure of a CMF site is through
+ the use of CMF Topics. Often a site is comprised of a large amount
+ of content through which visitors are able to navigate. A Topic
+ allows you to create a dynamic view onto the available content
+ enabling visitors to drill down into that content.
- Within each Topic can be configured a set of Criteria which
- constrain the list of content that appear when viewing the Topic.
- Topic Criteria can be based upon any of the data or meta-data that
- comprise your content.
+ Within each Topic can be configured a set of Criteria which
+ constrain the list of content that appear when viewing the Topic.
+ Topic Criteria can be based upon any of the data or meta-data that
+ comprise your content.
- Note that one useful meta-datam on which to base a Topic Criteria is
- "Subject," which is generally configured to allow a set of
- categories to be chosen when creating new content. These categories
- can then be used in a Topic Criteria to enable visitors to view
- categorized content. A standard pattern is to create a number of
- Topics which each correspond to a category.
+ Note that one useful meta-datam on which to base a Topic Criteria is
+ "Subject," which is generally configured to allow a set of
+ categories to be chosen when creating new content. These categories
+ can then be used in a Topic Criteria to enable visitors to view
+ categorized content. A standard pattern is to create a number of
+ Topics which each correspond to a category.
- Another example of a useful Topic is one which constrains your
- content by creation or modification date in order to display all
- recently changed content.
+ Another example of a useful Topic is one which constrains your
+ content by creation or modification date in order to display all
+ recently changed content.
- Assumptions
+Assumptions
+-----------
- - Site Manager has logged into the CMF (see "Login to the
- Site":LoginAsMember)
+ - Site Manager has logged into the CMF (see "Login to the
+ Site":LoginAsMember)
- Procedure
+Procedure
+---------
- 1. Select "Folder Contents" from the actions box and navigate
- to the folder which will contain the Topic.
+ 1. Select "Folder Contents" from the actions box and navigate
+ to the folder which will contain the Topic.
- 2. Click the "New..." button, which brings up the "Add Content"
- form allowing you to choose among the various content types
- that you are allowed to create. Select "Topic," type in an
- ID which will be used to identify the Topic in the future,
- and click "Add."
+ 2. Click the "New..." button, which brings up the "Add Content"
+ form allowing you to choose among the various content types
+ that you are allowed to create. Select "Topic," type in an
+ ID which will be used to identify the Topic in the future,
+ and click "Add."
- 3. The system will create the topic and present you with its
- "Edit Topic" form, which allows you to supply metadata about
- the topic.
+ 3. The system will create the topic and present you with its
+ "Edit Topic" form, which allows you to supply metadata about
+ the topic.
- **Title** --
- the name which will be displayed to visitors.
+ **Title** --
+ the name which will be displayed to visitors.
- **Description** --
- a brief paragraph describing the intended purpose of the
- Topic. The description will be used to annotate the topic
- object when it is included in another display (e.g., the
- view of its parent folder).
+ **Description** --
+ a brief paragraph describing the intended purpose of the
+ Topic. The description will be used to annotate the topic
+ object when it is included in another display (e.g., the
+ view of its parent folder).
- **Acquire criteria from parent** --
- when creating topic hierarchies[2], allows sub-topics to
- refine the search criteria they acquire from their
- parents.
+ **Acquire criteria from parent** --
+ when creating topic hierarchies[2], allows sub-topics to
+ refine the search criteria they acquire from their
+ parents.
- Click "Change" to save the changes you've made. The system
- will then show the default view of your new Topic, including
- the list of content which match the Topic's criteria and
- the list of the Topic's Criteria.
+ Click "Change" to save the changes you've made. The system
+ will then show the default view of your new Topic, including
+ the list of content which match the Topic's criteria and
+ the list of the Topic's Criteria.
- Note that since you have not yet set up any criteria, the
- Topic will match all content objects in the catalog.
+ Note that since you have not yet set up any criteria, the
+ Topic will match all content objects in the catalog.
- 4. To constrain the Topic's matches, select "Criteria" in the actions
- box. Create a new Criterion by filling out the "Add Criteria" form,
- which has the following fields:
+ 4. To constrain the Topic's matches, select "Criteria" in the actions
+ box. Create a new Criterion by filling out the "Add Criteria" form,
+ which has the following fields:
- **Field id** --
- a drop-down list containing the names of all indexed
- attributes. Select the value corresponding to the field
- to be searched by the criterion.
+ **Field id** --
+ a drop-down list containing the names of all indexed
+ attributes. Select the value corresponding to the field
+ to be searched by the criterion.
- **Criteria type** --
- the kind of search to apply. The standard types include:
+ **Criteria type** --
+ the kind of search to apply. The standard types include:
- *String Criterion* --
- matches all content objects for which the specified
- field in the content contains the supplied value
+ *String Criterion* --
+ matches all content objects for which the specified
+ field in the content contains the supplied value
- *Integer Criterion* --
- matches ranges or exact values for fields which are
- represented as whole numbers
+ *Integer Criterion* --
+ matches ranges or exact values for fields which are
+ represented as whole numbers
- *List Criterion* --
- matches content objects for which the specified field
- contains one of a set of string values.
+ *List Criterion* --
+ matches content objects for which the specified field
+ contains one of a set of string values.
- *Friendly Date Criterion* --
- applies a range search to a date field, relative to the
- current time.
+ *Friendly Date Criterion* --
+ applies a range search to a date field, relative to the
+ current time.
- Click "Add" to create the criterion and add it to the
- Topic.
+ Click "Add" to create the criterion and add it to the
+ Topic.
- 5. Fill in the value of the "Criterion value" and click "Save
- changes." You may continue to add criteria which each further
- constrain the content matched by the Topic.
+ 5. Fill in the value of the "Criterion value" and click "Save
+ changes." You may continue to add criteria which each further
+ constrain the content matched by the Topic.
- 6. To view the content matching the current set of criteria,
- select "View" from the actions box.
+ 6. To view the content matching the current set of criteria,
+ select "View" from the actions box.
- Notes
+Notes
+-----
- ..[1] Like "Create Folder", this is not solely the prerogative of
- Site Managers; Content Creators build topics.
+..[1] Like "Create Folder", this is not solely the prerogative of
+ Site Managers; Content Creators build topics.
- ..[2] See "Add a Subtopic":AddSubtopic for an explanation of topic
- hierarchies.
+..[2] See "Add a Subtopic":AddSubtopic for an explanation of topic
+ hierarchies.
Modified: Products.CMFDefault/trunk/docs/narrative/CreateNewContent.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/CreateNewContent.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/CreateNewContent.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,99 +1,103 @@
Use Case: Create Content Object
================================
- Actor
+Actor
+-----
- - Content Creator
+ - Content Creator
- Assumptions
+Assumptions
+-----------
- - Content Creator has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+ - Content Creator has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
- Procedure
+Procedure
+---------
- 1. Navigate to a location within CMF where you have rights to
- add content. For example, select 'My Stuff' from your
- navigation bar to create the content in your member folder.
+ 1. Navigate to a location within CMF where you have rights to
+ add content. For example, select 'My Stuff' from your
+ navigation bar to create the content in your member folder.
- 2. If needed, select the 'Folder contents' link from the action
- box.
+ 2. If needed, select the 'Folder contents' link from the action
+ box.
- 3. Click the "New" button. The system will display the "Add
- Content" page. From the list of available content types[1],
- select the radio button corresponding to the type of content
- which you wish to create. Enter an appropriate ID[2] for
- the new piece of content, and click the "Add" button.
+ 3. Click the "New" button. The system will display the "Add
+ Content" page. From the list of available content types[1],
+ select the radio button corresponding to the type of content
+ which you wish to create. Enter an appropriate ID[2] for
+ the new piece of content, and click the "Add" button.
- 4. The system will create a new, empty content object of the
- type you selected, and display the "Standard Resource Metadata"
- edit form. This form, common across all of the default
- content types which come stock with the CMF, allows you to
- enter specific metadata about your new content:
+ 4. The system will create a new, empty content object of the
+ type you selected, and display the "Standard Resource Metadata"
+ edit form. This form, common across all of the default
+ content types which come stock with the CMF, allows you to
+ enter specific metadata about your new content:
- **Title** --
- A string used to identify your content.
+ **Title** --
+ A string used to identify your content.
- **Description** --
- A short summary of the content.
+ **Description** --
+ A short summary of the content.
- **Subject** --
- A set of keywords, used for cataloging your content.
+ **Subject** --
+ A set of keywords, used for cataloging your content.
- The form provides three submit buttons, each of which saves
- your content:
+ The form provides three submit buttons, each of which saves
+ your content:
- **Change** --
- commits your changes and return to the metadata form.
+ **Change** --
+ commits your changes and return to the metadata form.
- **Change and Edit** --
- commits your changes and redirects to the edit form, which
- will allow you to enter the "body" of your content.
+ **Change and Edit** --
+ commits your changes and redirects to the edit form, which
+ will allow you to enter the "body" of your content.
- **Change and View** --
- commit your changes and proceed to viewing your new piece
- of content.
+ **Change and View** --
+ commit your changes and proceed to viewing your new piece
+ of content.
- 5. Select "Change and Edit", and supply the initial content for
- your object as follows:
+ 5. Select "Change and Edit", and supply the initial content for
+ your object as follows:
- **Document** --
- Enter the text for your object, as either Structured
- Text[3] or HTML[4]. You may either type or paste the text
- into the textarea, or upload it from your computer.
+ **Document** --
+ Enter the text for your object, as either Structured
+ Text[3] or HTML[4]. You may either type or paste the text
+ into the textarea, or upload it from your computer.
- **News Item** --
- Fill out the "Lead-in" and "Body" text areas.
+ **News Item** --
+ Fill out the "Lead-in" and "Body" text areas.
- **File / Image** --
- Upload the content from your computer.
+ **File / Image** --
+ Upload the content from your computer.
- **Link / Favorite / Event** --
- Fill out the form with appropriate values.
+ **Link / Favorite / Event** --
+ Fill out the form with appropriate values.
- Fill out the form and select the "Change" button to save your
- content.
+ Fill out the form and select the "Change" button to save your
+ content.
- 6. You may wish to continue with one of the workflow use cases:
+ 6. You may wish to continue with one of the workflow use cases:
- - "Submit Content for Review":SubmitContentForReview
+ - "Submit Content for Review":SubmitContentForReview
- - "Publish Content":PublishContent
+ - "Publish Content":PublishContent
- Notes
+Notes
+-----
- ..[1] see "Default CMF Content Types",DefaultContentTypes.stx.
+ ..[1] see "Default CMF Content Types",DefaultContentTypes.stx.
- ..[2] Don't confuse the content's ID with the its Title. ID's cannot
- contain special characters (e.g., comma, asterisk, brackets,
- parentheses, etc.) A good practise is not to use spaces in
- an ID either. The ID is used in the URL to reach the folder's
- content, so any character which is not allowed in a URI is not
- allowed in the id (see "URI RFC",
- http://www.ietf.org/rfc/rfc2396.txt).
+ ..[2] Don't confuse the content's ID with the its Title. ID's cannot
+ contain special characters (e.g., comma, asterisk, brackets,
+ parentheses, etc.) A good practise is not to use spaces in
+ an ID either. The ID is used in the URL to reach the folder's
+ content, so any character which is not allowed in a URI is not
+ allowed in the id (see "URI RFC",
+ http://www.ietf.org/rfc/rfc2396.txt).
- ..[3] See "Structured Text Introduction":StructuredTextIntro
+ ..[3] See "Structured Text Introduction":StructuredTextIntro
- ..[4] The HTML you enter will have everything outside the BODY
- tag stripped off; the TITLE and META tags will be used, if
- present, to update the content's metadata.
+ ..[4] The HTML you enter will have everything outside the BODY
+ tag stripped off; the TITLE and META tags will be used, if
+ present, to update the content's metadata.
Modified: Products.CMFDefault/trunk/docs/narrative/LoginAsMember.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/LoginAsMember.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/LoginAsMember.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,29 +1,32 @@
Use Case: Login To The Site
===========================
- Actor
+Actor
+-----
- - Site Visitor
+ - Site Visitor
- Overview
+Overview
+--------
- Visitors to a site who have registered as members must login to the
- site to use member-only services.
+ Visitors to a site who have registered as members must login to the
+ site to use member-only services.
- Procedure
+Procedure
+---------
- 1. Visit the homepage of the site and click the "Log in" link on the
- menu (located at the left of the page in a default CMF site).
+ 1. Visit the homepage of the site and click the "Log in" link on the
+ menu (located at the left of the page in a default CMF site).
- The "Log in" link will take you to a form where you may
- enter your username and password for the site. You may also
- select the "remember my name" checkbox and the site will
- fill in your username on the form for you the next time you
- login.
+ The "Log in" link will take you to a form where you may
+ enter your username and password for the site. You may also
+ select the "remember my name" checkbox and the site will
+ fill in your username on the form for you the next time you
+ login.
- 2. Once you have entered your name and password, click the
- "Login" button to login to the site. You should then see a
- message letting you know that you have been successfully
- logged in. If you did not type your username or password
- correctly, you will see a page telling you that the login
- did not succeed.
+ 2. Once you have entered your name and password, click the
+ "Login" button to login to the site. You should then see a
+ message letting you know that you have been successfully
+ logged in. If you did not type your username or password
+ correctly, you will see a page telling you that the login
+ did not succeed.
Modified: Products.CMFDefault/trunk/docs/narrative/ManageLocalRoles.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/ManageLocalRoles.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/ManageLocalRoles.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,48 +1,52 @@
Use Case: Give local roles to other users
==========================================
- Actor
+Actor
+-----
- - Content Creator
+ - Content Creator
- Overview
+Overview
+--------
- In order to collaborate on a set of content, each contributor
- must have the appropriate permissions to create and revise
- content.
+ In order to collaborate on a set of content, each contributor
+ must have the appropriate permissions to create and revise
+ content.
- Assumptions
+Assumptions
+-----------
- - Content Creator has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+ - Content Creator has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
- Procedure
+Procedure
+---------
- 1. Navigate to a folder where you wish to give local roles to
- other users so you can collaborate on content.
+ 1. Navigate to a folder where you wish to give local roles to
+ other users so you can collaborate on content.
- 2. Select 'Folder contents' from the actions box.
+ 2. Select 'Folder contents' from the actions box.
- 3. Select 'Set local roles' from the actions box.
+ 3. Select 'Set local roles' from the actions box.
- 4. Fill out the search form as follows:
+ 4. Fill out the search form as follows:
- **Search Term** --
- Enter the name or email address of the user to whom you wish
- to assign local roles.
+ **Search Term** --
+ Enter the name or email address of the user to whom you wish
+ to assign local roles.
- **Search By** --
- Selected the appropriate drop down which corresponds to
- the kind of search term you have entered (e.g. 'Email Address'
- or 'User ID')
+ **Search By** --
+ Selected the appropriate drop down which corresponds to
+ the kind of search term you have entered (e.g. 'Email Address'
+ or 'User ID')
- 5. Click the Search button. The system will redisplay the
- form, showing a list of users matching your criterion.
+ 5. Click the Search button. The system will redisplay the
+ form, showing a list of users matching your criterion.
- 6. Select users by checking the corresponding checkbox. Select
- the role to assign to the selected user(s) from the drop
- down menu labled **Role to Assign**. Click the "Assign Roles"
- button. The system will assign the selected role to the
- selected users, and redisplay the local roles form with a
- message indicating the change.
+ 6. Select users by checking the corresponding checkbox. Select
+ the role to assign to the selected user(s) from the drop
+ down menu labled **Role to Assign**. Click the "Assign Roles"
+ button. The system will assign the selected role to the
+ selected users, and redisplay the local roles form with a
+ message indicating the change.
Modified: Products.CMFDefault/trunk/docs/narrative/ProvideFeedback.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/ProvideFeedback.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/ProvideFeedback.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,52 +1,55 @@
Use Case: Provide feedback on content
======================================
- Actor
+Actor
+-----
- - Site Visitor
+ - Site Visitor
- Assumptions
+Assumptions
+-----------
- - The Site Manager has configured the permissions of the site
- to allow anonymous users to discuss published content
+ - The Site Manager has configured the permissions of the site
+ to allow anonymous users to discuss published content
- **or**
+ **or**
- the Site Visitor has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+ the Site Visitor has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
- - The Site Manager has enabled discussion for the content type
- of the item for which the Site Visitor wishes to provide
- feedback.
+ - The Site Manager has enabled discussion for the content type
+ of the item for which the Site Visitor wishes to provide
+ feedback.
- Procedure
+Procedure
+---------
- 1. Navigate to the content on which you wish to provide feedback
+ 1. Navigate to the content on which you wish to provide feedback
- 2. Select 'Reply' from the actions box. The system will
- display the reply form for the object.
+ 2. Select 'Reply' from the actions box. The system will
+ display the reply form for the object.
- **Reply Title** --
- an input field for the title of your feedback; initially,
- the field will have the title of the object to which you
- are replying.
+ **Reply Title** --
+ an input field for the title of your feedback; initially,
+ the field will have the title of the object to which you
+ are replying.
- **Reply** --
- a textarea for entering feedback.
+ **Reply** --
+ a textarea for entering feedback.
- **Preview** --
- a submit button which permits you to preview your reply
- before submitting it.
+ **Preview** --
+ a submit button which permits you to preview your reply
+ before submitting it.
- **Reply** --
- a submit button for creating your reply.
+ **Reply** --
+ a submit button for creating your reply.
- 3. Update the title, if desired, and enter your comment into
- the textarea.
+ 3. Update the title, if desired, and enter your comment into
+ the textarea.
- 4. Click the "Preview" button to check that your reply will be
- formatted as you desire. If not, return to the reply form
- using the "Edit" button.
+ 4. Click the "Preview" button to check that your reply will be
+ formatted as you desire. If not, return to the reply form
+ using the "Edit" button.
- 5. Click the "Reply" button. The system will append your comment
- to the thread of replies on the target object.
+ 5. Click the "Reply" button. The system will append your comment
+ to the thread of replies on the target object.
Modified: Products.CMFDefault/trunk/docs/narrative/RemoveContent.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/RemoveContent.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/RemoveContent.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,29 +1,32 @@
Use Case: Remove unneeded content
==================================
- Actor
+Actor
+-----
- - Content Creator
+ - Content Creator
- Assumptions
+Assumptions
+-----------
- - Content Creator has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+ - Content Creator has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
- Procedure
+Procedure
+---------
- 1. Navigate to the content to be deleted.
+ 1. Navigate to the content to be deleted.
- To retrieve a list of the content you have authored, see Use
- Case: "View personally authored content":ViewMyContent
+ To retrieve a list of the content you have authored, see Use
+ Case: "View personally authored content":ViewMyContent
- 2. Select 'Folder contents' from the actions box.
+ 2. Select 'Folder contents' from the actions box.
- 3. Select the content to be delete from by checking the corresponding
- checkbox. Click the "Delete" button.
+ 3. Select the content to be delete from by checking the corresponding
+ checkbox. Click the "Delete" button.
- 4. The system will delete the content from the folder and redirect
- to the folder contents view, adding a notification message which
- indicates that the selected content has been deleted.
+ 4. The system will delete the content from the folder and redirect
+ to the folder contents view, adding a notification message which
+ indicates that the selected content has been deleted.
- 5. To undo this action, see "Undo changes to content":UndoChanges
+ 5. To undo this action, see "Undo changes to content":UndoChanges
Modified: Products.CMFDefault/trunk/docs/narrative/RenameContent.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/RenameContent.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/RenameContent.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,39 +1,43 @@
Use Case: Rename Content
=========================
- Actor
+Actor
+-----
- - Content Creator
+ - Content Creator
- Overview
+Overview
+--------
- The ID which an author assigns to a piece of content at
- creation time[1] may laterturn out to be inappropriate.
+ The ID which an author assigns to a piece of content at
+ creation time[1] may laterturn out to be inappropriate.
- Assumptions
+Assumptions
+-----------
- - Content Creator has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+ - Content Creator has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
- Procedure
+Procedure
+---------
- 1. Navigate to the folder containing the piece of content which
- you would like to rename.
+ 1. Navigate to the folder containing the piece of content which
+ you would like to rename.
- To retrieve a list of the content you have authored,
- see "View personally authored content":ViewMyContent.
+ To retrieve a list of the content you have authored,
+ see "View personally authored content":ViewMyContent.
- 2. In the "Folder contents" view of the folder, check the box next to
- the content object(s) which you would like to rename.
+ 2. In the "Folder contents" view of the folder, check the box next to
+ the content object(s) which you would like to rename.
- 3. Click the "Rename" button.
+ 3. Click the "Rename" button.
- 4. The system will display a form listing each selected content object,
- with input fields for the new ID for each. Supply new IDs, and click
- the "OK" button.
+ 4. The system will display a form listing each selected content object,
+ with input fields for the new ID for each. Supply new IDs, and click
+ the "OK" button.
- 5. The content has now been renamed; you will be redirected to the
- folder contents listing with a notification message to that effect.
+ 5. The content has now been renamed; you will be redirected to the
+ folder contents listing with a notification message to that effect.
- 6. To undo this action, see "Undo changes to content":UndoChanges.
+ 6. To undo this action, see "Undo changes to content":UndoChanges.
Modified: Products.CMFDefault/trunk/docs/narrative/SearchCMFSite.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/SearchCMFSite.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/SearchCMFSite.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,56 +1,60 @@
Use Case: Search site for information
======================================
- Actor
+Actor
+-----
- - Site Visitor
+ - Site Visitor
- Overview
+Overview
+--------
- Procedure
+Procedure
+---------
- 1. Select the "Search" link from the masthead of any page. The
- system will display a form allowing you to specify the
- criteria for your search:
+ 1. Select the "Search" link from the masthead of any page. The
+ system will display a form allowing you to specify the
+ criteria for your search:
- **Full text search** --
- enter one or more words you expect to find in the
- "searchable text" of your content (searchable text
- normally consists of the textual content, if any, plus the
- title and description).
+ **Full text search** --
+ enter one or more words you expect to find in the
+ "searchable text" of your content (searchable text
+ normally consists of the textual content, if any, plus the
+ title and description).
- **Title** --
- Enter one or more words you expecte to find in the Title
- of the content.
+ **Title** --
+ Enter one or more words you expecte to find in the Title
+ of the content.
- **Subject** --
- Select one or more keywords from the available seletion
- box.
+ **Subject** --
+ Select one or more keywords from the available seletion
+ box.
- **Description** --
- Enter one or more words you expecte to find in the
- Description of the content.
+ **Description** --
+ Enter one or more words you expecte to find in the
+ Description of the content.
- **Find new items since...** --
- Select one of the options which corrsponds to the range of
- time in which objects were created.
+ **Find new items since...** --
+ Select one of the options which corrsponds to the range of
+ time in which objects were created.
- **Item Type** --
- Select one or more content types from the seletion box.
+ **Item Type** --
+ Select one or more content types from the seletion box.
- **Creator** --
- Enter the user ID of the user who created the content.
+ **Creator** --
+ Enter the user ID of the user who created the content.
- Enter your search criteria and select the search button.
+ Enter your search criteria and select the search button.
- 2. The system will return a results page listing the first
- twenty matching objects. For each matching item, the
- results page displays the Title, the Description, and the
- "last modified" date; the Title is also a link to the
- object.
+ 2. The system will return a results page listing the first
+ twenty matching objects. For each matching item, the
+ results page displays the Title, the Description, and the
+ "last modified" date; the Title is also a link to the
+ object.
- Alternatives
+Alternatives
+------------
- 1. Enter one or more "full text" search words in the "quick
- search" form in the masthead of any page. Click the "go"
- button. Continue with step #3 above.
+ 1. Enter one or more "full text" search words in the "quick
+ search" form in the masthead of any page. Click the "go"
+ button. Continue with step #3 above.
Modified: Products.CMFDefault/trunk/docs/narrative/SubmitContentForPublication.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/SubmitContentForPublication.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/SubmitContentForPublication.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,38 +1,42 @@
Use Case: Submit Content for Publication
=========================================
- Actor
+Actor
+-----
- - Content Creator
+ - Content Creator
- Overview
+Overview
+--------
- Non-privileged content creators site need to get review of
- their content before it can be published to all Site Visitors.
+ Non-privileged content creators site need to get review of
+ their content before it can be published to all Site Visitors.
- Assumptions
+Assumptions
+-----------
- - Content Creator has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+ - Content Creator has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
- - Content Creator has created a piece of content which she
- wishes to publish (see "Create Content Object":CreateNewContent).
+ - Content Creator has created a piece of content which she
+ wishes to publish (see "Create Content Object":CreateNewContent).
- Procedure
+Procedure
+---------
- 1. Navigate to the piece of content you wish to submit for
- publication.
+ 1. Navigate to the piece of content you wish to submit for
+ publication.
- To retrieve a list of the content you have authored, see
- "View personally authored content":ViewMyContent
+ To retrieve a list of the content you have authored, see
+ "View personally authored content":ViewMyContent
- 2. Select 'Submit' from the actions box. The system will
- display the "Submit Content" form:
+ 2. Select 'Submit' from the actions box. The system will
+ display the "Submit Content" form:
- **Comment** --
- A textarea for including an optional comment to the
- reviewer.
+ **Comment** --
+ A textarea for including an optional comment to the
+ reviewer.
- 3. The system will mark your content as "pending review".
- Reviewers will be notified your content is pending review
- (see "Approve content for publication":ApproveForPublication).
+ 3. The system will mark your content as "pending review".
+ Reviewers will be notified your content is pending review
+ (see "Approve content for publication":ApproveForPublication).
Modified: Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Overview.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Overview.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Overview.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,51 +1,52 @@
SyndicationTool - Overview: CMF Syndication Overview
====================================================
- Description
+Description
+-----------
- The SyndicationTool allows for sitewide syndication of content in folders
- (or folder-like objects which support the synContentValues interface).
- Currently on the SyndicationTool the following features are present:
+ The SyndicationTool allows for sitewide syndication of content in folders
+ (or folder-like objects which support the synContentValues interface).
+ Currently on the SyndicationTool the following features are present:
- 1. Enable/disable sitewide syndication.
+ 1. Enable/disable sitewide syndication.
- 2. Override my Syndicaiton Element defaults on the Properties
- management form.
+ 2. Override my Syndicaiton Element defaults on the Properties
+ management form.
- Once sitewide syndication has been enabled, the Syndication action on
- folders is enabled, allowing syndication for a specific folder to be
- enabled. This is to protect calling the RSS dtml method on folder
- contents one wishes to remain non-syndicated. A 'syndication_information'
- object is set on the folder which acts as the 'propertysheet' for over-
- riding sitewide defaults for each particular syndication instance.
+ Once sitewide syndication has been enabled, the Syndication action on
+ folders is enabled, allowing syndication for a specific folder to be
+ enabled. This is to protect calling the RSS dtml method on folder
+ contents one wishes to remain non-syndicated. A 'syndication_information'
+ object is set on the folder which acts as the 'propertysheet' for over-
+ riding sitewide defaults for each particular syndication instance.
- In the next revision of the SyndicationTool, the following features are
- being planned:
+ In the next revision of the SyndicationTool, the following features are
+ being planned:
- 1. Reimplementation of the manner properties are called on the
- SyndicationTool class and instance, as well as on the 'syndication-
- information' object. A getElementProperty method will handle generic
- grabing of properties.
+ 1. Reimplementation of the manner properties are called on the
+ SyndicationTool class and instance, as well as on the 'syndication-
+ information' object. A getElementProperty method will handle generic
+ grabing of properties.
- 2. Adding the ability to addElementProperties, to allow for easily
- enabling additional XML namespaces to be incorporated on an instance
- without requiring reimplementation of the SyndicationTool.
+ 2. Adding the ability to addElementProperties, to allow for easily
+ enabling additional XML namespaces to be incorporated on an instance
+ without requiring reimplementation of the SyndicationTool.
- 3. Default sitewide properties for the dublin core module support.
+ 3. Default sitewide properties for the dublin core module support.
- 4. Sitewide enabling/disabling override switches for the supported
- XML namespace module default values.
+ 4. Sitewide enabling/disabling override switches for the supported
+ XML namespace module default values.
- 5. Sitewide/Folder level content filtering of content returned back
- in the itemRSS DTML method to allow for selective content returned
- for the syndication.
+ 5. Sitewide/Folder level content filtering of content returned back
+ in the itemRSS DTML method to allow for selective content returned
+ for the syndication.
- 6. Sort Order setting. Allow the setting of how the content is sorted
- in the syndication.
+ 6. Sort Order setting. Allow the setting of how the content is sorted
+ in the syndication.
- 7. Add switch to disallow acquisition to disable sub-folder syndication
- within an existing syndicated folder.
+ 7. Add switch to disallow acquisition to disable sub-folder syndication
+ within an existing syndicated folder.
- 8. Other features are possible as users give feedback on the
- Syndication implementation.
+ 8. Other features are possible as users give feedback on the
+ Syndication implementation.
Modified: Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Policies.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Policies.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Policies.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,13 +1,15 @@
SyndicationTool - Policies: Manage the policies of a Site's Syndication Instance
================================================================================
- Description
+Description
+-----------
- View and manage the prolicies of a sitewide syndication instance.
+ View and manage the prolicies of a sitewide syndication instance.
- Controls
+Controls
+--------
- 'Allow-Override' -- Each of the properties configureable from the Properties
- management form will have an override switch on the policies management form.
- This is currently unavailable and will be incorporated into the 1.1 release
- of the SyndicationTool.
+ 'Allow-Override' -- Each of the properties configureable from the Properties
+ management form will have an override switch on the policies management form.
+ This is currently unavailable and will be incorporated into the 1.1 release
+ of the SyndicationTool.
Modified: Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Properties.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Properties.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Properties.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,41 +1,43 @@
SyndicationTool - Properties: Manage the properties of a Site's Syndication Instance
====================================================================================
- Description
+Description
+-----------
- View and manage the properties of a sitewide syndication instance.
+ View and manage the properties of a sitewide syndication instance.
- Controls
+Controls
+--------
- 'Enable/Disable Syndication' -- Turns enables/disables sitewide syndication.
- All methods check whether site syndication is enabled to ensure a sitewide policy
- is enforceable.
+ 'Enable/Disable Syndication' -- Turns enables/disables sitewide syndication.
+ All methods check whether site syndication is enabled to ensure a sitewide policy
+ is enforceable.
- 'Syndication Module' -- The RSS sy XMLNS is supported in this tool by default.
- The following properties are editable on the tool for sitewide configuring of each
- of the elements of the syndication module. In this release, they are over-rideable;
- these will be configurable in version 1.1 to enable a sitewide policy.
+ 'Syndication Module' -- The RSS sy XMLNS is supported in this tool by default.
+ The following properties are editable on the tool for sitewide configuring of each
+ of the elements of the syndication module. In this release, they are over-rideable;
+ these will be configurable in version 1.1 to enable a sitewide policy.
- 'UpdatePeriod' -- Describes the period over which the channel format is updated.
- Acceptable values are: hourly, daily, weekly, monthly, yearly.
- If omitted, daily is assumed.
+ 'UpdatePeriod' -- Describes the period over which the channel format is updated.
+ Acceptable values are: hourly, daily, weekly, monthly, yearly.
+ If omitted, daily is assumed.
- 'UpdateFrequency' -- Used to describe the frequency of updates in relation to the
- update period. A positive integer indicates how many times in that period the channel
- is updated. For example, an updatePeriod of daily, and an updateFrequency of 2
- indicates the channel format is updated twice daily.
- If omitted a value of 1 is assumed
+ 'UpdateFrequency' -- Used to describe the frequency of updates in relation to the
+ update period. A positive integer indicates how many times in that period the channel
+ is updated. For example, an updatePeriod of daily, and an updateFrequency of 2
+ indicates the channel format is updated twice daily.
+ If omitted a value of 1 is assumed
- 'UpdateBase' -- Defines a base date to be used in concert with updatePeriod and
- updateFrequency to calculate the publishing schedule. By default the sitewide
- date is the DateTime of the tool initialization. The UpdateBase in the RSS XML
- takes this DateTime object and sringify's it through DateTime.HTML4()
- The date format takes the form: yyyy-mm-ddThh:mm
+ 'UpdateBase' -- Defines a base date to be used in concert with updatePeriod and
+ updateFrequency to calculate the publishing schedule. By default the sitewide
+ date is the DateTime of the tool initialization. The UpdateBase in the RSS XML
+ takes this DateTime object and sringify's it through DateTime.HTML4()
+ The date format takes the form: yyyy-mm-ddThh:mm
- 'Max Items' -- Defines the max number of items which are included in the syndication.
- The RSS Specification recommends this not exceed 15, which is the default.
+ 'Max Items' -- Defines the max number of items which are included in the syndication.
+ The RSS Specification recommends this not exceed 15, which is the default.
- 'DublinCore Module' -- The RSS dc XMLNS is supported in this tool by default.
- The sitewide properties will be editable on the tool for sitewide configuring of each
- of the elements of the dublin core module. In this release, they are over-rideable;
- these will be configurable in version 1.1 to enable a sitewide policy.
+ 'DublinCore Module' -- The RSS dc XMLNS is supported in this tool by default.
+ The sitewide properties will be editable on the tool for sitewide configuring of each
+ of the elements of the dublin core module. In this release, they are over-rideable;
+ these will be configurable in version 1.1 to enable a sitewide policy.
Modified: Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Reporting.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Reporting.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Reporting.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,12 +1,13 @@
SyndicationTool - Overview: CMF Syndication Reporting Facility
==============================================================
- Description
+Description
+-----------
- The SyndicationTool Reporting Facility is planned to be added to
- the next release of the Syndication services for the CMF.
- I hope to have generated enough feedback from users who might have
- definate ideas which would make a good foundation as a default
- suite of reports. The plan is not to be all inclusive, but to
- provide a mechanism to generate interesting SiteAdmin data regarding
- the use of Syndication within their sites.
+ The SyndicationTool Reporting Facility is planned to be added to
+ the next release of the Syndication services for the CMF.
+ I hope to have generated enough feedback from users who might have
+ definate ideas which would make a good foundation as a default
+ suite of reports. The plan is not to be all inclusive, but to
+ provide a mechanism to generate interesting SiteAdmin data regarding
+ the use of Syndication within their sites.
Modified: Products.CMFDefault/trunk/docs/narrative/TODO.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/TODO.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/TODO.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,55 +1,60 @@
Missing Use Cases
=================
- "ContentCreator":Actor_ContentCreator
+"ContentCreator":Actor_ContentCreator
+-------------------------------------
- - "Define content metadata":ChangeMetadata
+ - "Define content metadata":ChangeMetadata
- - "Make a content object discussable":EnableDiscussion
+ - "Make a content object discussable":EnableDiscussion
- "MembershipManager":Actor_MembershipManager
+"MembershipManager":Actor_MembershipManager
+-------------------------------------------
- - "Add a new member to the site using a standard user
- folder":AddMemberToUserFolder
+ - "Add a new member to the site using a standard user
+ folder":AddMemberToUserFolder
- - "Change member information and abilities":ChangeMemberInformation
+ - "Change member information and abilities":ChangeMemberInformation
- - "Browse member roster":BrowseMemberRoster
+ - "Browse member roster":BrowseMemberRoster
- - "Remove a member from the site":RemoveMemberFromSite
+ - "Remove a member from the site":RemoveMemberFromSite
- "SiteDesigner":Actor_SiteDesigner
+"SiteDesigner":Actor_SiteDesigner
+---------------------------------
- - "Create new skin for the site":CreateNewSkin
+ - "Create new skin for the site":CreateNewSkin
- - "Modify skin appearance":ChangeSkinLookAndFeel
+ - "Modify skin appearance":ChangeSkinLookAndFeel
- - "Change skin behavior":ChangeSkinBehavior
+ - "Change skin behavior":ChangeSkinBehavior
- - "Change the default skin for the site":ChangeDefaultSiteSkin
+ - "Change the default skin for the site":ChangeDefaultSiteSkin
- "SiteManager":Actor_SiteManager
+"SiteManager":Actor_SiteManager
+-------------------------------
- - "Configure CMF Topic":ConfigureCMFTopic
+ - "Configure CMF Topic":ConfigureCMFTopic
- - "Configure what types of content can be created
- by users":ConfigureAllowedContentTypes
+ - "Configure what types of content can be created
+ by users":ConfigureAllowedContentTypes
- - "Configure security for a content object
- or folder":ConfigureObjectSecurity
+ - "Configure security for a content object
+ or folder":ConfigureObjectSecurity
- - "Associate a workflow with a content
- type":AssociateWorkflowWithContentType
+ - "Associate a workflow with a content
+ type":AssociateWorkflowWithContentType
- - "Configure required metadata for a content
- type":ConfigureRequiredMetadata
+ - "Configure required metadata for a content
+ type":ConfigureRequiredMetadata
- - "Configure what content is released via
- syndication":ConfigureContentSyndiation
+ - "Configure what content is released via
+ syndication":ConfigureContentSyndiation
- "SiteVisitor":Actor_SiteVisitor
+"SiteVisitor":Actor_SiteVisitor
+-------------------------------
- - "Submit a news item":SubmitNewsItem
+ - "Submit a news item":SubmitNewsItem
- - "Browse a portal topic":BrowsePortalTopic
+ - "Browse a portal topic":BrowsePortalTopic
Modified: Products.CMFDefault/trunk/docs/narrative/UndoChanges.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/UndoChanges.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/UndoChanges.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,37 +1,41 @@
Use Case: Undo Changes to Content
==================================
- Actor
+Actor
+-----
- - Content Creator
+ - Content Creator
- Assumptions
+Assumptions
+-----------
- - Content Creator has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+ - Content Creator has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
- - Content Creator has made changes to content which she wishes
- to undo (see "Update existing content":ChangeContent).
+ - Content Creator has made changes to content which she wishes
+ to undo (see "Update existing content":ChangeContent).
- - The changes are "undoable"[1].
+ - The changes are "undoable"[1].
- Procedure
+Procedure
+---------
- 1. Select 'Undo' from the actions box. The system will present
- a list of the transactions which you have permission to undo.
+ 1. Select 'Undo' from the actions box. The system will present
+ a list of the transactions which you have permission to undo.
- 2. Select the checkbox next to the transaction which you wish to
- undo and click the undo button. The system will undo that
- transaction and redisplay the list of transactions.
+ 2. Select the checkbox next to the transaction which you wish to
+ undo and click the undo button. The system will undo that
+ transaction and redisplay the list of transactions.
- Notes
+Notes
+-----
- ..[1] Transactions which involve changing content remain undoable
- until one or more objects modified by the transaction are
- modified by a subsequent transaction. Normally, this means
- that only the latest transaction to an object is undoable,
- unless the later transactions are also undone.
+..[1] Transactions which involve changing content remain undoable
+ until one or more objects modified by the transaction are
+ modified by a subsequent transaction. Normally, this means
+ that only the latest transaction to an object is undoable,
+ unless the later transactions are also undone.
- It is also possible to have transactions above the
- transaction in the list which do not effect the ability to
- undo a change a user wishes to undo.
+ It is also possible to have transactions above the
+ transaction in the list which do not effect the ability to
+ undo a change a user wishes to undo.
Modified: Products.CMFDefault/trunk/docs/narrative/UnpublishContent.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/UnpublishContent.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/UnpublishContent.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,28 +1,31 @@
Use Case: Remove content from public site
==========================================
- Actor
+Actor
+-----
- - Reviewer
+ - Reviewer
- Assumptions
+Assumptions
+-----------
- - Reviewer has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+ - Reviewer has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
- - Content has been published which now needs to be unpublished
- (see "Approve content for publication":ApproveForPublication).
+ - Content has been published which now needs to be unpublished
+ (see "Approve content for publication":ApproveForPublication).
- Procedure
+Procedure
+---------
- 1. Navigate to the content item you wish to remove from the
- publically visible site.
+ 1. Navigate to the content item you wish to remove from the
+ publically visible site.
- 2. Select 'Reject' from the actions box.
+ 2. Select 'Reject' from the actions box.
- 3. Enter comments explaining why the object is being removed
- from the public site.
+ 3. Enter comments explaining why the object is being removed
+ from the public site.
- 4. Select the "Reject" button. The system moves the item to
- the "private" state, making it no longer visible on your
- public site.
+ 4. Select the "Reject" button. The system moves the item to
+ the "private" state, making it no longer visible on your
+ public site.
Modified: Products.CMFDefault/trunk/docs/narrative/ViewMyContent.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/ViewMyContent.rst 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/docs/narrative/ViewMyContent.rst 2012-04-04 09:14:27 UTC (rev 124942)
@@ -1,32 +1,36 @@
Use Case: View personally authored content
===========================================
- Actor
+Actor
+-----
- - Content Creator
+ - Content Creator
- Assumptions
+Assumptions
+-----------
- - Content Creator has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+ - Content Creator has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
- - Content Creator has created content (see "Create Content
- Object":CreateNewContent).
+ - Content Creator has created content (see "Create Content
+ Object":CreateNewContent).
- Procedure
+Procedure
+---------
- 1. Click the 'search' link in the top navigation bar. The
- system displays the advanced search page.
+ 1. Click the 'search' link in the top navigation bar. The
+ system displays the advanced search page.
- 2. Enter your user ID in the form field labled *Creator*.
- Make sure you spell it exactly as you type it in to login to
- the CMF.
+ 2. Enter your user ID in the form field labled *Creator*.
+ Make sure you spell it exactly as you type it in to login to
+ the CMF.
- 3. Click the search button at the bottom of the page. The system
- then displayes a list of all content you've personally created
- using the standard search results page[1].
+ 3. Click the search button at the bottom of the page. The system
+ then displayes a list of all content you've personally created
+ using the standard search results page[1].
- Notes
+Notes
+-----
- ..[1] For a more detailed description of the options for advanced
- searching, see "Search CMF Site":SearchCMFSite.
+..[1] For a more detailed description of the options for advanced
+ searching, see "Search CMF Site":SearchCMFSite.
Modified: Products.CMFDefault/trunk/setup.py
===================================================================
--- Products.CMFDefault/trunk/setup.py 2012-04-04 09:01:37 UTC (rev 124941)
+++ Products.CMFDefault/trunk/setup.py 2012-04-04 09:14:27 UTC (rev 124942)
@@ -57,10 +57,10 @@
'zope.testing >= 3.7.0',
'Products.DCWorkflow',
],
- extras_require=dict(
- test=[
- 'Products.DCWorkflow',
- ]),
+ extras_require={ 'test': ['Products.DCWorkflow'],
+ 'docs': ['Sphinx',
+ 'repoze.sphinx.autointerface',
+ 'pkginfo']},
test_loader='zope.testing.testrunner.eggsupport:SkipLayers',
test_suite='Products.%s' % NAME,
entry_points="""
More information about the checkins
mailing list