Template:ReturnTop/doc View history

(Added Category)
No edit summary
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{doc subpage}}
{{doc subpage}}
This template is placed on a page primarily at the end of a section with many sections on the page. This provides a quick link to the top of the page. This template requires the template <nowiki>{{Anchor|Top}}</nowiki> be placed at the point of the page where the reader is to be directed.
This template is placed on a page primarily at the end of a section with many sections on the page. This displays an icon providing a quick link to the top of the page.
 
By default, if no argument is provided, the top of the page is the position where is displayed the page title.
However this template allows to define your own "top of the page" position by adding, as a parameter, an anchor name. Then the icon will scroll the page up to the position of this Anchor.
 
For instance, if you add the following syntax in the middle of the page : '''<nowiki>{{Anchor|HereIsMyOwnTop}}}}</nowiki>''', then using the template '''<nowiki>{{ReturnTop|HereIsMyOwnTop}}</nowiki>''' will display an icon to scroll to the middle of the page.
 
See also [[Template:Anchor | Anchor template documentation]]


<includeonly>
<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Page Formatting Template]]
[[Category:Linking templates]]


<!-- ADD INTERWIKIS BELOW THIS LINE -->
<!-- ADD INTERWIKIS BELOW THIS LINE -->
</includeonly>
</includeonly>

Revision as of 10:15, 30 March 2015

This is a documentation subpage for Template:ReturnTop.
It contains usage information, categories and other content that is not part of the original template page.

This template is placed on a page primarily at the end of a section with many sections on the page. This displays an icon providing a quick link to the top of the page.

By default, if no argument is provided, the top of the page is the position where is displayed the page title. However this template allows to define your own "top of the page" position by adding, as a parameter, an anchor name. Then the icon will scroll the page up to the position of this Anchor.

For instance, if you add the following syntax in the middle of the page : {{Anchor|HereIsMyOwnTop}}}}, then using the template {{ReturnTop|HereIsMyOwnTop}} will display an icon to scroll to the middle of the page.

See also Anchor template documentation