[Checkins] SVN: Products.CMFDefault/trunk/docs/narrative/ Formatting updated and links added. Still basically lipstick on a pig.
Charlie Clark
cvs-admin at zope.org
Wed Apr 4 21:24:08 UTC 2012
Log message for revision 124951:
Formatting updated and links added. Still basically lipstick on a pig.
Changed:
U Products.CMFDefault/trunk/docs/narrative/Actor_MembershipManager.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/BrowseSubmittedForReview.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
-=-
Modified: Products.CMFDefault/trunk/docs/narrative/Actor_MembershipManager.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/Actor_MembershipManager.rst 2012-04-04 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/Actor_MembershipManager.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,17 +4,17 @@
Empower many users to collaborate on content production
-------------------------------------------------------
-- **XXX** :doc:`AddMemberToUserFolder`
+* **XXX** :doc:`AddMemberToUserFolder`
Delegate responsibilities to site members
-------------------------------------------
-- **XXX** :doc:`ChangeMemberInformation`
+* **XXX** :doc:`ChangeMemberInformation`
Ensure that only appropriate users have access to the site
------------------------------------------------------------
-- **XXX** :doc:`BrowseMemberRoster`
+* **XXX** :doc:`BrowseMemberRoster`
-- **XXX** :doc:`RemoveMemberFromSite`
+* **XXX** :doc:`RemoveMemberFromSite`
Modified: Products.CMFDefault/trunk/docs/narrative/Actor_Reviewer.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/Actor_Reviewer.rst 2012-04-04 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/Actor_Reviewer.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,12 +4,12 @@
* Collaborate with content creators to ensure the quality and timeliness of
site content.
-- :doc:`BrowseSubmittedForReview`
+* :doc:`BrowseSubmittedForReview`
- - Brief description of the Action box, with pointers back to where this is
+ * Brief description of the Action box, with pointers back to where this is
set up in the skin.
- - Pending lists
+ * Pending lists
- :doc:`ApproveForPublication`
@@ -18,5 +18,5 @@
* React quickly to resolve issues with published content.
- - :doc:`UnpublishContent`
+ * :doc:`UnpublishContent`
Modified: Products.CMFDefault/trunk/docs/narrative/Actor_SiteDesigner.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/Actor_SiteDesigner.rst 2012-04-04 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/Actor_SiteDesigner.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,42 +4,42 @@
Provide an integrated look and feel for site content
----------------------------------------------------
-- **XXX** :doc:`CreateNewSkin`
+* **XXX** :doc:`CreateNewSkin`
- - portal_skins Properties tab. Discussion of Layers and their order of
+ * portal_skins Properties tab. Discussion of Layers and their order of
precedence.
- - Creating a new layer. Difference between file system layers vs TTW
+ * 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.
- - The theory behind customizing methods, but don't refer to specific
+ * The theory behind customizing methods, but don't refer to specific
layers or specific methods/images.
-- **XXX** :doc:`ChangeSkinLookAndFeel`
+* **XXX** :doc:`ChangeSkinLookAndFeel`
- - Brief description of customizing methods. Refer back to "Create new
+ * Brief description of customizing methods. Refer back to "Create new
skin for the site".
- - Document each layer that deals with appearance with a description of
+ * 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** :doc:`ChangeSkinBehavior`
+* **XXX** :doc:`ChangeSkinBehavior`
- - Brief description of customizing methods. Refer back to "Create new
+ * Brief description of customizing methods. Refer back to "Create new
skin for the site description".
- - Document each layer that deals with behavior with a description of each
+ * Document each layer that deals with behavior with a description of each
method.
Keep the site fresh and interesting for end users
-------------------------------------------------
-- **XXX** :doc:`ChangeDefaultSiteSkin`
+* **XXX** :doc:`ChangeDefaultSiteSkin`
- o Brief description of skins. Refer back to other skin use cases.
+ * Brief description of skins. Refer back to other skin use cases.
- o portal_skin Properties tab, bottom half. Very simple form.
+ * portal_skin Properties tab, bottom half. Very simple form.
Modified: Products.CMFDefault/trunk/docs/narrative/BrowseSubmittedForReview.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/BrowseSubmittedForReview.rst 2012-04-04 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/BrowseSubmittedForReview.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -9,9 +9,8 @@
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
-----------
Modified: Products.CMFDefault/trunk/docs/narrative/CreateCMFSite.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/CreateCMFSite.rst 2012-04-04 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/CreateCMFSite.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,87 +4,78 @@
Actor
-----
- - Site Manager
+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 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
-----------
- - 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
---------
- 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 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/CreateCMFTopic.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,121 +4,110 @@
Actor
-----
- - Site Manager[1]
+Site Manager [#]_
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
-----------
- - Site Manager has logged into the CMF (see "Login to the
- Site":LoginAsMember)
+Site Manager has logged into the CMF (see :doc:`LoginAsMember`)
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 [#]_, 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.
+.. :rubric::Notes
-Notes
------
+.. [#]
+ 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.
+.. [#]
+ 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 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/CreateNewContent.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,100 +4,96 @@
Actor
-----
- - Content Creator
+Content Creator
Assumptions
-----------
- - Content Creator has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+Content Creator has logged into the CMF (see :doc:`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.
+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 [#]_ 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 [#]_ or HTML [#]_.
+ 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":doc:`SubmitContentForReview`
- - "Publish Content":PublishContent
+ - "Publish Content":doc:`PublishContent`
-Notes
------
+.. :rubric::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).
+.. [#]
+ see "Default CMF Content Types", :doc:`DefaultContentTypes`.
- ..[3] See "Structured Text Introduction":StructuredTextIntro
+.. [#]
+ 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).
- ..[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.
+.. [#]
+ See :doc.`StructuredTextIntro
+
+.. [#]
+ 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 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/LoginAsMember.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,29 +4,27 @@
Actor
-----
- - Site Visitor
+Site Visitor
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
---------
- 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 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/ManageLocalRoles.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,49 +4,45 @@
Actor
-----
- - Content Creator
+Content Creator
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
-----------
- - Content Creator has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+Content Creator has logged into the CMF (see :doc:`LoginAsMember`).
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 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/ProvideFeedback.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,52 +4,47 @@
Actor
-----
- - Site Visitor
+Site Visitor
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 :doc:`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
---------
- 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 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/RemoveContent.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,29 +4,28 @@
Actor
-----
- - Content Creator
+Content Creator
Assumptions
-----------
- - Content Creator has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+Content Creator has logged into the CMF (see :doc:`LoginAsMember`).
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:
+ :doc:`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 :doc:`UndoChanges`
Modified: Products.CMFDefault/trunk/docs/narrative/RenameContent.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/RenameContent.rst 2012-04-04 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/RenameContent.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,40 +4,39 @@
Actor
-----
- - Content Creator
+Content Creator
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
-----------
- - Content Creator has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+Content Creator has logged into the CMF (see :doc:`LoginAsMember`).
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
+ :doc:`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 :doc:`UndoChanges`.
Modified: Products.CMFDefault/trunk/docs/narrative/SearchCMFSite.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/SearchCMFSite.rst 2012-04-04 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/SearchCMFSite.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,7 +4,7 @@
Actor
-----
- - Site Visitor
+Site Visitor
Overview
--------
@@ -12,49 +12,45 @@
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
------------
- 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 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/SubmitContentForPublication.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,39 +4,34 @@
Actor
-----
- - Content Creator
+Content Creator
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
-----------
+* Content Creator has logged into the CMF (see :doc:`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 :doc:`CreateNewContent`).
- - 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.
+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
+ :doc:`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 :doc:`ApproveForPublication`).
Modified: Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Overview.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Overview.rst 2012-04-04 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Overview.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,49 +4,48 @@
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 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Policies.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,12 +4,13 @@
Description
-----------
- View and manage the prolicies of a sitewide syndication instance.
+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.
+ **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 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Properties.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,40 +4,48 @@
Description
-----------
- View and manage the properties of a sitewide syndication instance.
+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.
+**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 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/Syndication-Tool_Reporting.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,10 +4,10 @@
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 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/TODO.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -1,60 +1,60 @@
Missing Use Cases
=================
-"ContentCreator":Actor_ContentCreator
+"ContentCreator":doc:`Actor_ContentCreator`
-------------------------------------
- - "Define content metadata":ChangeMetadata
+* "Define content metadata":doc:ChangeMetadata`
- - "Make a content object discussable":EnableDiscussion
+* "Make a content object discussable":doc:`EnableDiscussion`
-"MembershipManager":Actor_MembershipManager
+"MembershipManager":doc:`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":doc:`AddMemberToUserFolder`
- - "Change member information and abilities":ChangeMemberInformation
+* "Change member information and abilities":doc:`ChangeMemberInformation`
- - "Browse member roster":BrowseMemberRoster
+* "Browse member roster":doc:`BrowseMemberRoster`
- - "Remove a member from the site":RemoveMemberFromSite
+* "Remove a member from the site":doc:`RemoveMemberFromSite`
-"SiteDesigner":Actor_SiteDesigner
+"SiteDesigner":docActor_SiteDesigner`
---------------------------------
- - "Create new skin for the site":CreateNewSkin
+* "Create new skin for the site":doc:`CreateNewSkin`
- - "Modify skin appearance":ChangeSkinLookAndFeel
+* "Modify skin appearance":doc:`ChangeSkinLookAndFeel`
- - "Change skin behavior":ChangeSkinBehavior
+* "Change skin behavior":doc:`ChangeSkinBehavior`
- - "Change the default skin for the site":ChangeDefaultSiteSkin
+* "Change the default skin for the site":doc`ChangeDefaultSiteSkin`
-"SiteManager":Actor_SiteManager
+"SiteManager":doc:`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" :doc:`ConfigureAllowedContentTypes`
- - "Configure security for a content object
- or folder":ConfigureObjectSecurity
+* "Configure security for a content object or folder":
+ :doc:`ConfigureObjectSecurity`
- - "Associate a workflow with a content
- type":AssociateWorkflowWithContentType
+* "Associate a workflow with a content
+ type":doc:`AssociateWorkflowWithContentType`
- - "Configure required metadata for a content
- type":ConfigureRequiredMetadata
+* "Configure required metadata for a content
+ type":doc:ConfigureRequiredMetadata`
- - "Configure what content is released via
- syndication":ConfigureContentSyndiation
+* "Configure what content is released via
+ syndication":doc:`ConfigureContentSyndiation`
"SiteVisitor":Actor_SiteVisitor
-------------------------------
- - "Submit a news item":SubmitNewsItem
+ * "Submit a news item":doc:`SubmitNewsItem`
- - "Browse a portal topic":BrowsePortalTopic
+ * "Browse a portal topic":doc:`BrowsePortalTopic`
Modified: Products.CMFDefault/trunk/docs/narrative/UndoChanges.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/UndoChanges.rst 2012-04-04 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/UndoChanges.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,38 +4,35 @@
Actor
-----
- - Content Creator
+Content Creator
Assumptions
-----------
- - Content Creator has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+* Content Creator has logged into the CMF (see :doc:`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
+ :doc:`ChangeContent`).
- - The changes are "undoable"[1].
+* The changes are "undoable" [#]_.
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
------
+.. :rubric::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.
+.. [#]
+ 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 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/UnpublishContent.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,28 +4,26 @@
Actor
-----
- - Reviewer
+Reviewer
Assumptions
-----------
- - Reviewer has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+* Reviewer has logged into the CMF (see :doc:`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 :doc:`ApproveForPublication`).
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 19:43:56 UTC (rev 124950)
+++ Products.CMFDefault/trunk/docs/narrative/ViewMyContent.rst 2012-04-04 21:24:03 UTC (rev 124951)
@@ -4,33 +4,30 @@
Actor
-----
- - Content Creator
+Content Creator
Assumptions
-----------
- - Content Creator has logged into the CMF (see "Login to the
- Site":LoginAsMember).
+* Content Creator has logged into the CMF (see :doc:`LoginAsMember`).
- - Content Creator has created content (see "Create Content
- Object":CreateNewContent).
+* Content Creator has created content (:doc:`CreateNewContent`).
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 [#]_.
-Notes
------
+.. :rubric::Notes
-..[1] For a more detailed description of the options for advanced
- searching, see "Search CMF Site":SearchCMFSite.
+.. [#]
+ For a more detailed description of the options for advanced searching,
+ see "Search CMF Site":SearchCMFSite.
More information about the checkins
mailing list