[Checkins] SVN: Products.CMFDefault/trunk/docs/ Very basic port of Zope help to ReST.
Charlie Clark
cvs-admin at zope.org
Wed Mar 21 16:53:33 UTC 2012
Log message for revision 124659:
Very basic port of Zope help to ReST.
Changed:
A Products.CMFDefault/trunk/docs/
A Products.CMFDefault/trunk/docs/Makefile
A Products.CMFDefault/trunk/docs/_static/
A Products.CMFDefault/trunk/docs/_template/
A Products.CMFDefault/trunk/docs/api/
A Products.CMFDefault/trunk/docs/api/ActorDefinitions.rst
A Products.CMFDefault/trunk/docs/api/Actor_ContentCreator.rst
A Products.CMFDefault/trunk/docs/api/Actor_MembershipManager.rst
A Products.CMFDefault/trunk/docs/api/Actor_Reviewer.rst
A Products.CMFDefault/trunk/docs/api/Actor_SiteDesigner.rst
A Products.CMFDefault/trunk/docs/api/Actor_SiteManager.rst
A Products.CMFDefault/trunk/docs/api/Actor_SiteVisitor.rst
A Products.CMFDefault/trunk/docs/api/AddContentFolders.rst
A Products.CMFDefault/trunk/docs/api/ApproveForPublication.rst
A Products.CMFDefault/trunk/docs/api/BecomeAMember.rst
A Products.CMFDefault/trunk/docs/api/BrowseCMFSiteHomepage.rst
A Products.CMFDefault/trunk/docs/api/BrowseNewsItems.rst
A Products.CMFDefault/trunk/docs/api/BrowseSubmittedForReview.rst
A Products.CMFDefault/trunk/docs/api/ChangeContent.rst
A Products.CMFDefault/trunk/docs/api/ConfigureCMFSite.rst
A Products.CMFDefault/trunk/docs/api/ConfigurePersonalization.rst
A Products.CMFDefault/trunk/docs/api/CreateCMFFolder.rst
A Products.CMFDefault/trunk/docs/api/CreateCMFSite.rst
A Products.CMFDefault/trunk/docs/api/CreateCMFTopic.rst
A Products.CMFDefault/trunk/docs/api/CreateNewContent.rst
A Products.CMFDefault/trunk/docs/api/LoginAsMember.rst
A Products.CMFDefault/trunk/docs/api/ManageLocalRoles.rst
A Products.CMFDefault/trunk/docs/api/MoveCopyContent.rst
A Products.CMFDefault/trunk/docs/api/ProvideFeedback.rst
A Products.CMFDefault/trunk/docs/api/RemoveContent.rst
A Products.CMFDefault/trunk/docs/api/RenameContent.rst
A Products.CMFDefault/trunk/docs/api/SearchCMFSite.rst
A Products.CMFDefault/trunk/docs/api/SubmitContentForPublication.rst
A Products.CMFDefault/trunk/docs/api/Syndication-Tool_Overview.rst
A Products.CMFDefault/trunk/docs/api/Syndication-Tool_Policies.rst
A Products.CMFDefault/trunk/docs/api/Syndication-Tool_Properties.rst
A Products.CMFDefault/trunk/docs/api/Syndication-Tool_Reporting.rst
A Products.CMFDefault/trunk/docs/api/TODO.rst
A Products.CMFDefault/trunk/docs/api/UndoChanges.rst
A Products.CMFDefault/trunk/docs/api/UnpublishContent.rst
A Products.CMFDefault/trunk/docs/api/ViewMyContent.rst
A Products.CMFDefault/trunk/docs/conf.py
A Products.CMFDefault/trunk/docs/index.rst
-=-
Added: Products.CMFDefault/trunk/docs/Makefile
===================================================================
--- Products.CMFDefault/trunk/docs/Makefile (rev 0)
+++ Products.CMFDefault/trunk/docs/Makefile 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,89 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/CMFCore.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/CMFCore.qhc"
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+ "run these through (pdf)latex."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
Added: Products.CMFDefault/trunk/docs/api/ActorDefinitions.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/ActorDefinitions.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/ActorDefinitions.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,62 @@
+CMF Actors
+==========
+
+ **Site Manager** --
+ This actor is responsible for implementing site policies
+ such as security, workflow associations, metadata and
+ syndication policies. The Site Manager is also responsible
+ for the overall organizational structure of the site. See
+ "Actor: Site Manager":Actor_SiteManager.
+
+ **Membership Manager** --
+ This actor is responsible for managing who has access to a
+ site (particularly back-end line of business users), and
+ controls the privileges and properties of users. See
+ "Actor: Membership Manager":Actor_MembershipManager.
+
+ **Site Developer** --
+ This actor is responsible for implementing new
+ functionality for a site and making changes to existing
+ site capabilities. This is a "programmer" type of role, and
+ users acting the Site Developer capacity are technical
+ people. See "Actor: Site Developer":Actor_SiteDeveloper.
+
+ **Add-on Developer** --
+ This actor is responsible for implementing new
+ functionality that is suitable for distribution to one or
+ more sites. ** See "Actor: Add-On
+ Developer":Actor_AddOnDeveloper.
+
+ **Site Designer** --
+ The Site Designer is responsible for producing and
+ maintaining the "look and feel" of a site. This includes
+ graphics, layout, navigation and other human factors. See
+ "Actor: Site Designer":Actor_SiteDesigner.
+
+ **Workflow Designer** --
+ The Workflow Designer is responsible for defining new
+ workflows and customizing existing workflows to meet
+ business goals. See "Actor: Workflow
+ Designer":Actor_WorkflowDesigner.
+
+ **Content Creator** --
+ Content Creators are responsible for producing and
+ maintaining the actual content of a site. See "Actor:
+ Content Creator":Actor_ContentCreator.
+
+ **Reviewer** --
+ This actor is responsible for ensuring the quality and
+ correctness of site content. See "Actor:
+ Reviewer":Actor_Reviewer.
+
+ **Site Visitor** --
+ A Site Visitor is an "end user" of the site. The visitor
+ may or may not have an identity known to the system.
+ Visitors with a known identity are referred to as "Members"
+ of the site, and often can do more on a site than visitors
+ without a known identity ("Guests"). Member visitors often
+ have a participatory role on the site. Site Visitors have
+ some general goals that are applicable to most sites, but
+ many of the specific goals and expectations of Site
+ Visitors are dependent upon the specific CMF site. See
+ "Actor: Site Visitor":Actor_SiteVisitor.
Added: Products.CMFDefault/trunk/docs/api/Actor_ContentCreator.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/Actor_ContentCreator.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/Actor_ContentCreator.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,60 @@
+Content Creator Goals
+=====================
+
+ * Make information available to the end users of the site.
+
+ - "Create a content object":CreateNewContent
+
+ o Add Content form with a slightly more involved
+ description of each content type that comes with the CMF.
+
+ o Next form in succession is the "Standard Resource
+ Metadata" form which is now a separate use case. Since
+ this is a succession of three steps ("Add Content",
+ "Metadata", "Edit") "Define content metadata" use case
+ should be merged in with this one.
+
+ o "Edit" form.
+
+ - **XXX** "Define content metadata":ChangeMetadata
+
+ This should mainly be pointers back to "Create a content object".
+
+ - "Submit content for publication":SubmitContentForPublication
+
+ o Brief discussion of workflow with references back to
+ workflow use cases.
+
+ o Submit for the default workflow
+
+ * Ensure that information is up-to-date and accurate.
+
+ - "View personally authored content":ViewMyContent
+
+ - "Update existing content":ChangeContent
+
+ - "Remove unneeded content":RemoveContent
+
+ - "Undo changes to content":UndoChanges
+
+
+ * Improve content quality over time using end user
+ feedback.
+
+ - **XXX** "Make a content object discussable":EnableDiscussion
+
+ *Note: this is not a per-object option in stock CMF.*
+
+ * Collaborate with other content creators.
+
+ - "Give local roles to other users":ManageLocalRoles
+
+
+ * Modify content organization to improve maintainability
+ or navigation.
+
+ - "Add content folders":AddContentFolders
+
+ - "Move / copy content between folders":MoveCopyContent
+
+ - "Rename content object":RenameContent
Added: Products.CMFDefault/trunk/docs/api/Actor_MembershipManager.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/Actor_MembershipManager.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/Actor_MembershipManager.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,18 @@
+Membership Manager Goals
+========================
+
+ * Empower many users to collaborate on content production
+
+ - **XXX** "Add a new member to the site using a
+ standard user folder":AddMemberToUserFolder
+
+ * Delegate responsibilities to site members
+
+ - **XXX** "Change member information and abilities":ChangeMemberInformation
+
+ * Ensure that only appropriate users have access to the site
+
+ - **XXX** "Browse member roster":BrowseMemberRoster
+
+ - **XXX** "Remove a member from the site":RemoveMemberFromSite
+
Added: Products.CMFDefault/trunk/docs/api/Actor_Reviewer.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/Actor_Reviewer.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/Actor_Reviewer.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,23 @@
+Reviewer Goals
+==============
+
+ * Collaborate with content creators to ensure the quality and
+ timeliness of site content.
+
+ - "Browse content submitted for review and
+ publication":BrowseSubmittedForReview
+
+ o Brief description of the Action box, with pointers back to
+ where this is set up in the skin.
+
+ o Pending lists
+
+ - "Approve content for publication":ApproveForPublication
+
+ This should mainly be a pointer back into "Browse content
+ submitted for review and publication"
+
+ * React quickly to resolve issues with published content.
+
+ - "Remove content from public site":UnpublishContent
+
Added: Products.CMFDefault/trunk/docs/api/Actor_SiteDesigner.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/Actor_SiteDesigner.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/Actor_SiteDesigner.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,45 @@
+Site Designer Goals
+===================
+
+ * Provide an integrated look and feel for site content.
+
+ - **XXX** "Create new skin for the site":CreateNewSkin
+
+ o portal_skins Properties tab. Discussion of Layers and their
+ order of precedence.
+
+ o Creating a new layer. Difference between file system layers
+ vs TTW layers. Don't document actually creating a file system
+ layer, this should likely be a separate use case that
+ refers back to this one.
+
+ o The theory behind customizing methods, but don't refer to
+ specific layers or specific methods/images.
+
+ - **XXX** "Modify skin appearance":ChangeSkinLookAndFeel
+
+ o Brief description of customizing methods. Refer back to
+ "Create new skin for the site".
+
+ o Document each layer that deals with appearance with a
+ description of each constituent object (method, image, ...)
+
+ * Give end users an effective way to navigate the site.
+
+ - **XXX** "Change skin behavior":ChangeSkinBehavior
+
+ o Brief description of customizing methods. Refer back to
+ "Create new skin for the site description".
+
+ o Document each layer that deals with behavior with a
+ description of each method.
+
+ * Keep the site fresh and interesting for end users.
+
+ - **XXX** "Change the default skin for the site":ChangeDefaultSiteSkin
+
+ o Brief description of skins. Refer back to other skin use
+ cases.
+
+ o portal_skin Properties tab, bottom half. Very simple form.
+
Added: Products.CMFDefault/trunk/docs/api/Actor_SiteManager.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/Actor_SiteManager.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/Actor_SiteManager.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,41 @@
+Site Manager Goals
+==================
+
+ * Provide an online collaboration environment for an organization
+ or community.
+
+ - "Create a CMF site":CreateCMFSite
+
+ - "Configure CMF site":ConfigureCMFSite
+
+ * Maintain an overall site structure and organization.
+
+ - "Create CMF Folder":CreateCMFFolder
+
+ - "Create CMF Topic":CreateCMFTopic
+
+ - **XXX** "Configure CMF Topic":ConfigureCMFTopic
+
+ - **XXX** "Configure what types of content can be created by
+ members":ConfigureAllowedContentTypes
+
+ * Implement security policies for the site.
+
+ - **XXX** "Configure security for a content object
+ or folder":ConfigureObjectSecurity
+
+ * Implement workflow policies for the site.
+
+ - **XXX** "Associate a workflow with a content
+ type":AssociateWorkflowWithContentType
+
+ * Implement metadata policies for the site.
+
+ - **XXX** "Configure required metadata for a content
+ type":ConfigureRequiredMetadata
+
+ * Implement syndication policies for the site.
+
+ - **XXX** "Configure what content is released via
+ syndication":ConfigureContentSyndication
+
Added: Products.CMFDefault/trunk/docs/api/Actor_SiteVisitor.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/Actor_SiteVisitor.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/Actor_SiteVisitor.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,31 @@
+Site Vistor Goals
+=================
+
+ * Participate in the community or operations of the site
+
+ - "Become a member of the site":BecomeAMember
+
+ - "Log into the site":LoginAsMember
+
+ - "Browse community news":BrowseNewsItems
+
+ - **XXX** "Submit a news item":SubmitNewsItem
+
+ o Not a stock use case for anonymous visitors; see
+ "Create Content":CreateNewContent and "Submit
+ Content":SubmitContentForPublication for Content
+ Creator's take.
+
+ * Quickly find content that is important to him
+
+ - "Browse the site homepage":BrowseCMFSiteHomepage
+
+ - **XXX** "Browse a portal topic":BrowsePortalTopic
+
+ - "Search site for information":SearchCMFSite
+
+ * Improve relevance and usability of site information
+
+ - "Configure personalization options":ConfigurePersonalization
+
+ - "Provide feedback on content":ProvideFeedback
Added: Products.CMFDefault/trunk/docs/api/AddContentFolders.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/AddContentFolders.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/AddContentFolders.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,49 @@
+Use Case: Add content folders
+=============================
+
+ Actor
+
+ - Content Creator
+
+ Overview
+
+ As with directories on a filesystem, foldersin a CMF Site allow
+ Content Creators to partition their content into manageable groups.
+
+ Assumptions
+
+ - Content Creator has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
+
+ Procedure
+
+ 1. Navigate to the folder in which you would like to create sub-folders.
+
+ 2. In the "Folder contents" view of the folder, select the "New" button.
+
+ 3. From the list of addable portal types, select "Folder" by clicking
+ the adjacent radio button. Supply an ID [1] for the new folder in the
+ input field at the bottom of the page, and click the "Add" button.
+
+ 4. The system will create the new folder using the ID you supplied,
+ and present you with a form for editing the folder's properties.
+
+ 5. Supply appropriate values as follows:
+
+ **Title** -- a "human-readable" title for the folder.
+
+ **Description** -- a brief paragraph summarizing the use to which
+ the folder is put.
+
+ 6. Click the "Change" button. The system will update the folder's
+ metadata using the values you supply.
+
+ Notes
+
+ ..[1] Don't confuse the folder'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).
Added: Products.CMFDefault/trunk/docs/api/ApproveForPublication.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/ApproveForPublication.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/ApproveForPublication.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,42 @@
+Use Case: Approve content for publication
+=========================================
+
+ Actor
+ -----
+
+ - Reviewer
+
+ 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.
+
+ Assumptions
+ -----------
+
+ - Reviewer has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
+
+ - 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.
+
+ Procedure
+ ---------
+
+ 1. Select the item from the list of content pending review.
+
+ 2. From the actions box, select the 'Publish' link.
+
+ 3. Enter appropriate comments.
+
+ 4. Select the Publish this item button.
+
+ 5. The item has been published.
+
+ 6. You can now "Browse for content submitted for review and
+ publication":BrowseSubmittedForReview to repeat this process.
Added: Products.CMFDefault/trunk/docs/api/BecomeAMember.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/BecomeAMember.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/BecomeAMember.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,46 @@
+Use Case: Become A Site Member
+==============================
+
+ Actor
+ -----
+
+ - Site Visitor
+
+ 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.
+
+ 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
+ ---------
+
+ 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.
+
+ 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.
Added: Products.CMFDefault/trunk/docs/api/BrowseCMFSiteHomepage.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/BrowseCMFSiteHomepage.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/BrowseCMFSiteHomepage.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,34 @@
+Use Case: Browse the site homepage
+===================================
+
+Actor
+-----
+
+ - Site Visitor
+
+Assumptions
+-----------
+
+ - Site Visitor has already navigated to a page within the CMF
+ site[1].
+
+Procedure
+---------
+
+ 1. Selecting the 'home' link or the site logo
+ from the top navigation bar.
+
+ 2. Browse the content published there (e.g. 10 most recent
+ News Announcements, etc.)
+
+Notes
+-----
+
+..[1] Site Visitors may get to the site initially through several
+ mechanisms:
+
+ - Links on another site, such as a search engine
+
+ - Mailed URLs
+
+ - Typing the URL directly
Added: Products.CMFDefault/trunk/docs/api/BrowseNewsItems.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/BrowseNewsItems.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/BrowseNewsItems.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,30 @@
+Use Case: Browse community news
+================================
+
+Actor
+-----
+
+ - Site Visitor
+
+Overview
+--------
+
+ Visitors to a CMF Site will typically return to the site after
+ an initial visit only if the site's content was interesting or
+ valuable to them. They will return often to the site only if
+ they perceive that this interesting and valuable content is
+ being frequently updated. This use case deals with the most
+ common "dynamic" feature of a CMF Site: its list of published
+ News Items.
+
+Procedure
+---------
+
+ 1. Select the 'news' link from the navigation bar. The system
+ will display the ten most recent News Items, sorted in
+ descending date order. If there are more than ten
+ published News Items, the system will display a link to
+ the next batch at the bottom of the page.
+
+ 2. Navigate between batches of News Items by clicking the
+ "10 older artcles" and "10 newer articles" links.
Added: Products.CMFDefault/trunk/docs/api/BrowseSubmittedForReview.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/BrowseSubmittedForReview.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/BrowseSubmittedForReview.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,31 @@
+Use Case: Browse for content submitted for review and publication
+==================================================================
+
+Actor
+-----
+
+ - Reviewer
+
+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.
+
+Assumptions
+-----------
+
+ - Reviewer has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
+
+ - Content has been submitted for review (see "Submit content for
+ publication":SubmitContentForPublication).
+
+Procedure
+---------
+
+ 1. From the actions box, select the 'Pending review (x)' link.
+
+ 2. Browse the list of content which has been submitted for
+ Publication.
Added: Products.CMFDefault/trunk/docs/api/ChangeContent.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/ChangeContent.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/ChangeContent.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,44 @@
+Use Case: Update Existing Content
+==================================
+
+ Actor
+
+ - Content Creator
+
+ Assumptions
+
+ - Content Creator has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
+
+ Procedure
+
+ 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
+
+ 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:
+
+ - 'Body Textarea/File Upload' edit form (Documents)
+
+ - 'Lead-in/Body' edit form (News Item)
+
+ - 'File Upload' edit form (Files, Images)
+
+ - '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.
+
+ 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.
Added: Products.CMFDefault/trunk/docs/api/ConfigureCMFSite.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/ConfigureCMFSite.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/ConfigureCMFSite.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,84 @@
+Use Case Configuring a CMF site
+===============================
+
+Actor
+-----
+
+- Site Manager
+
+Overview
+--------
+
+The "site configuration form" of a CMF Site object provides a simple
+way to set and change the sitewide configuration options and policies
+for a CMF site. Theses options include some of the information that was
+provided when the CMF Site was created (such as site title and
+description), as well as other options that were given defaults when
+the CMF site was created.
+
+Assumptions
+-----------
+
+Site Manager has logged into the CMF site using a user ID with
+the "Change configuration" permission (see "Login to the Site": LoginAsMember).
+
+Procedure
+---------
+
+1. Site Managers see a "Reconfigure site" link in the actions box.
+
+Click the "Reconfigure site" link to bring up the site configuration form.
+
+
+The configuration options available from the site configuration form are:
+
+- **Site 'From' Name** -- The name to be used as the
+ (apparent) sender when the site generates email. The
+ site may generate email to provide information to new
+ members, or to notify members of various events. The
+ default value for this name is 'Site Administrator'. A
+ value for this field is required in order to send mail
+ from the site.
+
+- **Site 'From' Address** -- The email address used as the
+ (apparent) return address when the site generates email.
+ The default value for the from address is
+ 'postmaster at localhost'. A value for this field is
+ required in order to send mail from the site.
+
+- **SMTP Server** -- The address of the SMTP (outgoing
+ mail) server to be used when the site generates email.
+ The default value for the SMTP server address is
+ 'localhost', which presumes that you have an SMTP server
+ running on the same machine as the Zope software. A
+ valid SMTP server address is required in order to send
+ mail from the site.
+
+ **Site Title** -- The title of the site that appears at
+ the top of all site pages (when using the default site
+ skins). Providing a title is optional, but recommended.
+
+ **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.
+
+ **Password Policy** -- The password policy configuration
+ option allows you to choose the way that the site
+ handles passwords when members register with the site.
+
+ If you select "Generate an email member's initial
+ password" the site will randomly generate an initial
+ password that members must use to log into the site and
+ email that password to the address provided by the
+ member. This option may be preferred if you want to
+ verify a prospective member's email address before
+ granting membership to the site.
+
+ If you select "Allow members to select their initial
+ password" (the default), the site will allow new members
+ to enter their own password at registration time.
+
+After making changes to the site configuration options,
+click the "Change" button to save the changes.
Added: Products.CMFDefault/trunk/docs/api/ConfigurePersonalization.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/ConfigurePersonalization.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/ConfigurePersonalization.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,47 @@
+Use Case: Configure personalization options
+============================================
+
+ Actor
+
+ - Site Visitor
+
+ 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.
+
+ Assumptions
+
+ - Site Visitor has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
+
+ Procedure
+
+ 1. Click the 'Preferences' link in your top user actions bar.
+
+ 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.
+
+ **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.
+
+ 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.
Added: Products.CMFDefault/trunk/docs/api/CreateCMFFolder.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CreateCMFFolder.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/CreateCMFFolder.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,39 @@
+Use Case: Creating a CMF Folder
+===============================
+
+ Actor
+
+ - Site Manager
+
+ Overview
+
+ Folders may used in CMF to help organize content. Folders may contain
+ any kind of content object, including subfolders.
+
+ Assumptions
+
+ - Foo
+
+ 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.
+
+ 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.
+
+ After submitting the add form, you will be taken to the "desktop" view
+ of the newly created Folder.
+
+ Notes
+
+ - This use case is not specific to a Site Manager; it is
+ properly a Content Creator use case.
Added: Products.CMFDefault/trunk/docs/api/CreateCMFSite.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CreateCMFSite.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/CreateCMFSite.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,86 @@
+Use Case: Create a CMF Site
+===========================
+
+ Actor
+
+ - Site Manager
+
+ 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 "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
+
+ - 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
+
+ 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.
+
+ **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.
+
+ 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.
+
+ 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:
+
+ **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 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.
Added: Products.CMFDefault/trunk/docs/api/CreateCMFTopic.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CreateCMFTopic.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/CreateCMFTopic.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,119 @@
+Use Case: Create CMF Topic
+==========================
+
+ Actor
+
+ - Site Manager[1]
+
+ 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.
+
+ 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.
+
+ 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
+
+ - Site Manager has logged into the CMF (see "Login to the
+ Site":LoginAsMember)
+
+ Procedure
+
+ 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."
+
+ 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.
+
+ **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.
+
+ 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.
+
+ 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.
+
+ **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
+
+ *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.
+
+ *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.
+
+ 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.
+
+
+ Notes
+
+ ..[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.
Added: Products.CMFDefault/trunk/docs/api/CreateNewContent.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/CreateNewContent.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/CreateNewContent.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,99 @@
+Use Case: Create Content Object
+================================
+
+ Actor
+
+ - Content Creator
+
+ Assumptions
+
+ - Content Creator has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
+
+ 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.
+
+ 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.
+
+ 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.
+
+ **Description** --
+ A short summary of the content.
+
+ **Subject** --
+ A set of keywords, used for cataloging 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 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.
+
+ 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.
+
+ **News Item** --
+ Fill out the "Lead-in" and "Body" text areas.
+
+ **File / Image** --
+ Upload the content from your computer.
+
+ **Link / Favorite / Event** --
+ Fill out the form with appropriate values.
+
+ 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:
+
+ - "Submit Content for Review":SubmitContentForReview
+
+ - "Publish Content":PublishContent
+
+ Notes
+
+ ..[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).
+
+ ..[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.
Added: Products.CMFDefault/trunk/docs/api/LoginAsMember.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/LoginAsMember.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/LoginAsMember.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,29 @@
+Use Case: Login To The Site
+===========================
+
+ Actor
+
+ - Site Visitor
+
+ Overview
+
+ Visitors to a site who have registered as members must login to the
+ site to use member-only services.
+
+ 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).
+
+ 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.
Added: Products.CMFDefault/trunk/docs/api/ManageLocalRoles.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/ManageLocalRoles.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/ManageLocalRoles.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,48 @@
+Use Case: Give local roles to other users
+==========================================
+
+ Actor
+
+ - Content Creator
+
+ Overview
+
+ In order to collaborate on a set of content, each contributor
+ must have the appropriate permissions to create and revise
+ content.
+
+ Assumptions
+
+ - Content Creator has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
+
+ Procedure
+
+ 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.
+
+ 3. Select 'Set local roles' from the actions box.
+
+ 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 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.
+
+ 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.
+
Added: Products.CMFDefault/trunk/docs/api/MoveCopyContent.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/MoveCopyContent.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/MoveCopyContent.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,41 @@
+Use Case: Move / copy content between folders
+==============================================
+
+Actor
+-----
+
+- Content Creator
+
+Assumptions
+-----------
+
+- Content Creator has logged into the CMF (see "Login to the
+ Site" LoginAsMember).
+
+Procedure
+---------
+
+1. Navigate to the folder containing the piece of content which
+ you would like to move (or copy) to another folder.
+
+ 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 move or copy.
+
+3. Click the "Cut" button (or the "Copy" button, if you wish to create
+ a copy in the new location rather than moving the content).
+
+4. The system will set a cookie on your browser (you must have cookies
+ enabled) representing the items you cut or copied.
+
+5. Navigate to the folder into which you wish to move or copy the
+ content (which might be the same folder).
+
+6. Click the "Paste" button. The system will move or copy the content
+ into the folder; new content whose IDs would conflict with exising
+ content in that folder will receive an auto-generated name, typically
+ `copy_of_` plus the original ID.
+
+7. To undo this action, see "Undo changes to content":UndoChanges.
Added: Products.CMFDefault/trunk/docs/api/ProvideFeedback.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/ProvideFeedback.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/ProvideFeedback.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,52 @@
+Use Case: Provide feedback on content
+======================================
+
+ Actor
+
+ - Site Visitor
+
+ Assumptions
+
+ - The Site Manager has configured the permissions of the site
+ to allow anonymous users to discuss published content
+
+ **or**
+
+ 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.
+
+ Procedure
+
+ 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.
+
+ **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.
+
+ **Preview** --
+ a submit button which permits you to preview your reply
+ before submitting it.
+
+ **Reply** --
+ a submit button for creating your reply.
+
+ 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.
+
+ 5. Click the "Reply" button. The system will append your comment
+ to the thread of replies on the target object.
Added: Products.CMFDefault/trunk/docs/api/RemoveContent.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/RemoveContent.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/RemoveContent.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,29 @@
+Use Case: Remove unneeded content
+==================================
+
+ Actor
+
+ - Content Creator
+
+ Assumptions
+
+ - Content Creator has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
+
+ Procedure
+
+ 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
+
+ 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.
+
+ 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
Added: Products.CMFDefault/trunk/docs/api/RenameContent.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/RenameContent.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/RenameContent.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,39 @@
+Use Case: Rename Content
+=========================
+
+ Actor
+
+ - Content Creator
+
+ Overview
+
+ The ID which an author assigns to a piece of content at
+ creation time[1] may laterturn out to be inappropriate.
+
+ Assumptions
+
+ - Content Creator has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
+
+ Procedure
+
+ 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.
+
+ 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.
+
+ 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.
+
+ 6. To undo this action, see "Undo changes to content":UndoChanges.
+
Added: Products.CMFDefault/trunk/docs/api/SearchCMFSite.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/SearchCMFSite.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/SearchCMFSite.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,56 @@
+Use Case: Search site for information
+======================================
+
+ Actor
+
+ - Site Visitor
+
+ Overview
+
+ 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:
+
+ **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.
+
+ **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.
+
+ **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.
+
+ **Creator** --
+ Enter the user ID of the user who created the content.
+
+ 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.
+
+ 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.
Added: Products.CMFDefault/trunk/docs/api/SubmitContentForPublication.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/SubmitContentForPublication.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/SubmitContentForPublication.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,38 @@
+Use Case: Submit Content for Publication
+=========================================
+
+ Actor
+
+ - Content Creator
+
+ Overview
+
+ Non-privileged content creators site need to get review of
+ their content before it can be published to all Site Visitors.
+
+ Assumptions
+
+ - 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).
+
+ Procedure
+
+ 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
+
+ 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.
+
+ 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).
Added: Products.CMFDefault/trunk/docs/api/Syndication-Tool_Overview.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/Syndication-Tool_Overview.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/Syndication-Tool_Overview.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,51 @@
+SyndicationTool - Overview: CMF Syndication Overview
+====================================================
+
+ 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:
+
+ 1. Enable/disable sitewide syndication.
+
+ 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.
+
+
+ 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.
+
+ 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.
+
+ 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.
+
+ 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.
+
+ 8. Other features are possible as users give feedback on the
+ Syndication implementation.
Added: Products.CMFDefault/trunk/docs/api/Syndication-Tool_Policies.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/Syndication-Tool_Policies.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/Syndication-Tool_Policies.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,13 @@
+SyndicationTool - Policies: Manage the policies of a Site's Syndication Instance
+================================================================================
+
+ Description
+
+ View and manage the prolicies of a sitewide syndication instance.
+
+ 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.
Added: Products.CMFDefault/trunk/docs/api/Syndication-Tool_Properties.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/Syndication-Tool_Properties.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/Syndication-Tool_Properties.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,41 @@
+SyndicationTool - Properties: Manage the properties of a Site's Syndication Instance
+====================================================================================
+
+ Description
+
+ View and manage the properties of a sitewide syndication instance.
+
+ Controls
+
+ '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.
+
+ '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
+
+ '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.
+
+ '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.
Added: Products.CMFDefault/trunk/docs/api/Syndication-Tool_Reporting.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/Syndication-Tool_Reporting.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/Syndication-Tool_Reporting.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,12 @@
+SyndicationTool - Overview: CMF Syndication Reporting Facility
+==============================================================
+
+ 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.
Added: Products.CMFDefault/trunk/docs/api/TODO.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/TODO.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/TODO.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,55 @@
+Missing Use Cases
+=================
+
+ "ContentCreator":Actor_ContentCreator
+
+ - "Define content metadata":ChangeMetadata
+
+ - "Make a content object discussable":EnableDiscussion
+
+ "MembershipManager":Actor_MembershipManager
+
+ - "Add a new member to the site using a standard user
+ folder":AddMemberToUserFolder
+
+ - "Change member information and abilities":ChangeMemberInformation
+
+ - "Browse member roster":BrowseMemberRoster
+
+ - "Remove a member from the site":RemoveMemberFromSite
+
+ "SiteDesigner":Actor_SiteDesigner
+
+ - "Create new skin for the site":CreateNewSkin
+
+ - "Modify skin appearance":ChangeSkinLookAndFeel
+
+ - "Change skin behavior":ChangeSkinBehavior
+
+ - "Change the default skin for the site":ChangeDefaultSiteSkin
+
+ "SiteManager":Actor_SiteManager
+
+ - "Configure CMF Topic":ConfigureCMFTopic
+
+ - "Configure what types of content can be created
+ by users":ConfigureAllowedContentTypes
+
+ - "Configure security for a content object
+ or folder":ConfigureObjectSecurity
+
+ - "Associate a workflow with a content
+ type":AssociateWorkflowWithContentType
+
+ - "Configure required metadata for a content
+ type":ConfigureRequiredMetadata
+
+ - "Configure what content is released via
+ syndication":ConfigureContentSyndiation
+
+ "SiteVisitor":Actor_SiteVisitor
+
+ - "Submit a news item":SubmitNewsItem
+
+ - "Browse a portal topic":BrowsePortalTopic
+
Added: Products.CMFDefault/trunk/docs/api/UndoChanges.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/UndoChanges.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/UndoChanges.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,37 @@
+Use Case: Undo Changes to Content
+==================================
+
+ Actor
+
+ - Content Creator
+
+ Assumptions
+
+ - 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).
+
+ - The changes are "undoable"[1].
+
+ Procedure
+
+ 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.
+
+ 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.
+
+ 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.
Added: Products.CMFDefault/trunk/docs/api/UnpublishContent.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/UnpublishContent.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/UnpublishContent.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,28 @@
+Use Case: Remove content from public site
+==========================================
+
+ Actor
+
+ - Reviewer
+
+ Assumptions
+
+ - 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).
+
+ Procedure
+
+ 1. Navigate to the content item you wish to remove from the
+ publically visible site.
+
+ 2. Select 'Reject' from the actions box.
+
+ 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.
Added: Products.CMFDefault/trunk/docs/api/ViewMyContent.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/ViewMyContent.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/api/ViewMyContent.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,32 @@
+Use Case: View personally authored content
+===========================================
+
+ Actor
+
+ - Content Creator
+
+ Assumptions
+
+ - Content Creator has logged into the CMF (see "Login to the
+ Site":LoginAsMember).
+
+ - Content Creator has created content (see "Create Content
+ Object":CreateNewContent).
+
+ Procedure
+
+ 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.
+
+ 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
+
+ ..[1] For a more detailed description of the options for advanced
+ searching, see "Search CMF Site":SearchCMFSite.
Added: Products.CMFDefault/trunk/docs/conf.py
===================================================================
--- Products.CMFDefault/trunk/docs/conf.py (rev 0)
+++ Products.CMFDefault/trunk/docs/conf.py 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,207 @@
+# -*- coding: utf-8 -*-
+#
+# CMFCore documentation build configuration file, created by
+# sphinx-quickstart on Thu Apr 29 10:34:29 2010.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import os
+#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
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.append(os.path.abspath('.'))
+import Products
+Products.__path__.append(os.path.abspath('../Products'))
+
+# -- General configuration -----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.doctest',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.todo',
+ 'repoze.sphinx.autointerface',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'CMFDefault'
+copyright = u'2012, Zope Foundation & Contributors'
+
+# 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'
+# The full version, including alpha/beta/rc tags.
+release = '2.3'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# 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'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'CMFDefaultdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'CMFDefault.tex', u'CMFDefault Documentation',
+ u'Zope Foundation & Contributors', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}
Property changes on: Products.CMFDefault/trunk/docs/conf.py
___________________________________________________________________
Added: svn:eol-style
+ native
Added: Products.CMFDefault/trunk/docs/index.rst
===================================================================
--- Products.CMFDefault/trunk/docs/index.rst (rev 0)
+++ Products.CMFDefault/trunk/docs/index.rst 2012-03-21 16:53:30 UTC (rev 124659)
@@ -0,0 +1,48 @@
+Products.CMFDefault documentation
+==============================
+
+.. toctree::
+ :maxdepth: 2
+
+ api/Actor_ContentCreator
+ api/ActorDefinitions
+ api/Actor_MembershipManager
+ api/Actor_Reviewer
+ api/Actor_SiteDesigner
+ api/Actor_SiteManager
+ api/Actor_SiteVisitor
+ api/AddContentFolders
+ api/ApproveForPublication
+ api/BecomeAMember
+ api/BrowseCMFSiteHomepage
+ api/BrowseNewsItems
+ api/BrowseSubmittedForReview
+ api/ChangeContent
+ api/ConfigureCMFSite
+ api/ConfigurePersonalization
+ api/CreateCMFFolder
+ api/CreateCMFSite
+ api/CreateCMFTopic
+ api/CreateNewContent
+ api/LoginAsMember
+ api/ManageLocalRoles
+ api/MoveCopyContent
+ api/ProvideFeedback
+ api/RemoveContent
+ api/RenameContent
+ api/SearchCMFSite
+ api/SubmitContentForPublication
+ api/Syndication-Tool_Overview
+ api/Syndication-Tool_Policies
+ api/Syndication-Tool_Properties
+ api/Syndication-Tool_Reporting
+ api/TODO
+ api/UndoChanges
+ api/UnpublishContent
+ api/ViewMyContent
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
More information about the checkins
mailing list