View Source

{toc}
h1. Introduction
{excerpt}Tags (labels, topics) are a popular way to organize knowledge using social classification (tagging) processes and producing so-called folksonomies{excerpt}
This spec is simple enough, so we put all parts (data model, spec and API) in this page.

Effort allocation from [RS Plan 3.6]:
- Tags spec: 3 p/d
- Tags backend: 5
- Tags frontend: 8

Jira tasks:
- {jira:RS-1175} Overall
- {jira:RS-1176} Spec

h1. Tags Data Model

h2. Source of Tags
Tags in RS come from two places:
- General thesauri.
Any thesaurus with rso:isTag=1 (marked as "t" in [Meta-Thesaurus and FR Names#Meta-thesaurus table]) can be used as a source of tags
- Dedicated thesaurus.
A special RS Tags thesaurus (http://www.researchspace.org/thesaurus/tag). New tags are added here

h2. Applying Tags to Entities
Tags can be applied to the following RS entities (compare with [Data Basket Model#Item Types]):
- Bookmark
- Data Annotation
- Forum/Topic/Post (new in RS3.6)
- Image (no UI to show a single image yet)
- Image Annotation
- Object

h2. Tags Ontology
We use the [Tags Ontology|http://www.holygoat.co.uk/projects/tags/] ([tags.n3|http://www.holygoat.co.uk/owl/redwood/0.1/tags/tags.n3], which defines:
- class Tag as a subclass of skos:Concept. (This is perfect: when a skos:Concept is applied as a tag, it becomes tags:Tag.)
- two inverse properties (taggedWithTag and isTagOf) to relate any resource to a tag

The Tags ontology is depicted here:
!tags.png!
- We don't use tags:Tagging, i.e. don't record who/when added a tag
- There is no ordering of the tags applied to an object

Here is an example that relates ?obj to Rembrandt, and to a user-created tag named "Watercolor".
{noformat}
@prefix tags: <http://www.holygoat.co.uk/owl/redwood/0.1/tags/> .
@prefix rs-tag: <http://www.researchspace.org/thesaurus/tag/> .

rs-tag:1234 skos:inScheme rs-tag:; skos:prefLabel "Watercolor".
?obj tags:taggedWithTag rkd-artist:Rembrandt, rs-tag:1234.
{noformat}

h1. Tags UI and Use Cases
Modeled after Yammer (with some simplifications):
!tags-edit.png!
Because of the limited effort in RS3.6, some viable cases are listed under [#Future Use Cases].

h2. RS3.6 Use Cases
TODO: make mockups!

h3. Tags in entity detailed view
- Every entity type should use the same Tags section
Where to put this for Object? I guess on top?
- Tags are represented as "buttons" for easier recognition
- There's a red "x" after each tag to delete it
- There's an empty box at the end of the tag list.
When the user starts typing, RS does autocompletion against all tag thesauri.
If the user doesn't select from the autocomplete box and presses Add, a new tag is added to the Tags thesaurus (so it's easy for any user to add new tags)

h3. Tags in entity list view
(eg Object search results list, Bookmarks list ...)
- It's best to use the same Tags section as above
- Or do we want some "lighter-weight" version of it?
- In particular, do we want the user to be able to add/delete tags from here?

h3. Search by tag
- Clicking on a tag runs a search by that Tag, for that entity kind only
- In the Search dialog for every entity kind, there's a Tags section to add tags to the search
- Where to put this in object (FR) search?

h2. Future Use Cases
- Universal search (of any kind of object) by tag
- Apply/create tag using twitter notation in rich-text: #tag
- Tags maintenance (of the dedicated thesaurus)
-- Rename tag
-- Merge two tags
- Per project Tag sets
- Tag cloud, in one of the following forms:
!tag-cloud0.jpg!!tag-cloud1.jpg!!tag-cloud2.gif!!tag-cloud3.jpg|width=300!

h1. Tags API
TODO