Template:Vanchor

From OpenMW Wiki
Revision as of 20:07, 28 June 2017 by Darklocq (talk | contribs) (creating template and doc)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Anchor name here

Documentation

This creates an HTML anchor (in-page link target for an article_name#anchor_name_here link – the part after the #) for the given text, while still displaying the text.

I.e., it replaces something like:

  • <span id="Anchor name here"></span>Anchor name here

with

  • {{vanchor|Anchor name here}}

This helps lists with anchored entries have cleaner, easier-to-read code.


Important: This text cannot contain markup of any kind, only plain text – no wikimarkup, no templates. If you need to anchor text that has markup, put the markup around the template:

  • ''{{vanchor|Anchor name here}}''

or use a manual <span id="Anchor name here"></span> in front of the text (this must be done in particular when the text is an anchor on this page and also a link to something else; you can't have a link inside an anchor or vice versa):

  • <span id="Anchor name here"></span>[[Some other page|Anchor name here again]]


If the text includes an equals sign (=) anywhere in it, you must use a numbered parameter for the text:

{{vanchor|1=Anchor = name here}}


Also, the text is a literal string. These two are not equivalent:

  • {{vanchor|Anchor name here}}
  • {{vanchor| Anchor name here}}

Additional parameters

The template will also create up to 4 additional anchors, for spelling variations, etc. Only the first is displayed. These are given in series or numbered:

  • {{vanchor|Visible anchor|alternative 1|alternative 2|alternative 3|alternative 4}}
  • {{vanchor|1=Visible anchor|2=alternative 1|3=alternative 2|4=alternative 3|5=alternative 4}}

The code is self-explanatory, and this can easily be extended to support more parameters if necessary.

HTML note

This uses HTML 4.01's <span id="..."></span> format only because the installed version of MediaWiki at wiki.OpenMW.org does not support the cleaner HTML5 <span id="..." /> syntax. If the system is upgraded to support it, this template should be updated to use it. Also, it does not output <span id="Anchor name here">Anchor name here</span> (with span wrapping the displayed text) because this causes the anchor to mistakenly appear as a clickable but circular link in some old browsers.