[Checkins] SVN: Products.CMFDefault/trunk/docs/api/ Formatting cleanup and links added.
Charlie Clark
cvs-admin at zope.org
Thu Mar 22 10:19:04 UTC 2012
Log message for revision 124681:
Formatting cleanup and links added.
Changed:
U Products.CMFDefault/trunk/docs/api/ActorDefinitions.rst
U Products.CMFDefault/trunk/docs/api/Actor_ContentCreator.rst
U Products.CMFDefault/trunk/docs/api/Actor_Reviewer.rst
U Products.CMFDefault/trunk/docs/api/MoveCopyContent.rst
-=-
Modified: Products.CMFDefault/trunk/docs/api/ActorDefinitions.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/ActorDefinitions.rst 2012-03-21 21:52:48 UTC (rev 124680)
+++ Products.CMFDefault/trunk/docs/api/ActorDefinitions.rst 2012-03-22 10:18:59 UTC (rev 124681)
@@ -1,62 +1,51 @@
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.
+**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 :doc:`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.
+**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 :doc:`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.
+**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 :doc:`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.
+**Add-on Developer** --
+ This actor is responsible for implementing new functionality that is
+ suitable for distribution to one or more sites. ** See :doc:`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.
+**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 :doc:`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.
+**Workflow Designer** --
+ The Workflow Designer is responsible for defining new workflows and
+ customizing existing workflows to meet business goals. See
+ :doc:`Actor_WorkflowDesigner`.
- **Content Creator** --
- Content Creators are responsible for producing and
- maintaining the actual content of a site. See "Actor:
- Content Creator":Actor_ContentCreator.
+**Content Creator** --
+ Content Creators are responsible for producing and maintaining the actual
+ content of a site. :doc:`Actor_ContentCreator`.
- **Reviewer** --
- This actor is responsible for ensuring the quality and
- correctness of site content. See "Actor:
- Reviewer":Actor_Reviewer.
+**Reviewer** --
+ This actor is responsible for ensuring the quality and correctness of site
+ content. See :doc:`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.
+**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
+ :doc:`Actor_SiteVisitor`.
Modified: Products.CMFDefault/trunk/docs/api/Actor_ContentCreator.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/Actor_ContentCreator.rst 2012-03-21 21:52:48 UTC (rev 124680)
+++ Products.CMFDefault/trunk/docs/api/Actor_ContentCreator.rst 2012-03-22 10:18:59 UTC (rev 124681)
@@ -1,60 +1,58 @@
Content Creator Goals
=====================
- * Make information available to the end users of the site.
+* Make information available to the end users of the site.
- - "Create a content object":CreateNewContent
+- :doc:`CreateNewContent`
- o Add Content form with a slightly more involved
- description of each content type that comes with the CMF.
+ - 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.
+ - 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.
+ - "Edit" form.
- - **XXX** "Define content metadata":ChangeMetadata
+- **XXX** "Define content metadata":ChangeMetadata
- This should mainly be pointers back to "Create a content object".
+ This should mainly be pointers back to :doc:`CreateNewContent`.
- - "Submit content for publication":SubmitContentForPublication
+- :doc:`SubmitContentForPublication`
- o Brief discussion of workflow with references back to
- workflow use cases.
+ - Brief discussion of workflow with references back to
+ workflow use cases.
- o Submit for the default workflow
+ - Submit for the default workflow
- * Ensure that information is up-to-date and accurate.
+* Ensure that information is up-to-date and accurate.
- - "View personally authored content":ViewMyContent
+- :doc:`ViewMyContent`
- - "Update existing content":ChangeContent
+- :doc:`ChangeContent`
- - "Remove unneeded content":RemoveContent
+- :doc:`RemoveContent`
- - "Undo changes to content":UndoChanges
+- :doc:`UndoChanges`
- * Improve content quality over time using end user
- feedback.
+* Improve content quality over time using end user feedback.
- - **XXX** "Make a content object discussable":EnableDiscussion
+- **XXX** :doc:`EnableDiscussion`
- *Note: this is not a per-object option in stock CMF.*
+ *Note: this is not a per-object option in stock CMF.*
- * Collaborate with other content creators.
+* Collaborate with other content creators.
- - "Give local roles to other users":ManageLocalRoles
+- :doc:`ManageLocalRoles`
- * Modify content organization to improve maintainability
- or navigation.
+* Modify content organization to improve maintainability or navigation.
- - "Add content folders":AddContentFolders
+- :doc:`AddContentFolders`
- - "Move / copy content between folders":MoveCopyContent
+- :doc:`MoveCopyContent`
- - "Rename content object":RenameContent
+- :doc:`RenameContent`
Modified: Products.CMFDefault/trunk/docs/api/Actor_Reviewer.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/Actor_Reviewer.rst 2012-03-21 21:52:48 UTC (rev 124680)
+++ Products.CMFDefault/trunk/docs/api/Actor_Reviewer.rst 2012-03-22 10:18:59 UTC (rev 124681)
@@ -1,23 +1,22 @@
Reviewer Goals
==============
- * Collaborate with content creators to ensure the quality and
- timeliness of site content.
+* Collaborate with content creators to ensure the quality and timeliness of
+ site content.
- - "Browse content submitted for review and
- publication":BrowseSubmittedForReview
+- :doc:`BrowseSubmittedForReview`
- o Brief description of the Action box, with pointers back to
- where this is set up in the skin.
+ - Brief description of the Action box, with pointers back to
+ where this is set up in the skin.
- o Pending lists
+ - Pending lists
- - "Approve content for publication":ApproveForPublication
+- :doc:`ApproveForPublication`
- This should mainly be a pointer back into "Browse content
- submitted for review and publication"
+ This should mainly be a pointer back into "Browse content
+ submitted for review and publication"
- * React quickly to resolve issues with published content.
+* React quickly to resolve issues with published content.
- - "Remove content from public site":UnpublishContent
+ - :doc:`UnpublishContent`
Modified: Products.CMFDefault/trunk/docs/api/MoveCopyContent.rst
===================================================================
--- Products.CMFDefault/trunk/docs/api/MoveCopyContent.rst 2012-03-21 21:52:48 UTC (rev 124680)
+++ Products.CMFDefault/trunk/docs/api/MoveCopyContent.rst 2012-03-22 10:18:59 UTC (rev 124681)
@@ -9,20 +9,18 @@
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 move (or copy) to another folder.
+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
+ 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 move or copy.
+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).
@@ -30,12 +28,12 @@
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).
+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.
+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.
+7. To undo this action, see :doc:`UndoChanges`.
More information about the checkins
mailing list