Difference between revisions of "Template:Sidebar/doc"

From EVE University Wiki
Jump to: navigation, search
(Create template documentation.)
 
m (Add dependency. Update Syntax. Make sample use Sidebar instead of draft version.)
Line 7: Line 7:
 
:: {{T|Navbar}}
 
:: {{T|Navbar}}
 
:; Used by
 
:; Used by
 +
:: {{Tl|Corplinks}}
 +
:: {{Tl|Exploration links}}
 +
:: {{Tl|Incursions links}}
 +
:: {{Tl|Incursions sites}}
 +
:: {{Tl|Industry Links}}
 +
:: {{Tl|Legality}}
 +
:: {{Tl|MissionLinks}}
  
 
; Syntax
 
; Syntax
Line 53: Line 60:
 
::; 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'''<x>''' :
+
::; heading''<x>'' : ''x'' is 1 till 35 - text in the heading of a section.
::; content'''<x>''' :
+
::; 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.
 
::; 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).
Line 93: Line 100:
 
| above =  
 
| above =  
  
| heading1 = Mission Reports
+
| heading1 =  
 
| heading1class =  
 
| heading1class =  
 
| content1 =  
 
| content1 =  
 
| content1class =  
 
| content1class =  
  
| heading2 = Mission Guides
+
| heading2 =  
 
| heading2class =  
 
| heading2class =  
 
| content2 =  
 
| content2 =  
 
| content2class =  
 
| content2class =  
  
| heading3 = Special Missions
+
| heading3 =  
 
| heading3class =  
 
| heading3class =  
 
| content3 =  
 
| content3 =  
 
| content3class =  
 
| content3class =  
  
| heading4 = Helpful Links
+
| heading4 =  
 
| heading4class =  
 
| heading4class =  
 
| content4 =  
 
| content4 =  
Line 120: Line 127:
  
 
; Sample
 
; Sample
{{User:Evon R'al/Sandbox template
+
{{Sidebar
 
| topimage = [[File:Agent.png]]
 
| topimage = [[File:Agent.png]]
  
Line 147: Line 154:
 
| heading1 = Heading 1
 
| heading1 = Heading 1
 
| content1 =  
 
| content1 =  
* link 1
+
link 1-1<br>
* link 2
+
link 1-2<br>
 +
link 1-3<br>
  
 
| heading2 = Heading 2
 
| heading2 = Heading 2
 
| content2 =  
 
| content2 =  
* link 3
+
link 2-1<br>
* link 4
+
link 2-2<br>
 +
link 2-3<br>
  
 
| navbar = off
 
| navbar = off

Revision as of 15:40, 4 June 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
{{Navbar}}
Used by
{{Corplinks}}
{{Exploration links}}
{{Incursions links}}
{{Incursions sites}}
{{Industry Links}}
{{Legality}}
{{MissionLinks}}
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 = off

}}
Parameters
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 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
.
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).



Sample
{{Sidebar
| topimage = [[File:Agent.png]]

| title = Sidebar title

| heading1 = Heading 1
| content1 = 
link 1-1<br>
link 1-2<br>
link 1-3<br>

| heading2 = Heading 2
| content2 = 
link 2-1<br>
link 2-2<br>
link 2-3<br>

| navbar = off

}}
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)