Anchor Link Plugin

Description

This plugin shows an anchor link icon when hovering over headings. When clicked, the browser URL bar will show the anchor link of the heading, useful to copy and paste a deep link. In addition, anchor links can be added using an %ANCHORLINK{}% variable.

Screenshot when hovering over a heading, and clicking on the anchor link:

ANCHORLINK Variable

• Add an anchor link to topic text, such as %ANCHORLINK{"AnchorExample"}%. When hovering over text where an anchor link has been added, a icon will appear on the left side. Clicking on it will show the #AnchorExample in the browser URL bar for easy copy & paste.
• Anchor links can be added to bullets, tables, etc, as in this example. %ANCHORLINK{"AnchorExample"}% However, they currently cannot be added to top level paragraphs. Anchor link IDs must be unique per page.
• Anchor links are added automatically to headers by the AnchorLinkPlugin.
• Syntax: %ANCHORLINK{"id"}%
• Parameters:

  Parameter	Description	Default	Example
  "id"	Identifier (name) of the anchor. Use only: a-z, A-Z, 0-9, _, -	(required)	"Progress"

• Example: %ANCHORLINK{"AnchorExample"}%
• Expands to embedded HTML: <a name="AnchorExample"></a>, along with logic to show/hide the anchor link icon
• Category: LinkingAndNavigationVariables, UIAndVisualizationVariables

Settings

The {Plugins}{AnchorLinkPlugin}{Headings} configure setting defines the headers that show an anchor link on hover, default: h2, h3, h4, h5, h6

This configure setting can be redefined by a ANCHORLINKHEADINGS preferences setting at the site level (Main.TWikiPreferences), any web (WebPreferences), and topic level. Example:

• Set ANCHORLINKHEADINGS = h1, h2, h3, h4

Plugin Installation & Configuration

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

Show details Hide details

Plugin Info

• Set SHORTDESCRIPTION = Show anchor links on hover over headings, to copy anchor link address

Author:	TWiki:Main.PeterThoeny, TWiki.org
Copyright:	© 2020-2021 TWiki:Main.PeterThoeny © 2020-2021 TWiki:TWiki.TWikiContributor
License:	GPL (GNU General Public License)
Version:	2021-03-25
2021-03-25:	TWikibug:Item7927: Copyright update to 2021

Show Change History Hide Change History

2020-12-20:	TWikibug:Item7919: Add ANCHORLINK variable; fix name clash with existing twikiAnchorLink class name in TWiki
2020-10-24:	TWikibug:Item7919: Initial version of AnchorLinkPlugin

TWiki Dependency:	$TWiki::Plugins::VERSION 1.2
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.008
Plugin Benchmark:	GoodStyle nn%, FormattedSearch nn%, AnchorLinkPlugin nn%
Home:	http://TWiki.org/cgi-bin/view/Plugins/AnchorLinkPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/AnchorLinkPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/AnchorLinkPluginAppraisal

Related Topics: VarANCHORLINK, LinkingAndNavigationVariables, UIAndVisualizationVariables, TWikiPlugins