[JSPWIKI-1105] Add support for #HashTags in JSPWIKi Pages

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: Core & storage
• Assignee: Unassigned
• Reporter: Dirk Frederickx
• Created: 06/Apr/19 11:52
• Updated: 06/Apr/19 11:55

Description

 

PROPOSAL – Under Discussion

See https://en.wikipedia.org/wiki/Hashtag

 A hashtag is a type of metadata tag used on social networks such as Twitter and other microblogging services, allowing users to apply dynamic, user-generated tagging which makes it possible for others to easily find messages with a specific theme or content.

 
Hashtags could be a very useful feature to be added to JSPWiki, as an additional way to categorise and retrieve information;  via simple in-content markup.

Why?

You can already use regular wiki-links to connect and organise information any way you want;  eg by defining your own category pages.

But with Hashtags, a user can avoid to make intermediary category pages. 
Hashtags effectively separate the aspect of tagging information from the notion of
referring or linking wiki pages.
Hashtags have become a de-facto way of labelling information.

Markup

The proposed markup is very simple;  and can be used anywhere in the page markup.
#tag1, #tag2, ....

Note:  the # character is already used in wiki markup. Additional rules are needed and backwards compatibility needs to be checked.

1. Ordered Lists.
   The # character is recognised as Ordered Lists markup when it appears as first character on a new line.
   When a # character does not appear at the start of a line would be recognised as Hashtag.
2. Additionally,  it is proposed to render a # only as an OL item, when more than one subsequent line starts with the # character.
   This way a #hashtag could also be used as the first character on a line. 
3. The # character can also be used inside links, to refer to sections, or footnotes.   
   But in this case there is no overlap with the use of a # for a Hashtag.
4. A #tag1 would be rendered as a link to  {{ /jspwiki-url/Search.jsp?tag=tag1 }}

 

Core Engine
Hashtags should be stored as page metadata.  And become indexed for search.

Template / UI

• The INFO page would show a summary of all #hashTags on the page.
• The Search.JSP needs to be extended with a search options for TAGs.

Plugins

A number of Plugins need to be extended to also support filtering on TAGs:

EG:

• SearchPlugin 
• RecentChanges  (show recent/trending hashtags)
• PageIndex  (or HashtagIndex)
• ...