will expand into a "tag edit" frame that allows tag management as commonly found in blogs or tag systems like delicious, but only if tpaction is actually present. If tpaction is omitted, but the style is "blog", will show nothing. Thus a button to make the edit tags frame appear can be put as: <a href="%SCRIPTURL{viewauth}%/%SYSTEMWEB%/%TOPIC%?tpaction=show">Edit tags</a>

"twiki"

label=", "

(for style=blog) link label (text) to open the edit tags form

""

button=", "

(for style=blog) the complete button, link or html construct that will be shown when not in edit tag mode. Should open the Edit tag form when clicked by redirection to this same topic with a tpaction=show added. Overrides label.

""

header="..."

(for style=blog) Printed before the edit tags form if it is not empty, $n can be used for newlines. e.g: header="Manage your tags: <i>"

""

footer="..."

(for style=blog) Printed after the edit tags form if it is not empty, $n can be used for newlines. e.g: footer="</i>"

Limit query to a topic, or a comma-space delimited list of topics with optional asterisk wildcards

all topics

tag="..."

Name of tag

(required)

sort="web"

Sorting of tagged topics: "tagcount" by tag count (relevance), "web" by web then topic name, "topic" by topic name

"tagcount"

norelated="on"

Do not show the list of "related tags"

(show related tags)

nototal="on"

Do not show total number of topics found

(show total)

minsize="90"

Minimum size of topic $size (typically percent font size)

"90"

maxsize="180"

Maximum size of topic $size

"180"

format="..."

Format of a topic, any token of TWiki.FormattedSearch can be used, such as $web, $topic, $summary, $rev, $n. In addition, $votecount expands to the number of tag votes, $size to the suggested font size, and $taglist to the tag list of the topic.

(nice formatting)

separator=", "

Separator between tags, $n or $n() can be used for newlines

"$n"

limit=""

limit number of results if sort="web"

header=""

if sort="web", add this header once per web with results (only $web is interpreted)

---+++ $web

footer=""

if sort="web", add this footer once per web with results (only $web and $count and $showmore are interpreted)

showing $limit out of $count results $showmore

refine

Normally related tags are shown that when clicked on will search for the related tag. If refine is set to 1, then the link instead will add the clicked tag to the set of tags being searched for, allowing you to incrementally refine search results. If not set the value of ALWAYS_REFINE is used.

The list of skins can be appended, for instance: tagme,corporate,pattern.

For the "blog" style, use for a simple "Tags: list-of-tags (edit)" at the top
of the page:

* Set SKIN = tagme_styleblog,pattern

And for an alternate style, with no tags line shown if no tags exists, and
the button to open the tag edit frame placed at the right of the Edit and
Attach ones, in the same style, on the upper right:

* Set SKIN = tagme_styleblogbutton,pattern

For TWiki 4.1, use:

* Set SKIN = tagme04x01,pattern

Customizing the appearance

If you customize your site you probably want to change overall appearance. You can find instructions how to do that - at least for default pattern skin - in TWiki.PatternSkinCssCookbook.
The short summary is:

Plugin Settings

NOTE: Do not change the settings here, overload them in the Main.TWikiPreferences. Prefix a setting with TAGMEPLUGIN_, e.g. to overload NORMALIZE_TAG_INPUT define a TAGMEPLUGIN_NORMALIZE_TAG_INPUT setting in the Main.TWikiPreferences.

Optionally normalize tag names. Set to 1 to translate international characters to their latin match (ü to ue, å to aa, etcetera), and to convert spaces to underscores. Set to 0 to allow any user input, except for the reserved characters ,#'"|*. Setting to 0 also sorts tags case insensitive: 'U' comes after 't'.

Set NORMALIZE_TAG_INPUT = 0

If 1, then the refine parameter is always added to TAGME queries.

Set ALWAYS_REFINE = 1

List of users and groups that are allowed to change (rename and delete) tags (names separated by commas). Users that are not allowed to change post their change requests to TagMeChangeRequests. If not set anyone can change tags.

Bundles are groups of tags that are presented as menus for convenience. It is a list of space-separated (or comma-separated if your tags may contain spaces) prefixed by bundle labels terminated by colon (":"). e.g:

Set BUNDLES =

#Set BUNDLES = Rating: * * * Todo: to_blog to_read

#Set BUNDLES = Rating:, , *, **, Todo:, to_blog, to_read

Debug plugin: (See output in data/debug.txt)

Set DEBUG = 0

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

Note: If you have upgraded TagMePlugin to TWiki 4.2 or later and appear to have lost all your old tags: Copy all your tag files from pub/TWiki/TagMePlugin/ files to working/work_areas/TagMePlugin/ and they should magically re-appear.

Limitations

TWiki 04-Sep-2005 and older: Tags are lost if a topic is renamed or moved.

Peter Thoeny: Validate tag against known tags when adding a tag; improved docs

30 Aug 2008:

Colas Nahaboo: enhancements to the "blog" style: Bundles, count of known tags, option to delete tags

28 Aug 2008:

Colas Nahaboo: prefix & suffix options renamed as header & footer. New parameter style to TAGME to be able to define different UI style for the default "show" action of TAGME. Implemented a first one, "blog" for the simpler case of authors managing the same tags

Arthur Clemens: Added option NORMALIZE_TAG_INPUT (to be set to 0) to allow any word as tag name (including upper case, punctuation characters and spaces). Moved "Create New Tag" to dedicated page. Created CSS styles in tagme.css. Added mincount parameter to TAGME{tpaction="showalltags"}.