Feature Proposal: Show Topic Title in Square Bracket Links

Motivation

VarTOPICTITLE is implemented, and TopicDisplayName is planned. This proposal sits in between the two: Allow TOPICTITLE to be shown in square bracket links.

Description and Documentation

Three options to show topic title in square bracket links

1. [[TopicName]] or [[Web.TopicName]], but only if SHOWTOPICTITLELINK preferences setting is set
   • Example: [[Support.SID-01626]] renders as TWiki-5.1.3 - post upgrade issues if SHOWTOPICTITLELINK preferences setting is set, else renders as Support.SID-01626
2. [[+TopicName]] or [[+Web.TopicName]]
   • Example: [[+Support.SID-01626]] renders as TWiki-5.1.3 - post upgrade issues
3. [[TopicName][$topictitle]] or [[Web.TopicName][$topictitle]]
   • Example: [[Support.SID-01626][SID-01626: $topictitle]] renders as SID-01626: TWiki-5.1.3 - post upgrade issues

Note that [[link][label]] double square bracket links are not affected unless $topictitle is used, e.g. specifying the link label overrides the topic title.

Like with the LINKTOOLTIPINFO setting, enabling the new SHOWTOPICTITLELINK preferences flag will have a negative impact on performance, because the meta data needs to be read for each square bracket link. Therefore the default of the SHOWTOPICTITLELINK setting is off.

Examples

Impact

Implementation

-- Contributors: Peter Thoeny - 2013-01-26

Discussion

Feature accepted by JerusalemReleaseMeeting2013x02x01.

-- Peter Thoeny - 2013-02-01

This is now in SVN trunk. Docs updated at TWiki.TWikiPreferences and TWiki.TWikiEditingShorthands.

-- Peter Thoeny - 2013-02-08