[Checkins] SVN: Products.CMFTopic/trunk/docs/ Documentation is buildable.
Charlie Clark
cvs-admin at zope.org
Thu Apr 5 09:08:50 UTC 2012
Log message for revision 124958:
Documentation is buildable.
Changed:
A Products.CMFTopic/trunk/docs/Makefile
D Products.CMFTopic/trunk/docs/Overview.rst
D Products.CMFTopic/trunk/docs/Topics.rst
A Products.CMFTopic/trunk/docs/_static/
A Products.CMFTopic/trunk/docs/_templates/
A Products.CMFTopic/trunk/docs/api/
A Products.CMFTopic/trunk/docs/api/index.rst
A Products.CMFTopic/trunk/docs/conf.py
A Products.CMFTopic/trunk/docs/index.rst
A Products.CMFTopic/trunk/docs/narrative/
A Products.CMFTopic/trunk/docs/narrative/Overview.rst
A Products.CMFTopic/trunk/docs/narrative/Topics.rst
-=-
Added: Products.CMFTopic/trunk/docs/Makefile
===================================================================
--- Products.CMFTopic/trunk/docs/Makefile (rev 0)
+++ Products.CMFTopic/trunk/docs/Makefile 2012-04-05 09:08:46 UTC (rev 124958)
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/CMFTopic.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/CMFTopic.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/CMFTopic"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/CMFTopic"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
Deleted: Products.CMFTopic/trunk/docs/Overview.rst
===================================================================
--- Products.CMFTopic/trunk/docs/Overview.rst 2012-04-04 23:48:49 UTC (rev 124957)
+++ Products.CMFTopic/trunk/docs/Overview.rst 2012-04-05 09:08:46 UTC (rev 124958)
@@ -1,94 +0,0 @@
-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/Topics.rst
===================================================================
--- Products.CMFTopic/trunk/docs/Topics.rst 2012-04-04 23:48:49 UTC (rev 124957)
+++ Products.CMFTopic/trunk/docs/Topics.rst 2012-04-05 09:08:46 UTC (rev 124958)
@@ -1,19 +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
Added: Products.CMFTopic/trunk/docs/api/index.rst
===================================================================
--- Products.CMFTopic/trunk/docs/api/index.rst (rev 0)
+++ Products.CMFTopic/trunk/docs/api/index.rst 2012-04-05 09:08:46 UTC (rev 124958)
@@ -0,0 +1,99 @@
+CMFTopic Package
+================
+
+:mod:`CMFTopic` Package
+-----------------------
+
+.. automodule:: CMFTopic.__init__
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`AbstractCriterion` Module
+-------------------------------
+
+.. automodule:: CMFTopic.AbstractCriterion
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`DateCriteria` Module
+--------------------------
+
+.. automodule:: CMFTopic.DateCriteria
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`ListCriterion` Module
+---------------------------
+
+.. automodule:: CMFTopic.ListCriterion
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`SimpleIntCriterion` Module
+--------------------------------
+
+.. automodule:: CMFTopic.SimpleIntCriterion
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`SimpleStringCriterion` Module
+-----------------------------------
+
+.. automodule:: CMFTopic.SimpleStringCriterion
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`SortCriterion` Module
+---------------------------
+
+.. automodule:: CMFTopic.SortCriterion
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`Topic` Module
+-------------------
+
+.. automodule:: CMFTopic.Topic
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`exportimport` Module
+--------------------------
+
+.. automodule:: CMFTopic.exportimport
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`permissions` Module
+-------------------------
+
+.. automodule:: CMFTopic.permissions
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`testing` Module
+---------------------
+
+.. automodule:: CMFTopic.testing
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+ CMFTopic.interfaces
+ CMFTopic.tests
+
Added: Products.CMFTopic/trunk/docs/conf.py
===================================================================
--- Products.CMFTopic/trunk/docs/conf.py (rev 0)
+++ Products.CMFTopic/trunk/docs/conf.py 2012-04-05 09:08:46 UTC (rev 124958)
@@ -0,0 +1,233 @@
+# -*- coding: utf-8 -*-
+#
+# CMFTopic documentation build configuration file, created by
+# sphinx-quickstart on Thu Apr 5 10:43:11 2012.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import datetime
+import os
+import pkginfo
+import sys
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc',
+ 'sphinx.ext.doctest',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.todo',
+ 'repoze.sphinx.autointerface',]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+parent = os.path.dirname(os.path.dirname(__file__))
+parent_dir = os.path.abspath(parent)
+sys.path.append(parent_dir)
+pkg_info = pkginfo.Develop(parent_dir)
+year = datetime.datetime.now().year
+project = u'%s' % pkg_info.name
+copyright = u'%s, CMF Developers' % year
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = pkg_info.version.replace('dev', '')
+# The full version, including alpha/beta/rc tags.
+release = pkg_info.version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_tress = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'CMFTopicdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'CMFTopic.tex', u'CMFTopic Documentation',
+ u'Zope Foundation & Contributors', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'cmftopic', u'CMFTopic Documentation',
+ [u'Zope Foundation'], 1)
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}
Property changes on: Products.CMFTopic/trunk/docs/conf.py
___________________________________________________________________
Added: svn:eol-style
+ native
Added: Products.CMFTopic/trunk/docs/index.rst
===================================================================
--- Products.CMFTopic/trunk/docs/index.rst (rev 0)
+++ Products.CMFTopic/trunk/docs/index.rst 2012-04-05 09:08:46 UTC (rev 124958)
@@ -0,0 +1,9 @@
+Products.CMFTopic documentation
+===============================
+
+.. toctree::
+ :maxdepth: 2
+
+ narrative/Overview
+ narrative/Topics
+ api/index
Copied: Products.CMFTopic/trunk/docs/narrative/Overview.rst (from rev 124957, Products.CMFTopic/trunk/docs/Overview.rst)
===================================================================
--- Products.CMFTopic/trunk/docs/narrative/Overview.rst (rev 0)
+++ Products.CMFTopic/trunk/docs/narrative/Overview.rst 2012-04-05 09:08:46 UTC (rev 124958)
@@ -0,0 +1,94 @@
+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.)*
Copied: Products.CMFTopic/trunk/docs/narrative/Topics.rst (from rev 124957, Products.CMFTopic/trunk/docs/Topics.rst)
===================================================================
--- Products.CMFTopic/trunk/docs/narrative/Topics.rst (rev 0)
+++ Products.CMFTopic/trunk/docs/narrative/Topics.rst 2012-04-05 09:08:46 UTC (rev 124958)
@@ -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
More information about the checkins
mailing list