Template:Floating link/doc
![]() | This is a documentation subpage for Template:Floating link. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
[edit]This template creates a piped link to a subpage that hovers or 'floats' in the top right corner of the page it is used on, in the same place as {{coord}}. Due to this positioning, it should not be used on pages using {{coord}} as the two templates will overlap.
{{Floatinglink|1=SubPage|2=TextToDisplay}}
If you want to link to a page other than a subpage, use fullpath=y
and the first parameter will be treated as the full path.
If you would like to specify a CSS class for the span, use class=
(i.e. |class=sysop-show
).
Example
[edit]{{Floatinglink|1=doc|2=Documentation}}
Will create '[[/doc|Documentation]]' floating in the top right hand corner.
{{Floatinglink|1=Wikipedia:Template documentation|2=Documentation|fullpath=y}}
Will create '[[Wikipedia:Template documentation|Documentation]]' floating in the top right hand corner.
TemplateData
[edit]TemplateData for Floating link
This template creates a floating link on a page. Note: this should not be used with {{coord}}, as the links will overlap.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Page or subpage to link to | 1 | Either the subpage's suffix (after the page's own name and a slash), or a page's full name.
| String | required |
Text of the link | 2 | The text to be displayed in the floating link. Defaults to the value of the first parameter if not provided.
| String | required |
CSS class | class | To specify a CSS class for the span tag containing the floating link
| String | optional |
Specify link using full path? | fullpath | If this parameter is not empty, the first parameter will be treated as the entire name of the page you want to link to. Otherwise, it will be treated as a suffix, to be appended to the name of the page you're adding this template to plus a slash.
| String | optional |