More actions
Create template documentation. |
m Update dependencies. |
||
| (16 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
; Description | ; Description | ||
: This template is a metatemplate for the creation of sidebar templates, i.e. boxes that are vertically-aligned [[:Category:Navigational templates|navigational template]]s. | : This template is a [[:wikt:metatemplate|metatemplate]] for the creation of sidebar templates, i.e. boxes that are vertically-aligned [[:Category:Navigational templates|navigational template]]s. | ||
: This template is converted from the last non-lua version of Wikipedia [https://en.wikipedia.org/w/index.php?oldid=609911857 Sidebar] | : This template is converted from the last non-lua version of Wikipedia [https://en.wikipedia.org/w/index.php?oldid=609911857 Sidebar] | ||
; Dependencies: | ; Dependencies: | ||
:; Uses | :; Uses | ||
:: CSS class nowraplinks in [[MediaWiki:Common.css|Common.css]] | |||
:: {{T|Navbar}} | :: {{T|Navbar}} | ||
:; Used by | :; Used by | ||
<div style="max-width: max-content; column-width: 18em; column-count: 3; column-gap: 1em;> | |||
:: {{T|Sidebar with collapsible lists}} | |||
:: {{T|Community Group Navbar}} | |||
:: {{T|Corplinks}} | |||
:: {{T|Exploration links}} | |||
:: {{T|Incursions links}} | |||
:: {{T|Incursions sites}} | |||
:: {{T|Industry Links}} | |||
:: {{T|Legality}} | |||
:: {{T|MissionLinks}} | |||
:: {{T|Navigation Links}} | |||
:: {{T|NullSec Campus links}} | |||
:: {{T|NullSec Community links}} | |||
:: {{T|PlanetaryIndustryNav}} | |||
:: {{T|ShipTypes}} | |||
:: {{T|Skillplan Navbar}} | |||
:: {{T|Skills Links}} | |||
:: {{T|Sovereigntynavbar}} | |||
:: {{T|Structures}} | |||
:: {{T|Triglavian links}} | |||
:: {{T|Weapon Systems Links}} | |||
:: {{T|Wormhole Links}} | |||
</div> | |||
; Syntax | ; Syntax | ||
:; For UnuWiki navigational sidebar <!-- This syntax has a number of parameters omitted. Use of these parameters is discouraged for the navigational sidebar. But they are left in in the template to avoid breaking it and to have them still available when wanted later.--> | :; For UnuWiki navigational sidebar <!-- This syntax has a number of parameters omitted. Use of these parameters is discouraged for the navigational sidebar. But they are left in in the template to avoid breaking it and to have them still available when wanted later.--> | ||
| Line 39: | Line 63: | ||
| below = | | below = | ||
| navbar = | | navbar = | ||
}} | }} | ||
</pre> | </pre> | ||
:; Parameters | :; Parameters (Data) | ||
::; name : The name of the sidebar's page. <nowiki>{{subst:PAGENAME}}</nowiki> can be used. May be omitted if no navbar is used (<code>navbar</code> must be <code>off</code>). | ::; name : The name of the sidebar's page. <nowiki>{{subst:PAGENAME}}</nowiki> can be used. May be omitted if no navbar is used (<code>navbar</code> must be <code>off</code>). | ||
::; topimage : Image at the top of the sidebar. Use standard wiki mark-up i.e. <nowiki>[[File:filename.png|64px]]</nowiki> | ::; topimage : Image at the top of the sidebar. Use standard wiki mark-up i.e. <nowiki>[[File:filename.png|64px]]</nowiki> | ||
::; topcaption : Caption appear under <code>topimage</code>. | ::; topcaption : Caption to appear under <code>topimage</code>. | ||
::; pretitle : Pre-title of the sidebar. Appears above <code>title</code> | ::; pretitle : Pre-title of the sidebar. Appears above <code>title</code> | ||
::; title : Title of the sidebar | ::; title : Title of the sidebar | ||
| Line 53: | Line 77: | ||
::; caption : Caption to appear under <code>image</code>. | ::; caption : Caption to appear under <code>image</code>. | ||
::; above : Text to appear above the heading/content sections. | ::; above : Text to appear above the heading/content sections. | ||
::; heading | ::; heading''<x>'' : ''x'' is 1 till 35 - text in the heading of a section. | ||
::; content | ::; content''<x>'' : ''x'' is 1 till 35 - Content of a section. One or more links separated by <nowiki><br></nowiki>. | ||
::; below : Text to appear below the heading/content sections. | ::; below : Text to appear below the heading/content sections. | ||
::; navbar : Controls the use of navbar. Use <code>off</code> to deactivate (If not deactivated <code>name</code> must be filled in). | ::; navbar : Controls the use of navbar. Use <code>off</code> to deactivate (If not deactivated <code>name</code> must be filled in). | ||
:; Parameters (Format) | |||
::; contentclass : Name of the CSS class(es) to be applied to all content''<x>'' parameters. i.e. <code>plainlist</code> to achieve {{Tl|Plainlist}} effect on the content. | |||
; Note : This documentation does not include all possible parameters. Only the parameters for use in the UniWiki navigational sidebar are documented. Reason: lack of time, seeing no use for them now. And being plain lazy -- [[User:Evon R'al|Evon R'al]] ([[User talk:Evon R'al|talk]]) 11:39, 4 June 2023 (UTC) | |||
<!-- "complete" parameter set. To be available for later use. Documentation is written with only the parameters needed for UniWiki navigation sidebar documented. | <!-- "complete" parameter set. To be available for later use. Documentation is written with only the parameters needed for UniWiki navigation sidebar documented. | ||
| Line 93: | Line 120: | ||
| above = | | above = | ||
| heading1 = | | heading1 = | ||
| heading1class = | | heading1class = | ||
| content1 = | | content1 = | ||
| content1class = | | content1class = | ||
| heading2 = | | heading2 = | ||
| heading2class = | | heading2class = | ||
| content2 = | | content2 = | ||
| content2class = | | content2class = | ||
| heading3 = | | heading3 = | ||
| heading3class = | | heading3class = | ||
| content3 = | | content3 = | ||
| content3class = | | content3class = | ||
| heading4 = | | heading4 = | ||
| heading4class = | | heading4class = | ||
| content4 = | | content4 = | ||
| Line 120: | Line 147: | ||
; Sample | ; Sample | ||
{{ | |||
{{Note box|Note: Notice the difference between content1 using {{Tl|Plainlist}} and content2 Using <br> to separate the link. Especially the extra whitespace between the last and second last entry. | |||
}} | |||
{{Sidebar | |||
| topimage = [[File:Agent.png]] | | topimage = [[File:Agent.png]] | ||
| Line 126: | Line 156: | ||
| heading1 = Heading 1 | | heading1 = Heading 1 | ||
| content1 = | | content1 = {{plainlist| | ||
link 1-1 | * link 1-1 | ||
link 1-2 | * link 1-2 | ||
link 1-3 | * link 1-3 | ||
}} | |||
| heading2 = Heading 2 | | heading2 = Heading 2 | ||
| content2 = | | content2 = | ||
link 2-1<br> | |||
link 2-2<br> | |||
link 2-3<br> | |||
| navbar = off | |||
}}<pre>{{Sidebar | |||
| topimage = [[File:Agent.png]] | |||
| title = Sidebar title | |||
| heading1 = Heading 1 | |||
| content1 = {{plainlist| | |||
* link 1-1 | |||
* link 1-2 | |||
* link 1-3 | |||
}} | |||
| heading2 = Heading 2 | |||
| content2 = | |||
link 2-1<br> | link 2-1<br> | ||
link 2-2<br> | link 2-2<br> | ||
| Line 140: | Line 191: | ||
}} | }} | ||
<pre>{{Sidebar | </pre> | ||
: This sample uses the parameter <code>contentclass</code> to apply the class <code>plainlist</code> to al content''<x>'' parameters removing the need to use {{Tl|plainlist}} in each separately. | |||
{{Sidebar | |||
| topimage = [[File:Agent.png]] | | topimage = [[File:Agent.png]] | ||
| title = Sidebar title | | title = Sidebar title | ||
| contentclass = plainlist | |||
| heading1 = Heading 1 | | heading1 = Heading 1 | ||
| content1 = | | content1 = | ||
* link 1 | * link 1-1 | ||
* link 2 | * link 1-2 | ||
* link 1-3 | |||
| heading2 = Heading 2 | | heading2 = Heading 2 | ||
| content2 = | | content2 = | ||
* link | * link 2-1 | ||
* link | * link 2-2 | ||
* link 2-3 | |||
| navbar = off | | navbar = off | ||
}} | }}<pre>{{Sidebar | ||
</pre> | | topimage = [[File:Agent.png]] | ||
| title = Sidebar title | |||
| contentclass = plainlist | |||
| heading1 = Heading 1 | |||
| content1 = | |||
* link 1-1 | |||
* link 1-2 | |||
* link 1-3 | |||
| heading2 = Heading 2 | |||
| content2 = | |||
* link 2-1 | |||
* link 2-2 | |||
* link 2-3 | |||
| navbar = off | |||
}}</pre> | |||
; See also | |||
:: {{T|Plainlist}} | |||
<includeonly>[[Category:Sidebar templates]]<!-- Any categories for the template itself --></includeonly> | <includeonly>[[Category:Sidebar templates]]<!-- Any categories for the template itself --></includeonly> | ||
<noinclude>[[Category:Template documentation]]</noinclude> | <noinclude>[[Category:Template documentation]]</noinclude> | ||