[CMF-checkins] CVS: CMF/docs - Tour.stx:1.4

Amos Latteier amos@zope.com
Wed, 21 Nov 2001 20:05:16 -0500


Update of /cvs-repository/CMF/docs
In directory cvs.zope.org:/tmp/cvs-serv8165

Modified Files:
	Tour.stx 
Log Message:
Edited the tour a bit. It's fairly decent but it's unclear what scenarios are missing. It also lacks a conclusion. Plus the handling of screenshots is unfinished.


=== CMF/docs/Tour.stx 1.3 => 1.4 ===
 
-  The Zope Content Management Framework can be used to provide a whole
-  range of content management solutions.  In this chapter, we'll take
-  you on a quick tour of an online newspaper. Keep in mind that this
-  is just one example of using the CMF to manage content.
+  The Zope Content Management Framework provides a whole range of
+  content management solutions.  In this chapter, we'll take you on a
+  quick tour of an online newspaper. Keep in mind that this is just
+  one example of using the CMF to manage content.
 
   Imagine a small newspaper that has reporters, editors, and readers.
-  The reporters want to create new news stories that are submitted to
-  the editor.  The editor needs to either approve or reject those
-  stories.  Approved stories go on to the front page of the newspaper,
-  but rejected stories are sent back to the reporter to be revised and
+  The reporters create news stories and submit them to the editor.
+  The editor needs to either approve or reject those stories.
+  Approved stories go on to the front page of the newspaper, but
+  rejected stories are sent back to the reporter to be revised and
   reviewed again.
 
   This may sound like a simple problem to solve with email, but an
-  email system does not enforce a certain flow of actions that need to
-  be taken.  If a reporter sends their story to the editor by email,
-  the editor may simply forget to take care of it.  
-  
-  The email system can't remind him to take care of it, because with
-  email the workflow and what state the work is in must always be
-  known by the various actors involved, and if one person forgets a
-  task the whole system breaks down.  The more actors you add to
-  an email-based system, the faster it becomes unmanageable.
-
-  A true workflow system like Zope's CMF keeps the user focused on
-  achieving their goals.  The editor can't go off and forget to review
-  a story, because anytime editors log in they are shown a list of
-  pending articles they (or someone with the same editorial "role")
-  must review.
+  email system does not ensure that the proper business process is
+  followed.  If a reporter sends their story to the editor by email,
+  the editor may simply forget to take care of it.
+  The email system can't remind him to take care of it. 
+
+  If you use email to manage workflow, everyone must remember to
+  perform their tasks and to notify others as appropriate.  If one
+  person forgets to perform a task or notify someone, the whole system
+  breaks down.  The more people you add to an email-based system, the
+  faster it becomes unmanageable.
+
+  A true workflow system like Zope's CMF keeps users focused on
+  achieving their goals.  For example, editors don't need to manually
+  keep track of the articles they have to review because they CMF does
+  it for them. When an editor logs in they are shown a list of pending
+  articles they (or someone with the same editorial "role") must
+  review.
 
   In the next sections, we'll walk you through six different day to
   day scenarios at a fictitious newspaper.  In later chapters, we'll
-  show you how you can go about building a site like this using Zope's
-  CMF in no time.  In fact, this example is from a stock CMF and no
-  HTML programming, python scripting or any other advanced techniques
-  are needed to create it.
+  show you how you can build a site like this using Zope's CMF in no
+  time.  As you'll see, this example application doesn't require
+  advanced techniques are to create it.
 
-  Scenario: Create content.
+  Scenario: Create Content
 
     The most basic task in the Zope CMF is to create content.
-    *Content* are objects like documents, folders, news items, files,
-    images, and discussion topics. In the following screen shot:
+    *Content* consists of things like documents, folders, news items,
+    files, images, and discussion topics. In the following screen
+    shot:
 
       <screenshot>
 
@@ -62,22 +64,25 @@
     *Change*.  Now Fred has created some content in Zope.  He can
     repeat this task as many times as he wants for lots of content.
 
-  Scenario: Submit, Review, Approve content.
+  Scenario: Submit, Review, and Approve Content
 
     We just showed how Fred can create News content in his area.  Now
     in a newspaper, this news should be first read and approved by the
-    editor.  This is called *workflow*.  Fred writes the content and
-    the editor, Janet, reads and either approves or rejects Fred's
-    stories.
+    editor.  Standard business procedures like this are called
+    *workflow*.  Fred writes the content and the editor, Janet, reads
+    and either approves or rejects Fred's stories.
 
     This kind of simple workflow is built right into the CMF.  Let's
     look at the last news item Fred created:
 
       <screenshot>
 
-    Notice the *Submit* link on the left.  Clicking this link will
-    submit this news item for review.  When Janet logs in, she gets a
-    special message that tells her if she has any pending items:
+    Notice the *Submit* link on the left.  When Fred clicks this link,
+    Zope will submit this news item for review.  When Janet logs in,
+    she gets a special message that tells her if she has any pending
+    items:
+
+      <screenshot>
 
     Janet can now click on the *Pending (1)* link in the bottom left
     hand corner of her member area.  When Janet clicks on this link,
@@ -91,27 +96,28 @@
 
       <screenshot>
 
-    If she accepts them, they become public on the site and
-    the newspapers readers will see the story on the front page.  If
-    she rejects a story, she can type in a reason why into a box and a
+    If she accepts a story, it becomes public on the site and the
+    newspapers readers will see the story on the front page.  If she
+    rejects a story, she can type in a reason why into a box and a
     message is sent back to Fred, telling him that his story was
     rejected and the reason why.  Fred can now revise the story and
     submit it again for approval.
 
-  Scenario Search content
+  Scenario: Search Content
 
-    Recent stories on the front page are timely, but sometimes users
-    may want to search through a large amount of news, or search news
-    in the past.  The Zope CMF lets you do many kinds of searches on
-    your content.  At the top left of every screen is a *search* link.
-    Clicking this link will take you to the CMF search page:
+    Recent stories on the front page are easily available, but
+    sometimes users may want to search through a large amount of news,
+    or search news in the past.  The CMF lets you do many kinds of
+    searches on your content.  At the top left of every screen is a
+    *search* link.  Clicking this link will take you to the CMF search
+    page:
 
       <screenshot>
 
-    Here, you can specify search terms and get reports back on what
-    kind of content matches your terms.  For example, you can search
-    for content that contains the words "baked beans" by typing those
-    words into the *Text* field and then clicking *Search*:
+    Here, you can specify search terms and get reports on matching
+    content.  For example, you can search for content that contains
+    the words "baked beans" by typing those words into the *Text*
+    field and then clicking *Search*:
 
       <screenshot>
 
@@ -119,27 +125,27 @@
     than one term.  For example, "Fred" can be selected from the
     *Author* field and only content created by Fred will be searched.
 
-  Scenario: Undo mistakes.
+  Scenario: Undo Mistakes
 
     People make mistakes.  Fred could submit a story and then realize
     that he forgot some details.  Janet could reject a story by
-    accidentally clicking the wrong button.  In a world of mistakes,
-    the CMF lets you undo all of the actions you take.  After creating
-    a new news item, here is what Fred sees when he clicks the *Undo*
-    link in his personal area:
+    accidentally clicking the wrong button.  The CMF lets you undo all
+    of the actions you take.  After creating a new news item, here is
+    what Fred sees when he clicks the *Undo* link in his personal
+    area:
 
       <screenshot>
 
-    The first item on the list was creating the news item.  Fred can
-    undo this by selecting the first check box and clicking *Undo*.
-    Now when he goes back to his Member area, the new news item he
-    created is gone.
+    The first item on the list represents the creation of the news
+    item.  Fred can undo this action by selecting the first check box
+    and clicking *Undo*.  Now when he goes back to his Member area,
+    the news item he just created is gone.
 
     All users have the same interface for undoing their actions.  If
     Janet accidentally clicks the wrong button, she can undo that
     mistake the same way Fred undid his.
 
-  Scenario: Organize content.
+  Scenario: Organize Content
 
     Being able to search through content is pretty useful, but it
     would be more useful if you could categorize your content with
@@ -164,13 +170,17 @@
     list of keywords which will return only content items that are
     tagged with those categories.
 
-  Scenario Share content.
+  Scenario: Share Content
 
     Reporter 1 adds content, gives report 2 'Owner' role
 
     Reporter 2 can access content and change it
 
+    XXX unfinished
+
+  Conclusion
 
+    XXX