vendor/CMF/1.5.2/docs

view Tour.stx @ 0:33c8dd739958

Vendor import of CMF 1.5.2
author fguillaume
date Wed, 20 Jul 2005 16:21:26 +0000
parents
children
line source
1 Chapter 2: CMF Tour
3 The Zope Content Management Framework provides a whole range of
4 content management solutions. In this chapter, we'll take you on a
5 quick tour of an online newspaper. Keep in mind that this is just
6 one example of using the CMF to manage content.
8 Imagine a small newspaper that has reporters, editors, and readers.
9 The reporters create news stories and submit them to the editor.
10 The editor needs to either approve or reject those stories.
11 Approved stories go on to the front page of the newspaper, but
12 rejected stories are sent back to the reporter to be revised and
13 reviewed again.
15 This may sound like a simple problem to solve with email, but an
16 email system does not ensure that the proper business process is
17 followed. If a reporter sends their story to the editor by email,
18 the editor may simply forget to take care of it.
19 The email system can't remind him to take care of it.
21 If you use email to manage workflow, everyone must remember to
22 perform their tasks and to notify others as appropriate. If one
23 person forgets to perform a task or notify someone, the whole system
24 breaks down. The more people you add to an email-based system, the
25 faster it becomes unmanageable.
27 A true workflow system like Zope's CMF keeps users focused on
28 achieving their goals. For example, editors don't need to manually
29 keep track of the articles they have to review because they CMF does
30 it for them. When an editor logs in they are shown a list of pending
31 articles they (or someone with the same editorial "role") must
32 review.
34 In the next sections, we'll walk you through six different day to
35 day scenarios at a fictitious newspaper. In later chapters, we'll
36 show you how you can build a site like this using Zope's CMF in no
37 time. As you'll see, this example application doesn't require
38 advanced techniques are to create it.
40 Scenario: Create Content
42 The most basic task in the Zope CMF is to create content.
43 *Content* consists of things like documents, folders, news items,
44 files, images, and discussion topics. In the following screen
45 shot:
47 <screenshot>
49 You see the content management interface for Fred. Fred is a
50 reporter that works at our newspaper, and today he is going to
51 write a story. He does this by creating a news object in his
52 personal area. He can do this by clicking on the *New* button.
54 <screenshot>
56 After clicking the *New* button, Fred is taken to this screen
57 where he can choose a type of content to create. He's going to
58 select *News Item* type in an id, and click *Add and Edit*.
60 <screenshot>
62 Here we see Fred is now editing the news item he just created. He
63 types in some news about the local school BBQ, and clicks
64 *Change*. Now Fred has created some content in Zope. He can
65 repeat this task as many times as he wants for lots of content.
67 Scenario: Submit, Review, and Approve Content
69 We just showed how Fred can create News content in his area. Now
70 in a newspaper, this news should be first read and approved by the
71 editor. Standard business procedures like this are called
72 *workflow*. Fred writes the content and the editor, Janet, reads
73 and either approves or rejects Fred's stories.
75 This kind of simple workflow is built right into the CMF. Let's
76 look at the last news item Fred created:
78 <screenshot>
80 Notice the *Submit* link on the left. When Fred clicks this link,
81 Zope will submit this news item for review. When Janet logs in,
82 she gets a special message that tells her if she has any pending
83 items:
85 <screenshot>
87 Janet can now click on the *Pending (1)* link in the bottom left
88 hand corner of her member area. When Janet clicks on this link,
89 it takes her to this screen:
91 <screenshot>
93 Here, Janet can either accept or reject Fred's stories. To do
94 that, she clicks on the new story and selects either 'Publish' or
95 'Reject' on the left of the screen:
97 <screenshot>
99 If she accepts a story, it becomes public on the site and the
100 newspapers readers will see the story on the front page. If she
101 rejects a story, she can type in a reason why into a box and a
102 message is sent back to Fred, telling him that his story was
103 rejected and the reason why. Fred can now revise the story and
104 submit it again for approval.
106 Scenario: Search Content
108 Recent stories on the front page are easily available, but
109 sometimes users may want to search through a large amount of news,
110 or search news in the past. The CMF lets you do many kinds of
111 searches on your content. At the top left of every screen is a
112 *search* link. Clicking this link will take you to the CMF search
113 page:
115 <screenshot>
117 Here, you can specify search terms and get reports on matching
118 content. For example, you can search for content that contains
119 the words "baked beans" by typing those words into the *Text*
120 field and then clicking *Search*:
122 <screenshot>
124 Here are the results of the search. You can also specify more
125 than one term. For example, "Fred" can be selected from the
126 *Author* field and only content created by Fred will be searched.
128 Scenario: Undo Mistakes
130 People make mistakes. Fred could submit a story and then realize
131 that he forgot some details. Janet could reject a story by
132 accidentally clicking the wrong button. The CMF lets you undo all
133 of the actions you take. After creating a new news item, here is
134 what Fred sees when he clicks the *Undo* link in his personal
135 area:
137 <screenshot>
139 The first item on the list represents the creation of the news
140 item. Fred can undo this action by selecting the first check box
141 and clicking *Undo*. Now when he goes back to his Member area,
142 the news item he just created is gone.
144 All users have the same interface for undoing their actions. If
145 Janet accidentally clicks the wrong button, she can undo that
146 mistake the same way Fred undid his.
148 Scenario: Organize Content
150 Being able to search through content is pretty useful, but it
151 would be more useful if you could categorize your content with
152 your own keywords. This way, you could tag certain news items
153 with special keywords like 'Local' or 'Financial' and offer your
154 users the ability to look for items that match those keywords.
156 When Fred creates a new news item, he can click on the *Metadata*
157 link on the left of the content's interface. On this next screen,
158 he can enter keywords for the content in the *Category* form
159 element:
161 <screenshot>
163 Here, Fred gave this news item the keyword 'birds'. Fred can add
164 as many keywords as he wants. The next time he creates content,
165 all of the keywords he has defined so far will show up in a pull
166 down box on the *Metadata* screen, so that he can just select the
167 ones he wants.
169 Now, when Fred goes to the *search* link, he can choose from a
170 list of keywords which will return only content items that are
171 tagged with those categories.
173 Scenario: Share Content
175 Reporter 1 adds content, gives report 2 'Owner' role
177 Reporter 2 can access content and change it
179 XXX unfinished
181 Conclusion
183 XXX
187 XXX screenshots need to be done correctly, also they should to
188 retaken to reflect the new ZPT skins.