Difference between revisions of "Template:Sidebar/doc"
From EVE University Wiki
m (Update dependencies.) |
m (Update doc.) |
||
Line 65: | Line 65: | ||
| 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> | ||
Line 84: | Line 84: | ||
::; 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 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 159: | Line 163: | ||
| heading2 = Heading 2 | | heading2 = Heading 2 | ||
− | | content2 = {{plainlist| | + | | 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-2<br> | ||
+ | link 2-3<br> | ||
+ | |||
+ | | navbar = off | ||
+ | |||
+ | }} | ||
+ | </pre> | ||
+ | {{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. | ||
+ | }} | ||
+ | |||
+ | |||
+ | : 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]] | ||
+ | |||
+ | | 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-1 | ||
* link 2-2 | * link 2-2 | ||
* link 2-3 | * link 2-3 | ||
− | + | ||
+ | | navbar = off | ||
+ | |||
}}<pre>{{Sidebar | }}<pre>{{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-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 | * link 2-1 | ||
* link 2-2 | * link 2-2 | ||
* link 2-3 | * link 2-3 | ||
− | |||
| navbar = off | | navbar = off | ||
− | }} | + | }}</pre> |
− | </pre> | ||
− | |||
− | |||
− | |||
<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> |
Revision as of 15:32, 29 July 2023
- Description
- This template is a metatemplate for the creation of sidebar templates, i.e. boxes that are vertically-aligned navigational templates.
- This template is converted from the last non-lua version of Wikipedia Sidebar
{{Corplinks}}
{{Exploration links}}
{{Incursions links}}
{{Incursions sites}}
{{Industry Links}}
{{Legality}}
{{MissionLinks}}
{{Navigation Links}}
{{PlanetaryIndustryNav}}
{{ShipTypes}}
{{Skillplan Navbar}}
{{Skills Links}}
{{Structures}}
{{Triglavian links}}
{{Weapon Systems Links}}
{{Wormhole Links}}
{{AmarrEpicArcNav}}
{{AngelEpicArcNav}}
{{GallenteEpicArcNav}}
{{GuristasEpicArcNav}}
{{MinmatarEpicArcNav}}
- Syntax
-
- For UnuWiki navigational sidebar
- The UniWiki navigational sidebar uses a subset of the available parameters and only the parameters used are documented.
{{Sidebar | name = {{subst:PAGENAME}} | topimage = | topcaption = | pretitle = | title = | image = | caption = | above = | heading1 = | content1 = | heading2 = | content2 = | heading3 = | content3 = <!-- More heading<x>, content<x> blocks as required up to a maximum of 35 --> | below = | navbar = }}
- Parameters (Data)
-
- name
- The name of the sidebar's page. {{subst:PAGENAME}} can be used. May be omitted if no navbar is used (
navbar
must beoff
). - topimage
- Image at the top of the sidebar. Use standard wiki mark-up i.e. [[File:filename.png|64px]]
- topcaption
- Caption to appear under
topimage
. - pretitle
- Pre-title of the sidebar. Appears above
title
- title
- Title of the sidebar
- image
- Image below the title. Use standard wiki mark-up i.e. [[File:filename.png|64px]]
- caption
- Caption to appear under
image
. - above
- Text to appear above the heading/content sections.
- heading<x>
- x is 1 till 35 - text in the heading of a section.
- content<x>
- x is 1 till 35 - Content of a section. One or more links separated by <br>.
- below
- Text to appear below the heading/content sections.
- navbar
- Controls the use of navbar. Use
off
to deactivate (If not deactivatedname
must be filled in).
- Parameters (Format)
-
- contentclass
- Name of the CSS class to be applied to all content<x> parameters. i.e.
plainlist
to achieve{{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 -- Evon R'al (talk) 11:39, 4 June 2023 (UTC)
- Sample
Sidebar title |
---|
Heading 1 |
|
Heading 2 |
link 2-1 |
{{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-2<br> link 2-3<br> | navbar = off }}
- This sample uses the parameter
contentclass
to apply the classplainlist
to al content<x> parameters removing the need to use{{plainlist}}
in each separately.
Sidebar title |
---|
Heading 1 |
|
Heading 2 |
|
{{Sidebar | 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 }}