Tagging - v3

Use Cases

• User should be able to see a list of current tags
• User should be able to add one more more tags using a single-line interface
• User should be able to delete a tag
• User should get help on what tag types are available and what they mean (define, name, date, etc.)

Non-goals

• Renaming tags
• New tag browsing/viewing interfaces
• New tag types

UI requirements

<div id="deki-page-tags">
    <ul class="tags">
        <li>
            <a href="{TAG.URL}" tagid="TAG.ID" class="{TAG.TYPE (define, date)}" title="{TAG.Title}">{TAG.Title}</a>
            <span class="tagtype">{TAG:TYPE}<span>
        </li>
    </ul>
    <div class="title"><a href="{Special:Tags&pageId=N}" id="deki-page-tags-toggleview">Edit tags</a></div>
</div>

API requirements

The tagging API has been implemented in previous versions. No API changes are in scope for this spec.

The PHP tag class will be simplified to store tags as a simple data object (name, type, id, etc.) with static class methods to update/save tags.

Questions/Issues

• "Tag" header already output when tags are rendered -- would be nice to have "edit" link be near the tag title itself.
• Update themes to make them compatible?
•  Remove warnings when submitting tag which is already there

Future Ideas

• Can enforce "blessed" tags by having the autocomplete require a match / only accept existing tags
• Give admins a special page / setting on Special:Tags to define the valid set of tags.

Additional Information

Background notes on the current interface:

• "Edit tags" link can blur with the actual list of tags [making it difficult to find]. The "edit tags" link should be easily distinguished [this is skin dependent].
• Interface needs to be more skinnable 
• css/javascript for autocomplete, etc. needs to be tag-specific [can't just use "autoCompContainer"]

Existing Implementation:

• Components
  • (with javascript): "edit tags" -- dynamically loads tag form (/deki/gui/tags.php?action=edit&pageId=n) into page. Saving the form loads the tag view list (/deki/gui/tags.php?action=view&pageId=n).
  • (without js): "edit tags" -- loads special page for tags: /index.php?title=Special:Tags&pageId=n
  • deki_tag.php -- tag class implementation (saving/removing through API, sorting, etc.)
  • TagsOld.php -- defines wfShowTags, which renders the tag view html [used in article.php to render an article]. Makes comma-separated list of tags.
  • skins/common/tags.{js,css} => common tag code for the special page / non-special page behavior
    • Question: common code/pattern to dynamically render results? Common library for this to use?
    • This is auto-included by js.php [determining which javascript to send down].
• Question: If we implement tagsv3 as a plugin, only available when js disabled? [As a special page plugin or another type?]
  • The current tags.js is trigged as part of the common skin
  • redefine wfShowTags? [in TagsOld] - is this possible/desirable for a plugin