aw schriftzug.png aw logo 60x60.png

CompleteDocumentation
Categorization and folksomony application

2019-05-02 - 10:19 | Version 3 |

Description

Documentation

Type Hierarchy

G CategorizedTopic CategorizedTopic Category Category CategorizedTopic->Category ClassifiedTopic ClassifiedTopic CategorizedTopic->ClassifiedTopic WikiTopic WikiTopic WikiTopic->CategorizedTopic ControlledTopic ControlledTopic WikiTopic->ControlledTopic ClassifiedControlledTopic ClassifiedControlledTopic ClassifiedTopic->ClassifiedControlledTopic SeoTopic SeoTopic ClassifiedTopic->SeoTopic WorkflowDefinition Workflow Definition ClassifiedTopic->WorkflowDefinition ControlledTopic->ClassifiedControlledTopic TaggedTopic TaggedTopic TaggedTopic->ClassifiedTopic

TopicType

CategorizedTopic

wiki topic that can be filed to a category
This is a TopicType for categorization only.

See also: ClassifiedTopic, TaggedTopicread more

Category

create a hierarchy to organize your topics
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, CategoryEditTemplateread more

ClassifiedTopic

create a topic classified with tag and category information
This TopicType inherits the properties of CategorizedTopic and TaggedTopic. Take those types if you want to categorize or tag content solely.

See also:

read more

ControlledTopic

Topics that are controlled by a workflow

SeoTopic

a topic carrying search engine enhanced metadata

TaggedTopic

Content classification using folksonomy
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, TaggedTopicViewTemplateread more

TopicTemplate

CategoryTemplate

Template for categories and sub-categories

TopicFunction

CategorizedTopicRenderIndexItem

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

Parameters
  • OBJECT

read more

CategoryRenderIndexItem

Render a summary for a Category in a category index
This method is called by RenderCategory to display a summary for an object of type ClassifiedTopic.

Parameters
  • OBJECT
  • TITLE
  • THEWEB

read more

ClassifiedTopicRenderIndexItem

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

Parameters
  • OBJECT
  • THEICON

read more

RenderAllCategories

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

Parameters
  • NONE

read more

RenderCategory

Render tools to handle categories
This function is called in Category topics.

See the CategoryTemplate.
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

read more

RenderCategoryBreadcrumbs

Renders a list of parent categories for breadcrumbs navigation
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

RenderCategoryBrowser

Renders a hierarchical browser for categories

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

read more

RenderCategoryEditor

Renders an edit widget for a category formfield
Note, this function is deprecated. Use RenderCategoryBrowser instead.

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

read more

RenderCategoryFactory

Renders a factory for Categories
This function renders an input form to create a new category.

read more

RenderCategorySettings

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

Parameters
  • BASETOPIC
  • TOPICPARENT

read more

RenderClassifiedTopicView

Renders the TopicView of a ClassifiedTopic

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

Parameters
  • TITLE_EXTRA: optional addition to the topic title. see RenderWikiTopicView
  • DISPLAYREVISIONINFO: boolean flag to switch on/off revinfo

read more

RenderHierarchyAsJSON

Renders a hierarchy as a JSON object
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

RenderIconSelector

Renders a widget to select a photo
This function renders a selection widget to chose an icon

Parameters
  • VALUE: which icon is preselected
  • SOURCE: topic that has got a set of icons attached to it, defaults to IconSet

read more

RenderKnownCats

Returns a list of categories
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

RenderKnownTags

Returns a list of tags
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

RenderKnownTagsSolr

returns a list of known tags using SolrPlugin
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

RenderSideBar

Render tools to handle categories
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

RenderSolrTagCloud

Renders a tag cloud using Solr
TODO

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
  • CAT: restrict tag cloud to this category; displays all tags of all categories if unspecified
  • 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", … … read more

RenderTagEditor

Render an editor for tags

Parameters
  • NAME: name of the formfield to render the editor for
  • VALUE: list of pre-selected tags
  • THEWEB: current web
  • THETOPIC: current topic
  • SIZE: the size of the input field … read more

RenderUncategorizedTopics

list all topics not categorized yet
TODO

Parameters
  • EXCLUDE: regular expression of topics to be excluded, defaults to UncategorizedTopics|WebTopicEditTemplate

read more

RenderWebTagCloud

Render a tool to list all classified topics in this web

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
  • KEYWORDS: keywords to filter for
  • 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
  • THEWEB: web to restrict search to, defaults to current

read more

RenderWorkflowInfo

renders an info block at the top of a ControlledTopic
TODO

Parameters
  • OBJECT the topic to render the info block for

read more

TaggedTopicRenderIndexItem

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

Parameters
  • OBJECT

read more

Installation

Manifest

# Name Type
1 CategorizedTopic TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
  wiki topic that can be filed to a category
2 CategorizedTopicEditTemplate TopicView, ApplicationTopic, WikiTopic
  Editor for CategorizedTopics
3 CategorizedTopicRenderIndexItem TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
  Render a summary for ClassifiedTopics
4 CategorizedTopicViewTemplate TopicView, ApplicationTopic, WikiTopic
  Display a categorized topic
5 Category TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
  create a hierarchy to organize your topics
6 CategoryBrowser WebTool, ApplicationTopic, WikiTopic
  Explore the categories in the current web
7 CategoryEditTemplate TopicView, ApplicationTopic, WikiTopic
  Editor for category topics
8 CategoryRenderIndexItem TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
  Render a summary for a Category in a category index
9 CategoryTemplate TopicTemplate, ApplicationTopic, WikiTopic
  Template for categories and sub-categories
10 CategoryViewTemplate TopicView, ApplicationTopic, WikiTopic
  View for Categories
11 ClassifiedControlledTopic TopicType, DataForm, DocuTopic, ApplicationTopic
  create a classified topic with workflow controll
12 ClassifiedControlledTopicEditTemplate TopicView, ApplicationTopic, WikiTopic
  an editor for ClassifiedControlledTopics
13 ClassifiedControlledTopicViewTemplate TopicView, ApplicationTopic, WikiTopic
  TopicView for ClassifiedControlldeTopics
14 ClassifiedTopic TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
  create a topic classified with tag and category information
15 ClassifiedTopicEditTemplate TopicView, ApplicationTopic, WikiTopic
  Editor for ClassifiedTopics, NatSkin version
16 ClassifiedTopicRenderIndexItem DocuTopic, TopicFunction
  Render a summary for a ClassifiedTopic in a category index
17 ClassifiedTopicViewTemplate TopicView, ApplicationTopic, WikiTopic
  Display a classified topic
18 ControlledTopic TopicType, DataForm, DocuTopic, ApplicationTopic
  Topics that are controlled by a workflow
19 ControlledTopicEditTemplate TopicView, WikiTopic
  Editor for ControlledTopics
20 ControlledTopicViewTemplate TopicView, ApplicationTopic, WikiTopic
  TopicView for ControlledTopics
21 IconSet ApplicationTopic
   
22 PatternSkinCategoryViewTemplate TopicView
  View for categories (PatternSkin variation)
23 RenderAllCategories DocuTopic, TopicFunction, WikiTopic
  Renders an overview of all known categories
24 RenderCategory DocuTopic, TopicFunction, WikiTopic
  Render tools to handle categories
25 RenderCategoryBreadcrumbs DocuTopic, TopicFunction, WikiTopic
  Renders a list of parent categories for breadcrumbs navigation
26 RenderCategoryBrowser DocuTopic, TopicFunction
  Renders a hierarchical browser for categories
27 RenderCategoryEditor DocuTopic, TopicFunction
  Renders an edit widget for a category formfield
28 RenderCategoryFactory DocuTopic, TopicFunction
  Renders a factory for Categories
29 RenderCategorySettings DocuTopic, TopicFunction
  Renders the content of the settings tab in the category editor
30 RenderClassifiedTopicView DocuTopic, TopicFunction
  Renders the TopicView of a ClassifiedTopic
31 RenderHierarchyAsJSON DocuTopic, TopicFunction
  Renders a hierarchy as a JSON object
32 RenderIconSelector DocuTopic, TopicFunction
  Renders a widget to select a photo
33 RenderKnownCats DocuTopic, TopicFunction
  Returns a list of categories
34 RenderKnownTags DocuTopic, TopicFunction
  Returns a list of tags
35 RenderKnownTagsSolr DocuTopic, TopicFunction
  returns a list of known tags using SolrPlugin
36 RenderSideBar DocuTopic, TopicFunction
  Render tools to handle categories
37 RenderSolrTagCloud DocuTopic, TopicFunction, WikiTopic
  Renders a tag cloud using Solr
38 RenderTagEditor DocuTopic, TopicFunction
  Render an editor for tags
39 RenderUncategorizedTopics DocuTopic, TopicFunction
  list all topics not categorized yet
40 RenderWebTagCloud DocuTopic, TopicFunction
  Render a tool to list all classified topics in this web
41 RenderWorkflowInfo DocuTopic, TopicFunction, WikiTopic
  renders an info block at the top of a ControlledTopic
42 SeoTopic TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
  a topic carrying search engine enhanced metadata
43 SeoTopicEditTemplate TopicView, ApplicationTopic, WikiTopic
  Editor for SeoTopics
44 SeoTopicViewTemplate TopicView, ApplicationTopic, WikiTopic
  View for SeoTopics
45 TaggedTopic TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
  Content classification using folksonomy
46 TaggedTopicEditTemplate TopicView
  Editor for TaggedTopics
47 TaggedTopicRenderIndexItem DocuTopic, TopicFunction
  Renders an index item for TaggedTopics
48 TaggedTopicViewTemplate TopicView
  Display a tagged topic
49 WebChanges WebTool, ApplicationTopic, WikiTopic
  Most recent changes in this web
50 WebPreferences WebTool, ApplicationTopic, WikiTopic
   
51 WelcomeMessage ApplicationTopic, WikiTopic
  used on the frontpage of newly created webs
52 WorkflowDefinition TopicType, DataForm, DocuTopic, ApplicationTopic
  define a workflow for controlled topics
53 WorkflowDefinitionEditTemplate TopicView, ApplicationTopic, WikiTopic
  Editor for WorkflowDefinition topics
54 WorkflowDefinitionTemplate TopicTemplate, WikiTopic
  a template for WorkflowDefinitions
55 WorkflowDefinitionViewTemplate TopicView, WikiTopic
  TopicView for WorkflowDefinitions

WikiApplication edit

TopicType WikiApplication, ApplicationTopic, WikiTopic
TopicTitle
Summary Categorization and folksomony application
Version 7.00
Author Michael Daum
Copyright © 2006-2019 Michael Daum http://michaeldaumconsulting.com
License GNU General Public License, version 2
Dependencies
Warning: Can't find topic Applications/ClassificationApp.WebLeftBarExample

Impressum © Alexander Weimer GmbH