Jump to content

Template:Anchor: Difference between revisions

docs wording
(adding docs, restoring full functionality as on WP)
(docs wording)
Line 1: Line 1:
<noinclude>If you enclose text on a page as a parameter to this template, e.g. <nowiki>{{Anchor|some_anchor_name}}</nowiki>, it creates an invisible HTML span id while still displaying that text on the page as before. This span id can be used as a "jump point" by making a link in any article such as <nowiki>[[Some_article#some_anchor_name]]</nowiki>; upon clicking it, you will be taken directly to the text that you enclosed in <nowiki>{{Anchor|}}</nowiki>.
<noinclude>If you enclose text on a page as a parameter to this template, e.g. <nowiki>{{Anchor|some_anchor_name}}</nowiki>, it creates an invisible HTML span id while still displaying that text on the page as before. This span id can be used as a "jump point" by making a link in any article such as <nowiki>[[Some_article#some_anchor_name]]</nowiki>; upon clicking it, you will be taken directly to the text that you enclosed in <nowiki>{{Anchor|}}</nowiki>.


This is similar to the functionality of the "==Header Name=="-type wiki code that marks section headers, except that it displays as normal text and it will not be included in the automatically-generated Table of Contents (TOC) like "==" headers will be. For a sample usage of the Anchor template, see the wiki markup for [[History of the Oni community]], which marks the article with year tags so that intrawiki links can jump the user to that year in history by saying, for instance, <nowiki>[[History of the Oni Community#2001]]</nowiki>.
This is similar to the functionality of the "==Header Name=="-type wiki code that marks section headers, except that it does not display as text and it will not be included in the automatically-generated Table of Contents (TOC) like "=="-type headers will be. For a sample usage of the Anchor template, see the wiki markup for [[History of the Oni community]], which marks the article with year tags so that intrawiki links can jump the user to that year in history by using, for instance, <nowiki>[[History of the Oni Community#2001]]</nowiki>.


The original goal in introducing this template was to create a custom TOC based on this invisible section markup that could be used to document [[BSL:Tutorial/airport1_level_logic.bsl|raw BSL]]; however, no simple solution to the issue of how to create a TOC from span ids has been found yet.
The original goal in introducing this template was to create a custom TOC based on this invisible section markup that could be used to document [[BSL:Tutorial/airport1_level_logic.bsl|raw BSL]]; however, no simple solution to the issue of how to create a TOC from span ids has been found yet.