Difference between revisions of "Template:Sidebar/doc"

From EVE University Wiki
Jump to: navigation, search
m (Update dependencies.)
m (Move {{Plainlinks}} to See also, it can be used inside {{Navbox}} but it is not integrated in the template code. Add dependency for class nowraplinks coming available.)
Line 5: Line 5:
 
; Dependencies:
 
; Dependencies:
 
:; Uses
 
:; Uses
 +
:: CSS class nowraplinks in [[MediaWiki:Common.css|Common.css]]
 
:: {{T|Navbar}}
 
:: {{T|Navbar}}
:: {{T|Plainlist}}
 
 
:; Used by
 
:; Used by
 
<div style="max-width: max-content; column-width: 18em; column-count: 3; column-gap: 1em;>
 
<div style="max-width: max-content; column-width: 18em; column-count: 3; column-gap: 1em;>
Line 84: Line 84:
 
::; 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.
 
::; 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
+
; 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&#39;al|Evon R&#39;al]] ([[User talk:Evon R&#39;al|talk]]) 11:39, 4 June 2023 (UTC)
: 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&#39;al|Evon R&#39;al]] ([[User talk:Evon R&#39;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 147: Line 146:
  
 
; Sample
 
; Sample
 +
 +
{{Note box|Note: Notice the difference between content1 using {{Tl|Plainlist}} and content2 Using &lt;br> to separate the link. Especially the extra whitespace between the last and second last entry.
 +
}}
 
{{Sidebar
 
{{Sidebar
 
| topimage = [[File:Agent.png]]
 
| topimage = [[File:Agent.png]]
Line 189: Line 191:
 
}}
 
}}
 
</pre>
 
</pre>
{{Note box|Note : Notice the difference between content1 using {{Tl|Plainlist}} and content2 Using &lt;br> to separate the link. Especially the extra whitespace between the last and second last entry.
 
}}
 
  
  
Line 237: Line 237:
  
 
}}</pre>
 
}}</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>

Revision as of 15:19, 3 August 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
Dependencies
Uses
CSS class nowraplinks in Common.css
{{Navbar}}
Used by
{{Sidebar with collapsible lists}}
{{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}}
{{AngelEpicArcNav}}
{{GuristasEpicArcNav}}
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 be off).
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 deactivated name 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
Note: Notice the difference between content1 using {{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]]

| 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 class plainlist to al content<x> parameters removing the need to use {{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-2
* link 2-3

| navbar = off

}}
See also
{{Plainlist}}