[Checkins] SVN: Products.CMFDefault/trunk/docs/narrative/ Better ReST formatting and proper footnote markup.
Charlie Clark
cvs-admin at zope.org
Wed Apr 4 18:12:15 UTC 2012
Log message for revision 124944:
Better ReST formatting and proper footnote markup.
Changed:
U Products.CMFDefault/trunk/docs/narrative/AddContentFolders.rst
U Products.CMFDefault/trunk/docs/narrative/ApproveForPublication.rst
U Products.CMFDefault/trunk/docs/narrative/BecomeAMember.rst
U Products.CMFDefault/trunk/docs/narrative/BrowseCMFSiteHomepage.rst
U Products.CMFDefault/trunk/docs/narrative/BrowseNewsItems.rst
U Products.CMFDefault/trunk/docs/narrative/BrowseSubmittedForReview.rst
U Products.CMFDefault/trunk/docs/narrative/ChangeContent.rst
U Products.CMFDefault/trunk/docs/narrative/ConfigureCMFSite.rst
U Products.CMFDefault/trunk/docs/narrative/ConfigurePersonalization.rst
U Products.CMFDefault/trunk/docs/narrative/CreateCMFFolder.rst
-=-
Modified: Products.CMFDefault/trunk/docs/narrative/AddContentFolders.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/AddContentFolders.rst 2012-04-04 09:21:41 UTC (rev 124943)
+++ Products.CMFDefault/trunk/docs/narrative/AddContentFolders.rst 2012-04-04 18:12:11 UTC (rev 124944)
@@ -25,7 +25,7 @@
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 :ref:`[1]` for the new folder in the input
+ adjacent radio button. Supply an ID [#]_ 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
@@ -41,15 +41,12 @@
6. Click the "Change" button. The system will update the folder's metadata
using the values you supply.
-Notes
------
+.. rubric:: Notes
-.. _[1]:
-
-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).
+.. [#]
+ 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).
Modified: Products.CMFDefault/trunk/docs/narrative/ApproveForPublication.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/ApproveForPublication.rst 2012-04-04 09:21:41 UTC (rev 124943)
+++ Products.CMFDefault/trunk/docs/narrative/ApproveForPublication.rst 2012-04-04 18:12:11 UTC (rev 124944)
@@ -4,39 +4,34 @@
Actor
-----
- - Reviewer
+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.
+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).
+* Reviewer has logged into the CMF (see :doc:`LoginAsMember`).
- - Content has been submitted for review (see "Submit content for
- publication":SubmitContentForPublication).
+* Content has been submitted for review (see :doc:`SubmitContentForPublication`).
- - Reviewer has completed the Use Case: "Browse for content submitted
- for review and publication":BrowseSubmittedForReview.
+* Reviewer has completed the Use Case: :doc:`BrowseSubmittedForReview`.
Procedure
---------
- 1. Select the item from the list of content pending review.
+1. Select the item from the list of content pending review.
- 2. From the actions box, select the 'Publish' link.
+2. From the actions box, select the 'Publish' link.
- 3. Enter appropriate comments.
+3. Enter appropriate comments.
- 4. Select the Publish this item button.
+4. Select the Publish this item button.
- 5. The item has been published.
+5. The item has been published.
- 6. You can now "Browse for content submitted for review and
- publication":BrowseSubmittedForReview to repeat this process.
+6. You can now :doc:`BrowseSubmittedForReview to repeat this process.
Modified: Products.CMFDefault/trunk/docs/narrative/BecomeAMember.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/BecomeAMember.rst 2012-04-04 09:21:41 UTC (rev 124943)
+++ Products.CMFDefault/trunk/docs/narrative/BecomeAMember.rst 2012-04-04 18:12:11 UTC (rev 124944)
@@ -4,43 +4,40 @@
Actor
-----
- - Site Visitor
+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.
+Becoming a member of a site allows you to access the additional services of
+the site. Often this includes a personal online work area (your "desktop"),
+the ability create and submit your own content for publication and the
+ability to personalize the look and behavior of the site to better meet your
+needs.
- Note that different sites have different purposes, and the specific
- services available to site members depends on the choices of the
- site administrators. By default, a CMF site provides members with a
- private "desktop", the ability to create certain types of basic
- content and the ability to select the visual style of the site that
- they see.
+Note that different sites have different purposes, and the specific services
+available to site members depends on the choices of the site administrators.
+By default, a CMF site provides members with a private "desktop", the ability
+to create certain types of basic content and the ability to select the visual
+style of the site that they see.
Procedure
---------
- 1. To become a member of a site, visit the site homepage and click on
- the "Join" link in the menu located on the left side of the page.
+1. To become a member of a site, visit the site homepage and click on the
+ "Join" link in the menu located on the left side of the page.
- 2. Clicking the "Join" link will take you to a form. Complete
- the fields on the form and click the "Register" button to
- become a registered member of the site.
+2. Clicking the "Join" link will take you to a form. Complete the fields on
+ the form and click the "Register" button to become a registered member of the
+ site.
- 3. The exact information required by the registration form will
- vary from site to site. The form for a default CMF site
- requires visitors to provide at least a login name, a
- password and a valid email address to become a member. The
- default form also gives you an option to have the password
- you provided at registration time emailed to you for future
- reference.
+3. The exact information required by the registration form will vary from
+ site to site. The form for a default CMF site requires visitors to provide at
+ least a login name, a password and a valid email address to become a member.
+ The default form also gives you an option to have the password you provided
+ at registration time emailed to you for future reference.
- 4. After submitting the member registration form, you should
- see a page informing you that you have successfully been
- registered as a site member. This page also provides a link
- that you can use to log into the site immediately.
+4. After submitting the member registration form, you should see a page
+ informing you that you have successfully been registered as a site member.
+ This page also provides a link that you can use to log into the site
+ immediately.
Modified: Products.CMFDefault/trunk/docs/narrative/BrowseCMFSiteHomepage.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/BrowseCMFSiteHomepage.rst 2012-04-04 09:21:41 UTC (rev 124943)
+++ Products.CMFDefault/trunk/docs/narrative/BrowseCMFSiteHomepage.rst 2012-04-04 18:12:11 UTC (rev 124944)
@@ -4,31 +4,26 @@
Actor
-----
- - Site Visitor
+Site Visitor
Assumptions
-----------
- - Site Visitor has already navigated to a page within the CMF
- site[1].
+Site Visitor has already navigated to a page within the CMF site [#]_.
Procedure
---------
- 1. Selecting the 'home' link or the site logo
- from the top navigation bar.
+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.)
+2. Browse the content published there (e.g. 10 most recent News
+ Announcements, etc.)
-Notes
------
+.. rubric:: Notes
-..[1] Site Visitors may get to the site initially through several
- mechanisms:
+.. [#]
+ 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
+ * Links on another site, such as a search engine
+ * Mailed URLs
+ * Typing the URL directly
Modified: Products.CMFDefault/trunk/docs/narrative/BrowseNewsItems.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/BrowseNewsItems.rst 2012-04-04 09:21:41 UTC (rev 124943)
+++ Products.CMFDefault/trunk/docs/narrative/BrowseNewsItems.rst 2012-04-04 18:12:11 UTC (rev 124944)
@@ -4,27 +4,25 @@
Actor
-----
- - Site Visitor
+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.
+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.
+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.
+2. Navigate between batches of News Items by clicking the "10 older artcles"
+ and "10 newer articles" links.
Modified: Products.CMFDefault/trunk/docs/narrative/BrowseSubmittedForReview.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/BrowseSubmittedForReview.rst 2012-04-04 09:21:41 UTC (rev 124943)
+++ Products.CMFDefault/trunk/docs/narrative/BrowseSubmittedForReview.rst 2012-04-04 18:12:11 UTC (rev 124944)
@@ -4,28 +4,25 @@
Actor
-----
- - Reviewer
+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.
+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).
+* Reviewer has logged into the CMF (see :doc:`LoginAsMember`).
- - Content has been submitted for review (see "Submit content for
- publication":SubmitContentForPublication).
+* Content has been submitted for review (see :doc:`SubmitContentForPublication`).
Procedure
---------
- 1. From the actions box, select the 'Pending review (x)' link.
+1. From the actions box, select the 'Pending review (x)' link.
- 2. Browse the list of content which has been submitted for
- Publication.
+2. Browse the list of content which has been submitted for Publication.
Modified: Products.CMFDefault/trunk/docs/narrative/ChangeContent.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/ChangeContent.rst 2012-04-04 09:21:41 UTC (rev 124943)
+++ Products.CMFDefault/trunk/docs/narrative/ChangeContent.rst 2012-04-04 18:12:11 UTC (rev 124944)
@@ -4,44 +4,41 @@
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 piece of content you have the permissions to
- modify.
+1. Navigate to a piece of content you have the permissions to modify.
- To retrieve a list of the content you have authored, see
- "View personally authored content":ViewMyContent
+ To retrieve a list of the content you have authored, see
+ :doc:`ViewMyContent`
- 2. After selecting the piece of content you wish to update,
- select 'Edit' from the actions box.
+2. After selecting the piece of content you wish to update, select 'Edit'
+ from the actions box.
- 3. The 'Edit' link will take you to the edit form for your
- particular piece of content you wish to edit:
+3. The 'Edit' link will take you to the edit form for your
+ particular piece of content you wish to edit:
- - 'Body Textarea/File Upload' edit form (Documents)
+ * 'Body Textarea/File Upload' edit form (Documents)
- - 'Lead-in/Body' edit form (News Item)
+ * 'Lead-in/Body' edit form (News Item)
- - 'File Upload' edit form (Files, Images)
+ * 'File Upload' edit form (Files, Images)
- - 'Simple' edit form (Link, Favorite, Event)
+ * 'Simple' edit form (Link, Favorite, Event)
- Enter the changes you wish to make to the content in the form
- or browse to changed version of the content on your
- filesystem as appropriate.
+ Enter the changes you wish to make to the content in the form or browse to
+ changed version of the content on your filesystem as appropriate.
- 4. Click the change button. The system will save your changes,
- and display a change notification on the edit form confirming
- that the change has taken place.
+4. Click the change button. The system will save your changes, and display a
+ change notification on the edit form confirming that the change has taken
+ place.
- 5. To view your changes, click the 'View' link from the actions
- box and view your content with the changes in place.
+5. To view your changes, click the 'View' link from the actions box and view
+ your content with the changes in place.
Modified: Products.CMFDefault/trunk/docs/narrative/ConfigureCMFSite.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/ConfigureCMFSite.rst 2012-04-04 09:21:41 UTC (rev 124943)
+++ Products.CMFDefault/trunk/docs/narrative/ConfigureCMFSite.rst 2012-04-04 18:12:11 UTC (rev 124944)
@@ -4,7 +4,7 @@
Actor
-----
-- Site Manager
+Site Manager
Overview
--------
@@ -19,8 +19,8 @@
Assumptions
-----------
-Site Manager has logged into the CMF site using a user ID with
-the "Change configuration" permission (see "Login to the Site": LoginAsMember).
+Site Manager has logged into the CMF site using a user ID with the "Change
+configuration" permission (see :doc:`LoginAsMember`).
Procedure
---------
@@ -29,56 +29,51 @@
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' 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.
+**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.
+**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 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.
+**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.
+**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 "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.
+ 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.
Modified: Products.CMFDefault/trunk/docs/narrative/ConfigurePersonalization.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/ConfigurePersonalization.rst 2012-04-04 09:21:41 UTC (rev 124943)
+++ Products.CMFDefault/trunk/docs/narrative/ConfigurePersonalization.rst 2012-04-04 18:12:11 UTC (rev 124944)
@@ -4,48 +4,44 @@
Actor
-----
- - Site Visitor
+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.
+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).
+Site Visitor has logged into the CMF (see :doc:`LoginAsMember`).
Procedure
---------
- 1. Click the 'Preferences' link in your top user actions bar.
+1. Click the 'Preferences' link in your top user actions bar.
- 2. On the personalization form, you have the option of
- modifying the following:
+2. On the personalization form, you have the option of modifying the
+ following:
- **E-mail address** --
- your contact email address, used to send you your password
- if you forget it. The site administrator may also use
- this email to contact you when necessary.
+ **E-mail address** --
+ your contact email address, used to send you your password if you forget
+ it. The site administrator may also use this email to contact you when
+ necessary.
- **Listing status (off/on)** --
- determines if you're login name is visible to other
- members when they select the 'members' link from the
- navigation bar.
+ **Listing status (off/on)** --
+ determines if you're login name is visible to other members when they
+ select the 'members' link from the navigation bar.
- **Skin** --
- The 'look and feel' skin which is applied around the
- content of the site. The skin affects your 'view' while
- navigating the site.
+ **Skin** --
+ The 'look and feel' skin which is applied around the content of the site.
+ The skin affects your 'view' while navigating the site.
- 3. Update these preferences as desired and select the change button.
+3. Update these preferences as desired and select the change button.
- 4. The system will save your preferences and redisplay the
- personalization form with the a message stating that your
- preferences have been changed.
+4. The system will save your preferences and redisplay the
+ personalization form with the a message stating that your
+ preferences have been changed.
Modified: Products.CMFDefault/trunk/docs/narrative/CreateCMFFolder.rst
===================================================================
--- Products.CMFDefault/trunk/docs/narrative/CreateCMFFolder.rst 2012-04-04 09:21:41 UTC (rev 124943)
+++ Products.CMFDefault/trunk/docs/narrative/CreateCMFFolder.rst 2012-04-04 18:12:11 UTC (rev 124944)
@@ -4,41 +4,36 @@
Actor
-----
- - Site Manager
+Site Manager
Overview
--------
- Folders may used in CMF to help organize content. Folders may contain
- any kind of content object, including subfolders.
+Folders may used in CMF to help organize content. Folders may contain any
+kind of content object, including subfolders.
-Assumptions
------------
-
- - 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.
+To create a new Folder at a given place in the site heirarchy, navigate to
+the place where you want to add the new Folder, then click the "Folder
+Contents" link in the actions box. This will bring up the "desktop" view of
+the current Folder, listing the content objects and subfolders. In the
+desktop view, click the "New..." button.
- You will now see the "Add Content" form. This form provides a list of
- the kinds of objects you can add at this location (based on the
- permissions you have), and descriptions of the available objects.
+You will now see the "Add Content" form. This form provides a list of the
+kinds of objects you can add at this location (based on the permissions you
+have), and descriptions of the available objects.
- Select "Folder" from the listing, enter an id for the new folder in
- the "id" field located below the listing of available object, and
- click the "Add" button to add the new Folder.
+Select "Folder" from the listing, enter an id for the new folder in the "id"
+field located below the listing of available object, and click the "Add"
+button to add the new Folder.
- After submitting the add form, you will be taken to the "desktop" view
- of the newly created Folder.
+After submitting the add form, you will be taken to the "desktop" view of the
+newly created Folder.
Notes
-----
- - This use case is not specific to a Site Manager; it is
- properly a Content Creator use case.
+This use case is not specific to a Site Manager; it is properly a Content
+Creator use case.
More information about the checkins
mailing list