Skip to content. | Skip to navigation

Personal tools
Sections
You are here: Home wiki UsingTopics

UsingTopics

Making and Using Topics properly.

Not everything in Plone comes with detailed examples and description, Plone Topics appears to be one of these things so here are some examples of how to use them. Think of a Topic as a filter for your Plone site. A Topic is a quick way of drawing a page of results created by filtering your entire site. The results of a Topic are nicely sorted by Title in either ascending or descending order. By default only site managers have permission to create topics. CMFTopics infrastructure can be tweaked in plone via the ZMI at /plone_catalog indexes and metadata, & via /portal_skins/plone_3rd Party/CMF Topic

I will add useful updates gathered here to plone.org

EXAMPLES

  1. Create a new topic to list all objects of a certain type (e.g. news items, or events)
    • From your own folder select add new item > topic. Give it a short name, title and description
    • From the criteria tab choose Type as the field name and String Criterion as the criteria type. Click Add.

    (notice that the available fields list no longer includes Type)

    Your new topic now redraws its criteria tab listing the criteria details.

    • Enter News Item in the edit box, click Save and select the view tab to see the results of the topic search.

    n.b. for Type criteria the filter (topic) matches against the available Content Types in your Plone portal, have a look via the ZMI at /portal_types for a listing of valid Types in your portal.

  2. Topics can have subtopics attached to them allowing you to chain successive criteria as filters on the content of your site. This allows for the results of a topic to be refined. This is like an and for a boolean search
    • Select the subtopics tab of your active topic and provide an ID or short name for this new topic (the subtopic).
    • The new topic form is displayed, provide the information required (note that you'll need ensure this topic has the Inherit Criteria option selected if you want the results of the supertopic to be further refined by the criteria of this new subtopic.
    • Select the view tab of the subtopic to see the results of the topics.

    n.b. the subtopics only exist in the namespace of the original topic, you won't see them in the folder.

  3. To use a Topic like an or for a boolean search, for example to find all events and news items (adapted from a post by Ralf Ritz)
    • From your own folder select add new item > topic. Give it a short name, title and description
    • From the criteria tab choose Type as the field name and List Criterion as the criteria type. Click Add.

    Your new topic now redraws its criteria tab listing the criteria details.

    • Enter News Item and Event on different lines in the edit box under matches one of the following, click Save and select the view tab to see the results of the topic search.
  4. This topic searches for all objects in the site which have changed over the last week (adapted from www.engineering.ucl.ac.uk)
    • From your own folder select add new item > topic. Give it a short name, title and description
    • From the criteria tab choose modified as the field name and Friendly Date Criterion as the criteria type. Click Add.

    (notice that the available fields list no longer includes modified)

    Your new topic now redraws its criteria tab listing the criteria details.

    • Under the Criteria Details for this topic select less than 1 week old from the configurable friendly date option. Click Save and select the view tab to see the results of the topic search.
  5. This topic lists all objects with a certain keyword selected in their metadata tab. Note, it is not obvious from Add New Topic Criteria that the field name Subject is equivalent to the keywords selected in an object's metadata, however this is the case. So if you want to make use of these keywords to group objects together via topic results then do the following.
    • From your own folder select add new item > topic. Give it a short name, title and description
    • From the criteria tab choose Subject as the field name and List Criterion or String Criterion as the criteria type. Click Add.

    Your new topic now redraws its criteria tab listing the criteria details.

    • Assuming you have previously selected a number of keywords in some selected objects metadata tab (in this case I have some documents with "BSc" and "B.Comm" as keywords) Enter BSc and B.Comm on different lines in the edit box under matches one of the following, click Save and select the view tab to see the results of the topic search.