CompleteDocumentation

Categorization and folksomony application

This is a TopicType for categorization only.

See also: ClassifiedTopic, TaggedTopic

… read more

Categories are a kind of predefined "backgone" to organized content and facilitate navigation. Categories can be used for very different purposes. To effectively use categories you have to understand the difference to tags as they are available for TaggedTopics. So while tags are a kind of "keywords" that connect content in a per-to-per fashion, categories are a predefined hierarchy where content is situated in separate compartments.

Categories themselves are CategorizedTopics thus implementing a hierarchy.

See also: See CategorizedTopic, ClassifiedTopic, TaggedTopic, CategoryTemplate, CategoryViewTemplate, CategoryEditTemplate, RenderCategoryBrowser

… read more

See also:

• ControlledTopic
• ClassifiedTopic
• ClassifiedControlledTopicViewTemplate
• ClassifiedControlledTopicEditTemplate

… read more

This TopicType inherits the properties of CategorizedTopic and TaggedTopic. Take those types if you want to categorize or tag content solely.

See also:

• ClassifiedTopicViewTemplate
• ClassifiedTopicEditTemplate

… read more

see also:

• ControlledTopicViewTemplate
• ControlledTopicEditTemplate

… read more

See also SeoTopicEditTemplate, SeoTopicViewTemplate

… read more

This is a TopicType for topics that you want to tag. If you want to categorize them also use the ClassifiedTopic type.

See also: ClassifiedTopic, CategorizedTopic, TaggedTopicViewTemplate, TaggedTopicEditTemplate

… read more

This TopicType requires WorkflowPlugin

see also:

• WorkflowDefinitionTemplate
• WorkflowDefinitionViewTemplate

… read more

See also:

• WorkflowEmailTemplateViewTemplate
• WorkflowEmailTemplateEditTemplate
• WorkflowEmailTemplateTemplate

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

… read more

This method is called by RenderCategory to display a summary for an object listed within the Category topic.

Parameters

• OBJECT
• THEICON

… read more

This method is called by RenderCategory to display a summary for an object of type ClassifiedTopic.

Parameters

• OBJECT
• TITLE
• THEWEB
• SHOWSUBCATS: switch on/off direct subcategoriesm, defaults to on

… read more

This method is called by RenderCategory to display a summary for an object listed within the Category topic.

Parameters

• OBJECT

… read more

This method is called by RenderCategory to display a summary for an object of type ClassifiedTopic.

Parameters

• OBJECT
• THEICON

… read more

Renders an index of all known categories, top categories first.

Parameters

• NONE

… read more

This function is called in Category topics.

See the also

• CategoryTemplate
• CategoryRenderCategoryItem
• RenderIndexItem
• ClassifiedTopicRenderIndexItem
• RenderCategoryTiles

Parameters

• CAT: category to be rendered, defaults to URLPARM{"catname" default="BASETOPIC"}
• KEYWORDS: keywords to filter for
• TAG: tags to be searching for in this category
• EXCLUDE: categories to be excluded from the list
• SHOWHEADER: switch on/off display anchors, defaults to off
• SHOWTOPICS: switch on/off display of topics in this category; defaults to on
• SHOWGROUPS: switch on/off alphabetic headers; defaults to off
• SHOWFILTER: switch on/off the input field to filter the list items, defaults to off
• SHOWSUBCATS: switch on/off display of subcategories, defaults to on
• COLS: number of columns, defaults to CLASSIFICATIONPLUGIN_NRCOLS which itself defaults to 3

… read more

If no category breadcrumbs are available, standard ones are created based on BASETOPIC. All information is extracted from BASEWEB.

Parameters

• CAT: name of category to render the breadcrumbs for, defaults to BASETOPIC
• SEP: string used as a separator in the breadcrumbs

… read more

Parameters

• THEWEB: where to search for categories, defaults to %BASEWEB%
• NAME: name of the formfield to store the selection (only used when MODE is set to select); defaults to Category
• VALUE: list of pre-selected categories
• TOP: node from where to start the category, defaults to TopCategory
• MODE: could be edit, select or browse, defaults to browse
  • edit: allows to modify the hierarchy
  • select: select one or more categories; specify the name of the formfield to be used in the NAME parameter
  • browse: navigate among categories
• BUTTONS: on, off - toggle the display of the buttons, defaults to on; you may also switch on individual buttons using a comma separated lists of ids filter, refresh, undo and/or clear
• CLASSES: css classes to be applied to the input element

… read more

This function is deprecated. Please use RenderCategoryBrowser

Parameters

• THEWEB: the web where to look for classes, defaults to BASEWEB
• NAME: name of the formfield to render the browser for
• VALUE: list of pre-selected categories
• TOP: node from where to start the category
• EXCLUDE: pattern of categories to be excluded from the tree
• BUTTONS: "on", "off", "top", "bottom": defines where to display the buttons, defaults to on (same as top)
• FILTER: optional default text for the search box
• ONCLICK: javascript handler to be called when a category is clicked, defaults to selecting the category
• HIDENULL: "on" or "off", hide empty categories, defaults to off
• NRLEAFS: list of cat:count values that specify the number of leaf nodes per category
• NRTOPICS: list of cat:count values that specify the number of topics nodes per category
• THEFORMAT: format of the link text; this is a named section as defined in RenderHierarchyAsJSON, defaults to editor
• DEPTH: number of levels to extract, defaults to infinite depth
• CLASSES: css classes for the input element

… read more

This function is used by the rest handler to render the settings tab in the category editor

Parameters

• BASETOPIC
• TOPICPARENT

… read more

This function renders a view for a classified topic, showing its category and tagging info in the top.

Parameters

• OBJECT: the topic to render the view for, defaults to %BASEWEB%.%BASETOPIC%
• TITLE_EXTRA: optional addition to the topic title. see RenderWikiTopicView
• DISPLAYREVISIONINFO: boolean flag to switch on/off revinfo

… read more

This function is called by the RenderPlugin to implement the REST handler for the hierarchy browsers.

Parameters

• web: name of the web where to extract the hierarchy from, defaults to BASEWEB
• root: top category inside the hierarchy to start extracting information from, defaults to TopCategory
• exclude: pattern of categories to be excluded from the tree
• depth: number of levels to extract, defaults to 2
• format: one of "browser", "sidebar", or "editor", defaults to "browser"
• open: categories to be expanded
• hidenull: hides empty categories
• nrleafs: list of cat:count items that specify the number of leafs per category; these values are used instead of computing them by HIERARCHY itself
• nrtopics: list of cat:count items that specify the number of topics per category; these values are used instead of computing them by HIERARCHY itself

… read more

This function is used in the category selector's autocompletion textboxlist to return a set of matching categories given the prefix in the url param q. See the classificationplugin.tmpl template file.

Parameters

• CAT: pattern of categories to include, defaults to neutral filter; this pattern is to match the prefix of the category name
• LIMIT: maximum number of categories to return, defaults to 10
• THEWEB: web from which to extract category information, defaults to BASEWEB

… read more

This function is used in the tag editor's autocompletion textboxlist to return a set of matching tags given the prefix in the url param q. See the classificationplugin.tmpl template file.

Parameters

• TAG: pattern of tags to include, defaults to a neutral filter; this pattern is to match the prefix of the tag name
• LIMIT: maximum number of categories to return, defaults to 10
• THEWEB: web from which to extract category information, defaults to BASEWEB

… read more

This function is used in the tag editor's autocompletion textboxlist to return a set of matching tags given the prefix in the url param q. See the classificationplugin.tmpl template file. This in essence is functionally equivalent to RenderKnownTags however is using SolrPlugin if installed for better performance.

Parameters

• TAG: pattern of tags to include, defaults to a neutral filter; this pattern is to match the prefix of the tag name
• LIMIT: maximum number of categories to return, defaults to 10
• THEWEB: web from which to extract category information, defaults to BASEWEB

… read more

This function displays part of the hierarchy a topic is situated in. It tries to provide a sense of "location" for the topic based on the way it is classified.

TODO: what do we display for topics that are not categorized?

… read more

This renders a tag cloud getting tags from a solr search on recently changed data.

Parameters

• DAYS: number of recent days of changes to take under consideration, defaults to unlimited
• RECENCY: maximum number of topics to harvest tags from, defaults to 100; a value of "all" will render a tag cloud considering all matching documents
• LIMIT: maximum number of tags in the could, defaults to 100
• MIN: minimum frequency of a tags to be shown
• TAG: comma separated list of tags to be searched for in the archive; tags may be preceded with a dash (-) to exclude results containing this tag
• CAT: comma separated list of categories to search for; categories may be preceded with a dash (-) to exclude results containing this tag
• KEYWORDS: keywords to filter for
• THEWEB: web to restrict search to, defaults to all
• TYPE: content type to restrict results to, e.g. "topic" (default), "image", "video", "pdf", "zip", …, defaults to "topic"

… read more

List all topics that are not filed into any category. Technically they are direct decendance of the TopCategory. See also RenderUntaggedTopics.

Parameters

• THEWEB: the web to search for, defaults to %BASEWEB%
• EXCLUDE: regular expression of topics to be excluded, defaults to WebTopicEditTemplate

… read more

List all topics that are not tagged. See also RenderUncategorizedTopics.

Parameters

• THEWEB: the web to search for, defaults to %BASEWEB%
• EXCLUDE: regular expression of topics to be excluded, defaults to UncategorizedTopics|UntaggedTopics|WebTopicEditTemplate

… read more

Parameters

• TAG: comma separated list of tags to be searched for in the archive
• CAT: restrict tag cloud to this category; displays all tags of all categories if unspecified
• MIN: minimum frequency of a tags to be shown
• LIMIT: maximum number of tags in the could, defaults to 100
• TOPICTYPE: limit search for tags of topics of the given type, defaults to TaggedTopic|ClassifiedTopic
• THEWEB: web to restrict search to, defaults to current

… read more

uses sections plain_text and html_text from calling topic

Parameters

• TEMPLATE

… read more

This TopicFunction renders the header of a ControlledTopic.

Parameters

• OBJECT the topic to render the info block for
• APPROVED_STATE, the state where the controlled topic is approved/live/ready to be used, defaults to approved

… read more

This method is called by RenderCategory to display a summary for an object listed within the TaggedTopic.

Parameters

• OBJECT

… read more