[Checkins] SVN: Products.CMFTopic/trunk/ STX help moved to `docs` folder.
Charlie Clark
cvs-admin at zope.org
Wed Apr 4 18:31:18 UTC 2012
Log message for revision 124947:
STX help moved to `docs` folder.
Changed:
D Products.CMFTopic/trunk/Products/CMFTopic/help/
A Products.CMFTopic/trunk/docs/
A Products.CMFTopic/trunk/docs/Overview.rst
D Products.CMFTopic/trunk/docs/Overview.stx
A Products.CMFTopic/trunk/docs/Topics.rst
D Products.CMFTopic/trunk/docs/Topics.stx
-=-
Copied: Products.CMFTopic/trunk/docs/Overview.rst (from rev 124945, Products.CMFTopic/trunk/Products/CMFTopic/help/Overview.stx)
===================================================================
--- Products.CMFTopic/trunk/docs/Overview.rst (rev 0)
+++ Products.CMFTopic/trunk/docs/Overview.rst 2012-04-04 18:31:15 UTC (rev 124947)
@@ -0,0 +1,92 @@
+PortalTopic Overview
+
+ *Note: this help file is old and being updated (ney, replaced) as
+ :doc:`Topics`
+
+ PortalTopics present collections of portal items according to catalog
+ searches formulated by the PortalTopic creator/configurer.
+
+ Visitors to a portal topic see a brief description of the topic, its
+ criteria, available subtopics, and the batch-browsable results.
+ (Eventually the visitor will be able to sort and filter the results to
+ their liking. Initially, we will be providing rudimentary batched
+ browsing.) Visitors will also see links to subtopics which refine the
+
+ PortalTopic configurers (the creator and anyone generally enabled to
+ configure a portal topic, according to site policy) can toggle the
+ browsing view to adjust the topic query criteria, adding, deleting,
+ and modifying textual, numeric, and list criteria against the site's
+ standard content metadata fields.
+
+ PortalTopic configurers will also be able to add new topic objects to
+ the topic that will act as subtopics, with their queries refining the
+ results of the containing topic query. Subtopic nesting, and the
+ cumulative refinement, is unlimited.
+
+ Use Cases
+
+ **Topic Visitor** browses topic on PortalTopic page --
+ PortalTopics visitors see a (possibly empty) description of the
+ topic, its (possibly) empty collectino of subtopics, and
+ batch-browsable links to the topic contents.
+
+ Visitor visits topic --
+ ... sees topic description, subtopics, and first batch of topic
+ contents links.
+
+ Visitor browses topic collection --
+ The visitor can follow a result link to the target contents,
+ advance bakwards and forward in the results batch (if it's
+ more than a single screenful),
+
+ *(Not in v1.0.) Visitor twiddles filtering and sorting parameters* --
+ *to adjust their view of the results.*
+
+ Visitor navigates to subtopic --
+ ... by following subtopic link.
+
+ Visitor gets help about PortalTopics purpose and navigation --
+ ... by hitting help button. *(Just this design doc, in v1.0.)*
+
+ * (Not in v1.0.) Eventually, when returning to a topic, the
+ visitor's view resumes with batch, sort, and filter state as
+ they last left it. For now, they return to start.*
+
+ **Topic configurer** configures topic
+ Configurers can toggle the view of the topic to reveal controls
+ for adjusting the topic description, subtopics, and topic query
+ criteria.
+
+ Topic configurer adjusts topic criteria --
+ Configurer hits a button that opens the configuration form,
+ showing a view of the same topic, with:
+
+ - A text area for the filling in the topic description
+
+ - An add/delete/rename list of subtopics, for managing
+ their containment.
+
+ - A section for changing the topic criteria.
+
+ The top of the section is a table with columns for string,
+ integer, and list criteria entries. The bottom is a row of
+ buttons: "Submit Changes", "Delete Checked", and "Reset"
+
+ Table entries for already set criteria will consist of a
+ checkbox, the criterion field name, and an input box for the
+ value. The checkbox indicates entries to be deleted.
+
+ The bottom of each column will have a "blank" entry, for
+ adding a new criterion. It will be like the existing
+ entries but it will not have the checkbox, and its initial
+ value will be empty.
+
+ - *(Not in v1.0.) A control for designating whether or not to
+ apply the topic query. (The topic may only be for
+ collecting and specifying the common aspects of a query for
+ it's subtopics).*
+
+ The qeury results will display as they would for a regular visitor.
+
+ Topic configurer gets help about configuring PortalTopics --
+ ... by hitting help button. *(Just this design doc, in v1.0.)*
Deleted: Products.CMFTopic/trunk/docs/Overview.stx
===================================================================
--- Products.CMFTopic/trunk/Products/CMFTopic/help/Overview.stx 2012-04-04 18:20:29 UTC (rev 124945)
+++ Products.CMFTopic/trunk/docs/Overview.stx 2012-04-04 18:31:15 UTC (rev 124947)
@@ -1,92 +0,0 @@
-PortalTopic Overview
-
- *Note: this help file is old and being updated (ney, replaced) as
- **CMF Topic Overview**.*
-
- PortalTopics present collections of portal items according to catalog
- searches formulated by the PortalTopic creator/configurer.
-
- Visitors to a portal topic see a brief description of the topic, its
- criteria, available subtopics, and the batch-browsable results.
- (Eventually the visitor will be able to sort and filter the results to
- their liking. Initially, we will be providing rudimentary batched
- browsing.) Visitors will also see links to subtopics which refine the
-
- PortalTopic configurers (the creator and anyone generally enabled to
- configure a portal topic, according to site policy) can toggle the
- browsing view to adjust the topic query criteria, adding, deleting,
- and modifying textual, numeric, and list criteria against the site's
- standard content metadata fields.
-
- PortalTopic configurers will also be able to add new topic objects to
- the topic that will act as subtopics, with their queries refining the
- results of the containing topic query. Subtopic nesting, and the
- cumulative refinement, is unlimited.
-
- Use Cases
-
- **Topic Visitor** browses topic on PortalTopic page --
- PortalTopics visitors see a (possibly empty) description of the
- topic, its (possibly) empty collectino of subtopics, and
- batch-browsable links to the topic contents.
-
- Visitor visits topic --
- ... sees topic description, subtopics, and first batch of topic
- contents links.
-
- Visitor browses topic collection --
- The visitor can follow a result link to the target contents,
- advance bakwards and forward in the results batch (if it's
- more than a single screenful),
-
- *(Not in v1.0.) Visitor twiddles filtering and sorting parameters* --
- *to adjust their view of the results.*
-
- Visitor navigates to subtopic --
- ... by following subtopic link.
-
- Visitor gets help about PortalTopics purpose and navigation --
- ... by hitting help button. *(Just this design doc, in v1.0.)*
-
- * (Not in v1.0.) Eventually, when returning to a topic, the
- visitor's view resumes with batch, sort, and filter state as
- they last left it. For now, they return to start.*
-
- **Topic configurer** configures topic
- Configurers can toggle the view of the topic to reveal controls
- for adjusting the topic description, subtopics, and topic query
- criteria.
-
- Topic configurer adjusts topic criteria --
- Configurer hits a button that opens the configuration form,
- showing a view of the same topic, with:
-
- - A text area for the filling in the topic description
-
- - An add/delete/rename list of subtopics, for managing
- their containment.
-
- - A section for changing the topic criteria.
-
- The top of the section is a table with columns for string,
- integer, and list criteria entries. The bottom is a row of
- buttons: "Submit Changes", "Delete Checked", and "Reset"
-
- Table entries for already set criteria will consist of a
- checkbox, the criterion field name, and an input box for the
- value. The checkbox indicates entries to be deleted.
-
- The bottom of each column will have a "blank" entry, for
- adding a new criterion. It will be like the existing
- entries but it will not have the checkbox, and its initial
- value will be empty.
-
- - *(Not in v1.0.) A control for designating whether or not to
- apply the topic query. (The topic may only be for
- collecting and specifying the common aspects of a query for
- it's subtopics).*
-
- The qeury results will display as they would for a regular visitor.
-
- Topic configurer gets help about configuring PortalTopics --
- ... by hitting help button. *(Just this design doc, in v1.0.)*
Copied: Products.CMFTopic/trunk/docs/Topics.rst (from rev 124945, Products.CMFTopic/trunk/Products/CMFTopic/help/Topics.stx)
===================================================================
--- Products.CMFTopic/trunk/docs/Topics.rst (rev 0)
+++ Products.CMFTopic/trunk/docs/Topics.rst 2012-04-04 18:31:15 UTC (rev 124947)
@@ -0,0 +1,19 @@
+CMF Topic Overview
+==================
+
+CMF Topics present a way of defining a *canned catalog query*. They
+help organize a site into dynamically executed searches according to
+a set of static criteria defined by the person who created or
+configured the Topic.
+
+Visitors to a particular Topic will see its results, and also links
+to any subtopics, which may use their parent topics criteria to
+further refine a search. Clicking on any particular result will lead
+to the item. Of course, being skinnable, this behavior may be
+altered by the site designer as needed.
+
+The configurer (the creator and anyone generally enabled to configure
+CMF Topics according to site policy) configures the Topic by adding
+criterion and setting the values. The current set of criteria
+include simple String, Integer, and List, as well as some Date
+criterion. Subtopics may be nested for cumulative refinement.
\ No newline at end of file
Deleted: Products.CMFTopic/trunk/docs/Topics.stx
===================================================================
--- Products.CMFTopic/trunk/Products/CMFTopic/help/Topics.stx 2012-04-04 18:20:29 UTC (rev 124945)
+++ Products.CMFTopic/trunk/docs/Topics.stx 2012-04-04 18:31:15 UTC (rev 124947)
@@ -1,18 +0,0 @@
-CMF Topic Overview
-
- CMF Topics present a way of defining a *canned catalog query*. They
- help organize a site into dynamically executed searches according to
- a set of static criteria defined by the person who created or
- configured the Topic.
-
- Visitors to a particular Topic will see its results, and also links
- to any subtopics, which may use their parent topics criteria to
- further refine a search. Clicking on any particular result will lead
- to the item. Of course, being skinnable, this behavior may be
- altered by the site designer as needed.
-
- The configurer (the creator and anyone generally enabled to configure
- CMF Topics according to site policy) configures the Topic by adding
- criterion and setting the values. The current set of criteria
- include simple String, Integer, and List, as well as some Date
- criterion. Subtopics may be nested for cumulative refinement.
\ No newline at end of file
More information about the checkins
mailing list