Difference between revisions of "User:Evon R'al/Sandbox template/doc"

From EVE University Wiki
Jump to: navigation, search
m (Blank page for next project.)
Tag: Blanking
m (Coding and testing.)
Line 1: Line 1:
 +
; 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 converted from the last non-lua version of Wikipedia [https://en.wikipedia.org/w/index.php?oldid=609911857 Sidebar]
  
 +
; Dependencies:
 +
:; Uses
 +
:: {{T|Navbar}}
 +
:; Used by
 +
 +
; 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.-->
 +
:: The UniWiki navigational sidebar uses a subset of the available parameters and only the parameters used are documented.
 +
 +
<pre>{{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
 +
 +
}}
 +
</pre>
 +
 +
:; Parameters
 +
::; 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>
 +
::; topcaption : Caption appear under <code>topimage</code>.
 +
::; pretitle : Pre-title of the sidebar. Appears above <code>title</code>
 +
::; title : Title of the sidebar
 +
::; image : Image below the title. Use standard wiki mark-up i.e. <nowiki>[[File:filename.png|64px]]</nowiki>
 +
::; caption : Caption to appear under <code>image</code>.
 +
::; above : Text to appear above the heading/content sections.
 +
::; heading'''<x>''' :
 +
::; content'''<x>''' :
 +
::; 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).
 +
 +
 +
 +
<!-- "complete" parameter set. To be available for later use. Documentation is written with only the parameters needed for UniWiki navigation sidebar documented.
 +
<pre>{{Sidebar
 +
| name =
 +
| class =           
 +
| wraplinks =        --><!-- "true" otherwise (default:) omit --><!--
 +
| float =
 +
| templatestyles =
 +
| child templatestyles =
 +
| grandchild templatestyles =
 +
 +
| outertitleclass =
 +
| outertitle =
 +
 +
| topimageclass =
 +
| topimage =
 +
| topcaption =
 +
 +
| pretitleclass =
 +
| pretitle =
 +
 +
| titleclass =
 +
| title =
 +
 +
| imageclass =
 +
| image =
 +
| caption =
 +
 +
| headingclass =
 +
| contentclass =
 +
 +
| aboveclass =
 +
| above =
 +
 +
| heading1 = Mission Reports
 +
| heading1class =
 +
| content1 =
 +
| content1class =
 +
 +
| heading2 = Mission Guides
 +
| heading2class =
 +
| content2 =
 +
| content2class =
 +
 +
| heading3 = Special Missions
 +
| heading3class =
 +
| content3 =
 +
| content3class =
 +
 +
| heading4 = Helpful Links
 +
| heading4class =
 +
| content4 =
 +
 +
| belowclass =
 +
| below =
 +
| navbar = off
 +
 +
}}
 +
</pre>-->
 +
 +
; Sample
 +
{{User:Evon R'al/Sandbox template
 +
| 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
 +
 +
}}
 +
<pre>{{Sidebar
 +
| topimage = [[File:Agent.png]]
 +
 +
| title = Sidebar title
 +
 +
| heading1 = Heading 1
 +
| content1 =
 +
* link 1
 +
* link 2
 +
 +
| heading2 = Heading 2
 +
| content2 =
 +
* link 3
 +
* link 4
 +
 +
| navbar = off
 +
 +
}}
 +
</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)
 +
 +
; See also

Revision as of 11:39, 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
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> 
content<x> 
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
* link 2

| heading2 = Heading 2
| content2 = 
* link 3
* link 4

| 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)
See also
Retrieved from "https://wiki.eveuniversity.org/index.php?title=User:Evon_R%27al/Sandbox_template/doc&oldid=204402"