(r1) TopicClassificationAddOn < System

You are here: Foswiki>System Web>TopicClassificationAddOn~~EditAttach~~
---+!! %TOPIC%
<!--
One line description, required for extensions repository catalog.
   * Set SHORTDESCRIPTION = Provides framework for organizing  content within a web according to different _types_ of topics (discussion, weblog, reference, etc) and hierarchical "categories". Includes sample topic types and categories. Provides basic framework to design and manage simple Foswiki Applications.
-->
%SHORTDESCRIPTION%

%TOC%

---+ Topic Classification Add-On 

<b> %TOPIC% (aka TCAO) helps you organize the content in your wiki by classifying topics according to their _function_ and/or _subject matter._ </b> It also provides a user-friendly interface for creating new topics that automatically incorporates this classification system. Together, these basic elements provide a platform that allow you to create any number of simple Foswiki Applications.

Some of the features of %TOPIC% include:
   * Simple installation mechanism to add the TCAO framework to a web and install sample classifications.
   * A "wizard" for creating new topics and apply classification scheme.
   * Display Classification trees using Foswiki:Extensions.TreePlugin.
   * Design your own  classification schemes.

---++ Add-On Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in =configure=, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.


---++ %TOPIC% Setup 
After installing this add-on, there are a few additional steps needed before it will function properly:
   * Make sure ={EnableHierarchicalWebs}= is enabled in =configure= (under "Store settings" tab). 
   * Add the following preference section to [[%USERSWEB%.SitePreferences]]:
<verbatim>
---++ %SYSTEMWEB%.TopicClassificationAddOn Preferences 
   * TCAOWEB variable for identifying which web holds %TOPIC% infrastructure.
      * Set TCAOWEB = TCAO
      * Set HELP_BACKGROUND_COLOR = #E0B9A6
</verbatim>
   * [[%SCRIPTURL{"edit"}%/%USERSWEB%/?topic=ModeratorGroup&templatetopic=GroupTemplate&topicparent=WikiGroups&onlywikiname=on&onlynewtopic=on][Go to %USERSWEB%.WikiGroups and create a new group called ==ModeratorGroup==]]. This group can add new classifications within webs where TCAO is enabled. 
   * Add the following %SYSTEMWEB%.CommentPlugin templates definitions to %SYSTEMWEB%.UserCommentsTemplate (create this topic if you have not already).
<verbatim>
%TMPL:INCLUDE{"TCAO.TCAOComments"}%
</verbatim>

---+++ Enabling %TOPIC% in a particular web

%TOPIC% is designed to organize content within individual webs.To install the TCAO framework within a web, use the form below.
%INCLUDE{"%TCAOWEB%.RenderInstallTopicClassification" warn="Only displays if prior installation steps have been completed."}%

---+++ Setting up Topic Classification within a web
Once %TOPIC% is enabled within a web, you're ready to start defining *TopicTypes* and *SubjectAreas* to be used in that web. To do this, go to those respective topics (e.g. go to !TopicType to add new !TopicTypes) and use form at bottom that is only visible to members of !ModeratorGroup (or %USERWEB%.AdminGroup, of course).

---++ Add-On Info

|  Add-on Author: | Foswiki:Main.LynnwoodBrown |
|  Add-on Version: | 10613 (2011-01-26) |
|  Copyright: | &copy; |
|  License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
|  Change&nbsp;History: | <!-- versions below in reverse order -->&nbsp; |
|  26 Jan 2011 | Foswikibug:Item10292: Accumulated fixes, Foswikibug:Item10293: Remove unnecesary files that break installer |
|  27 Feb 2010 | Foswikibug:Item1624: fix CSRF patch |
|  15 Feb 2010 | Foswikibug:Item1624: doc repairs |
|  05 Feb 2010 | Foswikibug:Item1624: update to CSRF requirements |
|  15431 | TWikibug:Item1715 - Fix !TableSearchResults |
|  15158 | TWikibug:Item1715 - Updated !Weblog and added new Task Topic Type |
|  15121 | TWikibug:Item1715 - Correcting some script names. |
|  14840 | TWikibug:Item4497 - finishing modernise references to SYSTEMWEB and USERSWEB for remaining plugins |
|  13643 | TWikibug:Item4025 - some scripts don't have their executable bit set |
|  13160 | TWikibug:Item1715 - Fixing change in name of removeSpacesAndPunctuation function, and changing form for creation new classes to table. |
|  13112 | TWikibug:Item1715 - Add new format for display of search results in table |
|  13111 | TWikibug:Item1715 - Further improvements to !TopicTypes and navigation |
|  13058 | TWikibug:Item1715 - various fixes and improvements. Changed discussion topic format. |
|  13047 | TWikibug:Item1715 - removing files not intended for distribution |
|  12981 | TWikibug:Item1715 - Minor fixes |
|  12980 | TWikibug:Item1715 - Further updates to ver 2.0 |
|  12966 | TWikibug:Item1715 - Misc fixes to MANIFEST, the plugin topic, and some TopicTypes. |
|  12965 | TWikibug:Item1715 - Clean up plugin topic. |
|  12949 | TWikibug:Item1715 - Uploading Version 2.0 of TopicClassificationAddOn |
|  Dependencies: | <table class="foswikiTable" border="1"><tr><th>Name</th><th>Version</th><th>Description</th></tr><tr><td align="left">Foswiki::Plugins</td><td align="left">&gt;=1.15</td><td align="left">Foswiki 1.0 release.</td></tr><tr><td align="left">Foswiki::Plugins::DBCachePlugin</td><td align="left">&gt;=1.51-pre1</td><td align="left">Required. Download from the Foswiki:Extensions/DBCachePlugin code library.</td></tr><tr><td align="left">Foswiki::Contrib::DBCacheContrib</td><td align="left"></td><td align="left">Required. Download from the Foswiki:Extensions/DBCacheContrib code library.</td></tr><tr><td align="left">Foswiki::Plugins::TopicCreatePlugin</td><td align="left">&gt;=1.01-pre1</td><td align="left">Required. Download from the Foswiki:Extensions/TopicCreatePlugin code library.</td></tr><tr><td align="left">Foswiki::Plugins::TreePlugin</td><td align="left">&gt;=0.6-pre1</td><td align="left">Recommended. Download from the Foswiki:Extensions/TreePlugin code library.</td></tr><tr><td align="left">Foswiki::Plugins::IfDefinedPlugin</td><td align="left">&gt;=0.96-pre1</td><td align="left">Required. Download from the Foswiki:Extensions/IfDefinedPlugin code library.</td></tr><tr><td align="left">Foswiki::Plugins::FilterPlugin</td><td align="left">&gt;=1.10-pre1</td><td align="left">Required. Download from the Foswiki:Extensions/FilterPlugin code library.</td></tr><tr><td align="left">Foswiki::Plugins::GluePlugin</td><td align="left">&gt;=1.51-pre1</td><td align="left">Required. Download from the Foswiki:Extensions/GluePlugin code library.</td></tr></table> |
|  Add-on Home: | http://foswiki.org/Extensions/%TOPIC% |
|  Support: | http://foswiki.org/Support/%TOPIC% |
|  Demo url: |  |
Topic revision: r1 - 12 Nov 2013, UnknownUser
System
Copyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback