[CMF-checkins] CVS: CMF/docs - Configuration.stx:1.2 Content.stx:1.4 Outline.stx:1.8 Tour.stx:1.6 Using.stx:1.5
Amos Latteier
amos@zope.com
Thu, 6 Dec 2001 20:43:37 -0500
Update of /cvs-repository/CMF/docs
In directory cvs.zope.org:/tmp/cvs-serv6283
Modified Files:
Configuration.stx Content.stx Outline.stx Tour.stx Using.stx
Log Message:
Changed things to reflect the new ZPT skins. I no longer refer to an "action box" since there isn't one action box now. Instead I refer to site, user, and current object actions. Moved topics from the content chapter to the configuring chapter, and made some progress on the content chapter.
=== CMF/docs/Configuration.stx 1.1 => 1.2 ===
Security
- Setting local roles. Also basic Zope security info.
+ Setting local roles. Also basic Zope security info. permissions
+ needed to add various types of content and other objects.
Syndication
XXX It's unclear how this works
- Versioning
+ Topics
- XXX fiction? XXX
-
- Personalization
-
- XXX fiction? XXX
+ creating and managing topics.
Conclusion
=== CMF/docs/Content.stx 1.3 => 1.4 ===
When viewing your document, notice how there is a document icon
- and with the ID of your document in your action box. This
- indicates which object you are currently working on. You can
- navigate back to the editing form by clicking the "Edit" link in
- the action box. Likewise, you can change your document's
- metadata with the "Metadata" link. You can also see what your
- document looks like with the "View" link.
+ and with the ID of your document in your current object actions
+ area. This indicates which object you are currently working
+ on. You can navigate back to the editing form by clicking the
+ "Edit" link. Likewise, you can change your document's metadata
+ with the "Metadata" link. You can also see what your document
+ looks like with the "View" link.
The "Status", "Publish" and "Status History" links provide
workflow actions. They are discussed in the "Using Workflow"
@@ -96,7 +96,7 @@
The "View" link shows you information about your file (filename,
size, etc.) and allows you to download it. You can also download
- a file by clicking on its "Download" link in the action box.
+ a file by clicking on its "Download" action.
If you look carefully you'll notice that the URL of the download
link is simply the URL of the File. This allows you to easily
@@ -156,22 +156,75 @@
Using News Items
- XXX why don't these appear by default in the add list?
+ News items convey timely information to site visitors. You
+ should use News Items to inform others about events. If you have
+ substantive things to say you should create a document (or other
+ appropriate content object) to hold your information and then
+ create a news item to announce it. Later if you substantially
+ change your document (or other content) you can create another
+ news item to announce the changes.
+
+ You can create a News Item in the same way as you create other
+ CMF content types: navigate to the "Desktop" view, click
+ "New..." select "News Item", provide an ID, and click "Add". As
+ usual, you'll be taken to the metadata editing page. Type in
+ some metadata for your news item and click "Change and Edit".
+
+ You must provide a lead-in and a body for your news item. The
+ lead-in provides a short summary of the news item. You may
+ notice that the lead-in text is the same as the news items's
+ "Description" metadata. The news item's body is its complete
+ text in HTML format.
+
+ To view your News Item click the "View" link. News Items look
+ pretty much like Documents. Unlike Documents, however, public
+ News Items automatically appear on the site's news page. You can
+ navigate to this page by clicking the site's "news"
+ action. Later in this chapter you'll learn how to make your News
+ Items and other content public.
+
+ Example Content Types
+
+ The CMF ships with some example content types. Depending on how
+ your site is configured you may or may not have access to these
+ content types. The following is a brief description of example
+ add on packages and their content types:
- Using Topics
+ CMFCalendar -- This example package adds a calendaring
+ capabilities. It treats events as content objects.
- XXX why don't these appear by default in the add list?
+ CMFWiki -- Wikis enable low-tech collaboration. The CMFWiki
+ package treats wiki pages as content objects.
- XXX other standard types (event, wiki, etc.?)
+ CMFCollector -- The collector provides issue tracking. It treats
+ issues (such as bug reports) as content objects.
Custom Content Types
+ XXX
+
Content Authoring Formats
+ HTML
+
+ XXX
+
Structured Text
+ XXX
+
Using Metadata
+ XXX
+
Using Workflow
- Remote Authoring
\ No newline at end of file
+ XXX
+
+ Remote Authoring
+
+ XXX
+
+ Conclusion
+
+ XXX
\ No newline at end of file
=== CMF/docs/Outline.stx 1.7 => 1.8 ===
- Discussion
- - Security - setting roles and local roles
+ - Security - setting roles and local roles - permissions needed to
+ add various types of content and other objects.
- - Syndication XXX fiction ? XXX
+ - Syndication
- Versioning XXX fiction? XXX
=== CMF/docs/Tour.stx 1.5 => 1.6 ===
-
+ XXX screenshots need to be done correctly, also they should to
+ retaken to reflect the new ZPT skins.
=== CMF/docs/Using.stx 1.4 => 1.5 ===
"A CMF site":img:3-1:imgs/3-1.png
- The box on the left of the page that has the word "Guest" at the
- top is called the "action box". It contains a list of
- context-dependent links that give you access to site features.
+ The dark blue bar across the top of the page gives you
+ information the CMF site and links to various site functions as
+ well as a search box. These links are called "Site Actions".
+
+ The light blue bar gives you information and links which relate
+ to your user account. The word "Guest" tells you that you are
+ not logged in. The "Log in" and "Join" links let you log in (if
+ you already have an account) or join the site to create a new
+ account. The links in the light blue bar are called "User
+ Actions".
+
+ The gray box on the left of the page tells you about the object
+ you are currently visting. In this case the XXX icon and the
+ name "XXX" indicate that you are currently viewing a document
+ named XXX. The "View" link allows you to view to document (which
+ you are currently doing). Depending on your user account and the
+ type of object you are visiting, you may have many different
+ options listed in the gray box. Links in the gray box are called
+ "Current Object Actions".
+
+ To the right of the gray box is an area of the page that tells
+ you the title and description of the object you are currently
+ visiting. There is also a "bread-crumbs" style navigation device
+ here which indicates where you are in the site, and provides
+ links to navigate back up to higher levels of the site. XXX
+ should explain this more?
+
+ Below the current object actions and the description of the
+ current object is the bulk of the page. While the rest of the
+ page will maintain a constant structure, this area will change
+ as you navigate between objects.
+
+ Depending on how your site is configured, things may look a bit
+ different. Nevertheless, you will always have access to site,
+ user, and current object actions on every page.
- Click on the "Join" link in the action box. You will be taken to
- a form as shown in [3-2]:
+ Click on the "Join" link to create a new account. You will be
+ taken to a form as shown in [3-2]:
"A join form":img:3-2:imgs/3-2.png
@@ -35,8 +67,8 @@
Logging In and Out
- To log in, click the "Log in" link in the action box. You will
- be taken to a log in form as shown in [3-3]:
+ To log in, click the "Log in" link. You will be taken to a log
+ in form as shown in [3-3]:
"A log in form":img:3-3:imgs/3-3.png
@@ -46,18 +78,17 @@
your password you can try to log in again, or you can arrange to
have your password mailed to you.
- Once you've logged in notice how the action box now says your
- name at the top next to the person icon. This tells you that
- you're logged in. Also notice that you now have many more
- options in your action box than you had before. See [3-4] for an
- example:
+ Once you've logged in notice how light blue bar now says your
+ name. This tells you that you're logged in. Also notice that you
+ now have many more options in the current object actions area
+ than you had before. See [3-4] for an example:
"Logged in as Bob":img:3-4:imgs/3-4.png
- Click the "Log out" in the action box. You should be taken to a
- confirmation page that tells you that you're successfully logged
- out. Notice how the action box changes. It now says "Guest" at
- the top and contains different links.
+ Click the "Log out" link. You should be taken to a confirmation
+ page that tells you that you're successfully logged out. Notice
+ how the user and current object actions change. You are now
+ identified as "Guest", and have few actions available to you.
Now you know how to log in and log out of your site. In general
you should log in when you want to do some work on the site, and
@@ -66,8 +97,9 @@
Personalizing Your Account
Now log in to your site again. You can personalize the site by
- clicking the "Preferences" link in the action box. It takes you
- to a form where you can set your preferences as shown in [3-5]:
+ clicking the "Preferences" link in the user actions area. It
+ takes you to a form where you can set your preferences as shown
+ in [3-5]:
"Preferences form":img:3-5:imgs/3-5.png
@@ -86,18 +118,32 @@
Using Navigation
- To navigate the CMF site you'll normally use the site's normal
- navigation controls. As a CMF member you can navigate the site
- in the same way that anonymous site visitors do. You can use
- navigational links and search facilities.
+ You can navigate a CMF site using the standard site action
+ links. These are:
- In addition to normal site navigation, you can navigate the site
- using links in the action box.
+ home -- The home or "root" of the CMF site.
+ members -- The members folder of the site. From here you can
+ navigate to individual member folders where site users keep most
+ of their content.
+
+ news -- A listing of recent news items.
+
+ search -- A detailed search form.
+
+ Instead of using the detailed search form, you can also perform
+ a quick search using the search box.
+
+ As previously mentioned there are also "breadcrumb" links above
+ the title of the current object. These links show you where the
+ current object is located in the site, and allow you to navigate
+ up to enclosing folders. The "root" link takes you to the top
+ (or home) of the site.
+
Your Member Folder
- Click the "My Stuff" link in the action box. You will be taken
- to your member area as shown in [3-6]:
+ Click the "My Stuff" user action link. You will be taken to your
+ member area as shown in [3-6]:
"Member area":img:3-6:imgs/3-6.png
@@ -230,7 +276,7 @@
chapter. Then enter the contained "anotherFolder" folder. Now
click the "Add to Favorites" link. You just created a shortcut
to this folder. Notice that you now have a "My Favorites" link
- in the action box. Return to your member folder by clicking the
+ your user actions. Return to your member folder by clicking the
"My Stuff" link. Notice that you now have a "Favorites" folder
in your member folder. This folder holds your book marks.
@@ -247,10 +293,10 @@
Other Actions
Depending on how your site is configured you may have a number
- of links in your action box that haven't been discussed so
+ of links in your current object actions that haven't been discussed so
far. Here's a quick description of them:
- * The "Folder contents" action simple takes you to the "Desktop"
+ * The "Folder contents" action simply takes you to the "Desktop"
view showing you the contents of the current folder. If you are
exploring a part of this site other than your member directory,
you can use the "Folder contents" link to inspect the objects at
@@ -319,10 +365,10 @@
content using the CMF's discussion feature.
To offer a comment or provide feedback on content click the
- "Reply" link in the action box. This will take you to a form
- where you can provide your input. Note that depending on how
- your site is configured you may or may not see a "Reply" link in
- your action box when viewing content.
+ "Reply" action. This will take you to a form where you can
+ provide your input. Note that depending on how your site is
+ configured you may or may not see a "Reply" link in your current
+ object actions when viewing content.
Give you comment a short title and then type the body of your
comment in the "Reply body" field. When you're done you can
@@ -347,10 +393,9 @@
The CMF is structured around two central ideas: content and
services. Content consists of objects located in folders. You can
- perform actions on content using links in your actions box. You
- can invoke services either through action box links or site likes
- like search. In the next chapter you'll learn more about content.
-
-
+ perform actions on content using links in your current object
+ actions. You can invoke services either through site actions, or
+ actions on objects. In the next chapter you'll learn more about
+ content.
XXX how many screen shots should there be in this chapter?