vendor/CMF/1.5.2/docs

view Using.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 3: Using the CMF
3 This chapter shows you how to get started with the CMF. It provides
4 a hands-on introduction to the basic features of the CMF.
6 Getting Started
8 Before you can begin you must have access to a Zope site with the
9 CMF installed. See *The Zope Book* for more information on
10 downloading and installing Zope. See XXX for more information on
11 downloading and installing the CMF.
13 Creating an Account
15 To use the CMF you must obtain a user account. Visit the CMF
16 site in your web browser. You should see a page as shown in
17 [3-1]:
19 "A CMF site":img:3-1:imgs/3-1.png
21 The dark blue bar across the top of the page gives you
22 information the CMF site and links to various site functions as
23 well as a search box. These links are called "Site Actions".
25 The light blue bar gives you information and links which relate
26 to your user account. The word "Guest" tells you that you are
27 not logged in. The "Log in" and "Join" links let you log in (if
28 you already have an account) or join the site to create a new
29 account. The links in the light blue bar are called "User
30 Actions".
32 The gray box on the left of the page tells you about the object
33 you are currently visting. In this case the XXX icon and the
34 name "XXX" indicate that you are currently viewing a document
35 named XXX. The "View" link allows you to view to document (which
36 you are currently doing). Depending on your user account and the
37 type of object you are visiting, you may have many different
38 options listed in the gray box. Links in the gray box are called
39 "Current Object Actions".
41 To the right of the gray box is an area of the page that tells
42 you the title and description of the object you are currently
43 visiting. There is also a "bread-crumbs" style navigation device
44 here which indicates where you are in the site, and provides
45 links to navigate back up to higher levels of the site. XXX
46 should explain this more?
48 Below the current object actions and the description of the
49 current object is the bulk of the page. While the rest of the
50 page will maintain a constant structure, this area will change
51 as you navigate between objects.
53 Depending on how your site is configured, things may look a bit
54 different. Nevertheless, you will always have access to site,
55 user, and current object actions on every page.
57 Click on the "Join" link to create a new account. You will be
58 taken to a form as shown in [3-2]:
60 "A join form":img:3-2:imgs/3-2.png
62 To create an account, simply fill out this form and click the
63 "Register" button. Depending on how your site is configured you
64 may see slightly different options. For example, some site allow
65 you to log in immediately, while others send you your password
66 via email. Once you have your password, it's time to log in.
68 Logging In and Out
70 To log in, click the "Log in" link. You will be taken to a log
71 in form as shown in [3-3]:
73 "A log in form":img:3-3:imgs/3-3.png
75 Type in your user name and password and click the "Login"
76 button. If all goes well you will be taken to a confirmation
77 page that tells you that you've logged in. If you've forgotten
78 your password you can try to log in again, or you can arrange to
79 have your password mailed to you.
81 Once you've logged in notice how light blue bar now says your
82 name. This tells you that you're logged in. Also notice that you
83 now have many more options in the current object actions area
84 than you had before. See [3-4] for an example:
86 "Logged in as Bob":img:3-4:imgs/3-4.png
88 Click the "Log out" link. You should be taken to a confirmation
89 page that tells you that you're successfully logged out. Notice
90 how the user and current object actions change. You are now
91 identified as "Guest", and have few actions available to you.
93 Now you know how to log in and log out of your site. In general
94 you should log in when you want to do some work on the site, and
95 you should log out of the site after your done using it.
97 Personalizing Your Account
99 Now log in to your site again. You can personalize the site by
100 clicking the "Preferences" link in the user actions area. It
101 takes you to a form where you can set your preferences as shown
102 in [3-5]:
104 "Preferences form":img:3-5:imgs/3-5.png
106 Depending on how your site is configured you may have different
107 preferences available. In this example you can change your email
108 address, whether you show up on the public member roster or not,
109 and your "skin". Skins give the site a customized look and
110 feel. Try selecting another skin and notice how the entire site
111 changes. You can still perform the same actions, but the new
112 skin changes the colors and formatting of the site.
114 Getting Around
116 Now let's take a look at some of the things you can do now that
117 you have an CMF account.
119 Using Navigation
121 You can navigate a CMF site using the standard site action
122 links. These are:
124 home -- The home or "root" of the CMF site.
126 members -- The members folder of the site. From here you can
127 navigate to individual member folders where site users keep most
128 of their content.
130 news -- A listing of recent news items.
132 search -- A detailed search form.
134 Instead of using the detailed search form, you can also perform
135 a quick search using the search box.
137 As previously mentioned there are also "breadcrumb" links above
138 the title of the current object. These links show you where the
139 current object is located in the site, and allow you to navigate
140 up to enclosing folders. The "root" link takes you to the top
141 (or home) of the site.
143 Your Member Folder
145 Click the "My Stuff" user action link. You will be taken to your
146 member area as shown in [3-6]:
148 "Member area":img:3-6:imgs/3-6.png
150 This is the part of the site where you can create your own
151 content. Your content is shown on this screen. Here you can
152 create new content and modify existing content. Creating and
153 editing content is covered in the next chapter.
155 Content is arranged in folders. The objects you see in your
156 member area are contained in your member folder. You can create
157 sub-folders inside your member folder. In fact you can think of
158 the entire site as a collection of objects within folders.
160 The word "Desktop" at the top of the screen indicates that you
161 are in the "Desktop" view. This view is similar to your
162 computer's file manager in that it displays folders and objects.
164 Using Folders
166 Create a new folder in your member folder by clicking the
167 "New..." button. Select "Folder" from the list of objects and
168 type "myFolder" into the "ID" field. Then click the "Add"
169 button. Next you'll be taken to a page where you can provide a
170 title and a description for your folder. Give the folder a title
171 of "example folder", and click the "Change" button. Zope should
172 inform you that the folder has been changed.
174 Now click the "My Stuff" link again. Notice that you now have a
175 folder named "myFolder" in your member area. Click on the
176 "myFolder" folder to see what's inside it. The folder is empty,
177 but it does have a link (shown as a folder with an up arrow)
178 which allows you to return to its parent (in this case your
179 member folder).
181 Now you know how to navigate between folders. Click on a folder
182 to enter it, and click on its parent link to return to the
183 enclosing folder.
185 Cutting and Pasting
187 Return to your member area by clicking the "My Stuff"
188 link. Notice that the objects in your member folder have check
189 boxes next to them. These controls let you select
190 objects. Select the "myFolder" folder that you created in the
191 last section. Now click the "Copy" button. Zope should inform
192 you that it successfully copied the folder. Now click the
193 "Paste" button. You should now have a "copy_of_myFolder"
194 folder. Select the copied folder and click the "Rename"
195 button. Rename the folder to "anotherFolder" and click the "Ok"
196 button.
198 When you copy and paste objects you get a complete copy of the
199 object including it's properties and sub-objects. For example,
200 notice that the copied folder has the same title as the
201 original. If the original folder had contained other objects, the
202 copy would have had copies of them as well.
204 The "Cut" button lets you copy an object and delete it from its
205 original location. Select the "anotherFolder" folder and
206 click "Cut". Zope tells you that the object has been cut, but it
207 does not disappear. Now enter the "myFolder" folder and click
208 the "Paste" button. The cut folder is now inside the "myFolder"
209 folder. Return to your member folder and notice that the cut
210 folder is now gone.
212 The "Delete" button allows you to remove an object without
213 copying it. Select the "myFolder" folder and click "Delete". The
214 folder disappears. You **cannot** click "Paste" to get the
215 folder back. You can however use "undo" to get the folder back.
217 Undo
219 You can recover from mistakes with the undo facility. Click the
220 "Undo" link. You'll be taken to a page that lists
221 transactions. Each transaction is a collection of changes made
222 by a person. Select the last transaction (it will have a name
223 like "/Site/folder_delete" and click the "Undo" button. Zope
224 will tell you that the transaction was undone. Now notice that
225 your folder has returned.
227 You can undo all kinds of actions, not just those related to
228 moving objects around. For example suppose you made a new item
229 public, and as a result it appeared on the site's home page. You
230 could make the new item private again, with undo. Undo reverts
231 all changes that are part of a transaction (for example changing
232 the news item's status as well as removing it from the home
233 page) at once.
235 View Filters
237 Sometimes it can get tedious looking through folders for things
238 you're interested in. To help you manage folder contents you can
239 use view filters. A view filter hides objects that you're not
240 interested in.
242 To create a view filter click the "Set View Filter" button in
243 the "Desktop" view. You'll be taken to a form where you can
244 specify what types of objects you want to see. You can filter
245 objects by subject and/or by type. To filter objects by subject
246 type a keyword in the "Subject" field. (See Chapter 4. for more
247 information on metadata and subject keywords.) To filter by type
248 select the content types that you want to see in the "Content
249 Type" multiple selection list. If you specify a subject as well
250 as content types, you will only see objects that match both
251 criteria. After you can selected your subject and/or content
252 type click the "Set Filter" button.
254 After you set the view filter notice that your folder contents
255 are changed to take the filter into account. Also notice how the
256 filter stays visible at the bottom of the "Desktop" view. If you
257 wish to hide the filter details click the "Close View Filter"
258 button. The view filter will still be active, but it's details
259 will be hidden. To show the view filter details click the "Set
260 View Filter" button. You can get rid of the filter by clicking
261 the "Clear View Filter" button. You can change the view filter
262 by selecting new filtering criteria and clicking the "Set View
263 Filter" button.
265 If you don't have many objects in your folders then the view
266 filter won't be much use to you. However, if you're managing a
267 lot of objects, it can be a great boon.
269 Favorites
271 The "Favorites" feature lets you manage personal bookmarks for
272 your site. Favorites give you a way to quickly navigate your
273 site.
275 Enter the "myFolder" folder you created earlier in this
276 chapter. Then enter the contained "anotherFolder" folder. Now
277 click the "Add to Favorites" link. You just created a shortcut
278 to this folder. Notice that you now have a "My Favorites" link
279 your user actions. Return to your member folder by clicking the
280 "My Stuff" link. Notice that you now have a "Favorites" folder
281 in your member folder. This folder holds your book marks.
283 To visit a favorite, click the "My Favorites" link. You'll be
284 taken to your Favorites folder. In this folder you'll see links
285 to all your favorites. Favorites are automatically given Id's by
286 Zope which have names like "fav_1007078408". Click on the
287 favorite. You'll be taken to a page that shows the URL of your
288 favorite. To visit the favorite, click on the URL. Notice that
289 the URL in your browser's location box changes. In this case the
290 appearance of page doesn't differ from the appearance of your
291 home page.
293 Other Actions
295 Depending on how your site is configured you may have a number
296 of links in your current object actions that haven't been discussed so
297 far. Here's a quick description of them:
299 * The "Folder contents" action simply takes you to the "Desktop"
300 view showing you the contents of the current folder. If you are
301 exploring a part of this site other than your member directory,
302 you can use the "Folder contents" link to inspect the objects at
303 this location.
305 * The "View" link shows you the public view of content or
306 folders. A folder's public view is provided by an object named
307 "index_html". Notice how there is an "index_html" document in
308 your member directory.
310 If you click "View" in your member folder you will see the
311 public view of the "index_html" document. If a folder has no
312 "index_html" object, Zope looks in its parent folder for an
313 "index_html" object. Zope continues to look in parent folders
314 until it finds an "index_html".
316 * The "Local Roles" link provides security controls that are
317 discussed in the Chapter 5.
319 * The "Syndication" link allows you to control content
320 syndication. Syndication is covered in Chapter 5.
322 * The "Edit", "Metadata", "Publish", and "Status history" links
323 let you edit content. Content editing is discussed in the
324 Chapter 4.
326 * The "Reconfigure portal" links allows you to set site
327 preferences. It is discussed in Chapter 5.
329 Using Services
331 The CMF provides a many services to your site. Here you'll learn
332 about publicly available services: search and discussion. In the
333 next chapter you'll find out about management services such as
334 workflow.
336 Searching
338 You can easily locate content on a CMF site using the search
339 service. All CMF content is searchable. The CMF provides easy to
340 use and powerful searching.
342 Type your username into the search box in the upper right corner
343 of the page and click the "Go" button. You should see your home
344 page document in the search results.
346 Now click the "search" link at the top of the page to perform an
347 advanced search. You'll be taken to a page where you can provide
348 detailed information about what you're looking for. All CMF
349 content is indexed using its full text as well as its metadata
350 (title, description, author, etc.) This allows you to perform
351 very precise searches.
353 The search service won't return content that you aren't
354 privileged to see. In the next chapter you'll learn about how
355 access to content protected. The search results are tailored to
356 the user doing the search to ensure that security settings are
357 respected.
359 XXX is this true, or are private items simply not cataloged?
361 Using Discussion
363 Sometimes when reading content you may want to provide feedback
364 to the author or to add comments to aid readers. You can discuss
365 content using the CMF's discussion feature.
367 To offer a comment or provide feedback on content click the
368 "Reply" action. This will take you to a form where you can
369 provide your input. Note that depending on how your site is
370 configured you may or may not see a "Reply" link in your current
371 object actions when viewing content.
373 Give you comment a short title and then type the body of your
374 comment in the "Reply body" field. When you're done you can
375 preview your comment by clicking the "Preview" button. If you're
376 statisfied with your comment click the "Reply" button, otherwise
377 click the "Edit" button to change your comment.
379 Once you submit your comment, it will be visible at the bottom
380 of the page. This way site visitors will be able to read your
381 comment when viewing the content.
383 In addition to replying to content, you can reply to a
384 comment. The CMF supported threaded discussions. You reply to a
385 comment in excactly the same way you reply to other content;
386 simply click the "Reply" link while reading the comment. Zope
387 displays threaded comments using a tree widget.
389 XXX doesn't seem to be turned on by default. The discussion tool
390 offers no knobs. Argh.
392 Conclusion
394 The CMF is structured around two central ideas: content and
395 services. Content consists of objects located in folders. You can
396 perform actions on content using links in your current object
397 actions. You can invoke services either through site actions, or
398 actions on objects. In the next chapter you'll learn more about
399 content.
401 XXX how many screen shots should there be in this chapter?