Difference between revisions of "Template:Sidebar/doc"

From EVE University Wiki
Jump to: navigation, search
m (Add dependency. Update Syntax. Make sample use Sidebar instead of draft version.)
m (Update dependencies.)
 
(15 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
:: {{Tl|Corplinks}}
+
<div style="max-width: max-content; column-width: 18em; column-count: 3; column-gap: 1em;>
:: {{Tl|Exploration links}}
+
:: {{T|Sidebar with collapsible lists}}
:: {{Tl|Incursions links}}
 
:: {{Tl|Incursions sites}}
 
:: {{Tl|Industry Links}}
 
:: {{Tl|Legality}}
 
:: {{Tl|MissionLinks}}
 
  
 +
:: {{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 46: Line 63:
  
 
| below =  
 
| below =  
| navbar = off
+
| 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 61: Line 78:
 
::; above : Text to appear above the heading/content sections.
 
::; above : Text to appear above the heading/content sections.
 
::; heading''<x>'' : ''x'' is 1 till 35 - text in the heading of a section.
 
::; 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>.
+
::; 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&#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 127: Line 147:
  
 
; 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 133: Line 156:
  
 
| heading1 = Heading 1
 
| heading1 = Heading 1
| content1 =  
+
| content1 = {{plainlist|
link 1-1<br>
+
* link 1-1
link 1-2<br>
+
* link 1-2
link 1-3<br>
+
* link 1-3
 +
}}
  
 
| heading2 = Heading 2
 
| heading2 = Heading 2
Line 146: Line 170:
 
| navbar = off
 
| navbar = off
  
}}
+
}}<pre>{{Sidebar
<pre>{{Sidebar
 
 
| topimage = [[File:Agent.png]]
 
| topimage = [[File:Agent.png]]
  
Line 153: Line 176:
  
 
| heading1 = Heading 1
 
| heading1 = Heading 1
| content1 =  
+
| content1 = {{plainlist|
link 1-1<br>
+
* link 1-1
link 1-2<br>
+
* link 1-2
link 1-3<br>
+
* link 1-3
 +
}}
  
 
| heading2 = Heading 2
 
| heading2 = Heading 2
| content2 =  
+
| content2 =
 
link 2-1<br>
 
link 2-1<br>
 
link 2-2<br>
 
link 2-2<br>
Line 169: Line 193:
 
</pre>
 
</pre>
  
; 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 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-2
 +
* link 2-3
 +
 
 +
| navbar = off
 +
 
 +
}}<pre>{{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
 +
 
 +
}}</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>

Latest revision as of 13:36, 19 May 2024

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}}
{{Community Group Navbar}}
{{Corplinks}}
{{Exploration links}}
{{Incursions links}}
{{Incursions sites}}
{{Industry Links}}
{{Legality}}
{{MissionLinks}}
{{Navigation Links}}
{{NullSec Campus links}}
{{NullSec Community links}}
{{PlanetaryIndustryNav}}
{{ShipTypes}}
{{Skillplan Navbar}}
{{Skills Links}}
{{Sovereigntynavbar}}
{{Structures}}
{{Triglavian links}}
{{Weapon Systems Links}}
{{Wormhole Links}}
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(es) 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}}