Template:ReturnTop/doc View history

No edit summary
m (Clarified the instructions)
 
(One intermediate revision by one other user not shown)
Line 2: Line 2:
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.
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.
By default, if no argument is provided, the position of the page title is the top of the page.
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 calling the template <nowiki>{{ReturnTop|HereIsMyOwnTop}}</nowiki> will scroll to the middle of the page.
The template enables the "top of the page" position to be altered by adding, as a parameter, an anchor name. Then the selection of this icon will scroll the page up to the position of the named 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]]
See also [[Template:Anchor | Anchor template documentation]]

Latest revision as of 22:06, 24 July 2022

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 position of the page title is the top of the page.

The template enables the "top of the page" position to be altered by adding, as a parameter, an anchor name. Then the selection of this icon will scroll the page up to the position of the named 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