-
Notifications
You must be signed in to change notification settings - Fork 0
/
TagsPlugin.txt
101 lines (76 loc) · 4.57 KB
/
TagsPlugin.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
%META:TOPICINFO{author="BaseUserMapping_333" date="1252888172" format="1.1" reprev="1.3" version="1.3"}%
---+!! !TagsPlugin
<!--
One line description, required for extensions repository catalog.
* Set SHORTDESCRIPTION = Full strength Tagging system
-->
%SHORTDESCRIPTION%
%TOC%
---++ For Administrators
---+++ Installation Instructions
1 configure various TagsPlugin toggles in [[%SCRIPTURL{configure}%][configure]] (section Extensions, TagsPlugin)
1 setup your database (currently only tested using !MySQL)
1 create the database in !MySQL server and add the user with permission to create tables
1 set ={DbiContrib}{DBI_dsn}=, ={DbiContrib}{DBI_username}= and ={DbiContrib}{DBI_password}=
1 *initialise the tag database*
* %SCRIPTURL{rest}%/TagsPlugin/initialiseDatabase to automatically create the database tables and to add initial values
1 choose between the two flavors of the TagsPlugin and alter your SKIN variable
* %GRAY%classic flavor:%ENDCOLOR% Set SKIN = tagsplugin, pattern
* %GRAY%jquery flavor:%ENDCOLOR% Set SKIN = tagspluginjquery, pattern
%GRAY%Optional:%ENDCOLOR%%BR%
If you want to preload the tags database with Country Names, you need to install CPAN:Geo::GeoNames
and click [[%SCRIPTURL{rest}%/TagsPlugin/updateGeoTags][updateGeoTags]] (uses the CC licenced
http://www.geonames.org ([[http://download.geonames.org/export/dump/allCountries.zip][allCountries.zip]]).
%$INSTALL_INSTRUCTIONS%
---++ For Users
This plugin primarily manages triples: a tag basically has three dimensions:
* the tagname itself (called tag)
* the topic, it is attached to (called topic or item)
* the username, who the tag belongs to (called user or owner)
You can use the following macros to display or alter tags:
---+++ =TAGLIST=
Lists the tags for the requested resource
---+++ =TAGENTRY=
allows users to add, remove and manipulate tags for a resource
---+++ =TAGCLOUD=
You can disable the <nop>TagsPlugin =TAGCLOUD= macro in =configure=, if you want to
use the =TAGCLOUD= macro from the Foswiki:Extensions.TagCloudPlugin instead. See {TagsPlugin}{EnableTagCloud}.
%INCLUDE{%SYSTEMWEB%.VarTAGSEARCH}%
---+++ SEARCHing
To search for topics that are tagged with (or not tagged with), use a %SYSTEMWEB%.QuerySearch
with the =taggedwith(tagname)= operator.
TagsPluginViews defines the common Tag widgets that can be re-used via Sectional includes.
---+++ Preferences (used by the jquery flavor)
Available variables which can be used to change the (default) behaviour of the jquery skin:
| *preference name* | *description* |
| TAGSPLUGIN_WEBSELECTOR_DEFAULT | The default value for the <nop>TagCloud view: Default: the current web. |
| TAGSPLUGIN_USERSELECTOR_DEFAULT | The default value for the <nop>TagCloud view. Default: =all= |
| TAGSPLUGIN_TAGUSER | New tags are created with this user. Default: the current user. |
---+++ Tag Filters (classic flavor only)
(This section needs to be rewritten.)
---+++ Examples
---++++ list of all user's tags on the current topic
%TAGLIST{show="user"}%
---++++ edit (the current user's) the tags on the current topic
%TAGENTRY%
---++++ tag cloud of all user's tags on the current topic
%TAGCLOUD%
---++ For Developers
You can access all functions of this plugin via rest handlers. Please consult the inline
documentation of TagsPlugin.pm for HTTP status codes, available handlers and URL
parameters.
---++ Plugin Info
This Plugin uses DbiContrib to store the tagmap in a database for fast querying.
Schema & design inspired from [[http://forge.mysql.com/wiki/TagSchema][MySQL Forge]],
but treating Tags as Items, so that you can tag a tag (creating a hierarchy of tags)
| Plugin Author(s): | Foswiki:Main.SvenDowideit %BR% Foswiki:Main.OliverKrueger |
| Copyright: | © 2008-2009 SvenDowideit@fosiki.com %BR% © 2009 [[mailto:oliver@wiki-one.net][Oliver Krüger]], [[http://wiki-one.net][(wiki-one.net)]] |
| License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License 3)]] |
| Plugin Version: | %$VERSION% |
| Change History: | <!-- versions below in reverse order --> |
| Dependencies: | %$DEPENDENCIES% |
| Plugin Home: | http://foswiki.org/Extensions/TagsPlugin |
__Related Topics:__ %SYSTEMWEB%.InstalledPlugins, %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory,
%MAINWEB%.SitePreferences, [[http://faculty.philau.edu/kayk/kkay/articles/Tagging_folksonomy.pdf][Intranet Applications for Tagging and Folksonomies]]
<!-- Do _not_ attempt to edit this topic; it is auto-generated. Please add comments/questions/remarks to the feedback topic on
foswiki.org instead. -->