Difference between revisions of "Template:Navbox/doc"

From EVE University Wiki
Jump to: navigation, search
m (Added group-less list example.)
m (Add dependencies.)
Line 1: Line 1:
;Description
+
; Description
:This template allows a [[:Category:Navigational templates|navigational template]] to be set up relatively quickly by supplying it one or more [[:Template:Flatlist|lists of links]].
+
: This template allows a [[:Category:Navigational templates|navigational template]] to be set up relatively quickly by supplying it one or more [[:Template:Flatlist|lists of links]].
:It comes equipped with default styles that should work for most navigational templates. Changing the default styles is not recommended, but is possible.
+
: It comes equipped with default styles that should work for most navigational templates. Changing the default styles is not recommended, but is possible.
;Dependencies:
+
 
:* [[Template:NavboxCSS]]
+
; Dependencies:
:* [[Template:Navbar]]
+
:; Uses
;Syntax
+
:: {{T|NavboxCSS}}
 +
:: {{T|Navbar}}
 +
:; Used by
 +
:: {{T|AnomicMissionNav}}
 +
:: {{T|COREClassNav}}
 +
:: {{T|EVEUniversityNav}}
 +
:: {{T|EWAR Links}}
 +
:: {{T|GasNebulaeNav}}
 +
:: {{T|GettingStartedNav}}
 +
:: {{T|Incursions sites horizontal}}
 +
:: {{T|Limited time events}}
 +
:: {{T|Mining Links}}
 +
:: {{T|Missionrelated}}
 +
:: {{T|UniWikiNav}}
 +
 
 +
; Syntax
 
<pre>{{Navbox
 
<pre>{{Navbox
|name = {{subst:PAGENAME}}
+
|name           = {{subst:PAGENAME}}
|title =  
+
|title           =  
|titleclass =  
+
|titleclass     =  
|state =
+
|state           =
|bodyclass =  
+
|bodyclass       =  
|bodystyle =
+
|bodystyle       =
|innerstyle =
+
|innerstyle     =
|basestyle =
+
|basestyle       =
|titlestyle =
+
|titlestyle     =
|groupstyle =  
+
|groupstyle     =  
 
|titlegroupstyle =
 
|titlegroupstyle =
|image =  
+
|image           =  
|imagestyle =
+
|imagestyle     =
|imageleft =
+
|imageleft       =
|imageleftstyle =
+
|imageleftstyle =
|above =  
+
|above           =  
|abovestyle =
+
|abovestyle     =
|liststyle =
+
|liststyle       =
  
|group1 =  
+
|group1         =  
|list1 =  
+
|list1           =  
  
|group2 =  
+
|group2         =  
|list2 =  
+
|list2           =  
 
  ...
 
  ...
|group20 =  
+
|group20         =  
|list20 =  
+
|list20         =  
  
|below =  
+
|below           =  
|belowstyle =
+
|belowstyle     =
 
}}</pre>
 
}}</pre>
 +
 
; Parameters
 
; Parameters
The only mandatory parameters are <code>name</code>, <code>title</code> and <code>list1</code>. Use all style parameters sparingly!
+
: The only mandatory parameters are <code>name</code>, <code>title</code> and <code>list1</code>. Use all style parameters sparingly!
:<code>name</code>
+
:; name : The name of the template. Set to <nowiki>{{subst:PAGENAME}}</nowiki> by default.
:: The name of the template. Set to <nowiki>{{subst:PAGENAME}}</nowiki> by default.
+
:; title : Text in the title bar.
:<code>title</code>
+
:; titleclass : Applies an CSS <code>class</code> to the title bar. Use sparingly!
:: Text in the title bar.
+
:; state = [autocollapse, collapsed, expanded, plain, off]</code> : The status of box expansion. Use sparingly!
:<code>titleclass</code>
 
:: Applies an HTML <code>class</code> attribute to the title bar. Use sparingly!
 
:<code>state = [autocollapse, collapsed, expanded, plain, off]</code>
 
:: The status of box expansion. Use sparingly!
 
 
::* Defaults to <code>autocollapse</code>. A navbox with <code>autocollapse</code> will start out collapsed if there are two or more tables on the same page that use other collapsible tables. Otherwise, the navbox will be expanded.
 
::* Defaults to <code>autocollapse</code>. A navbox with <code>autocollapse</code> will start out collapsed if there are two or more tables on the same page that use other collapsible tables. Otherwise, the navbox will be expanded.
 
::* If set to <code>collapsed</code>, the navbox will always start out in a collapsed state.
 
::* If set to <code>collapsed</code>, the navbox will always start out in a collapsed state.
Line 53: Line 65:
 
::* If set to <code>plain</code>, the navbox will always be expanded with no [hide] link on the right, and the title will remain centered.
 
::* If set to <code>plain</code>, the navbox will always be expanded with no [hide] link on the right, and the title will remain centered.
 
::* If set to <code>off</code>, the navbox will always be expanded with no [hide] link on the right, but no padding will be used to keep the title centered. This is for advanced use only; the "plain" option should suffice for most applications where the [show]/[hide] button needs to be hidden.
 
::* If set to <code>off</code>, the navbox will always be expanded with no [hide] link on the right, but no padding will be used to keep the title centered. This is for advanced use only; the "plain" option should suffice for most applications where the [show]/[hide] button needs to be hidden.
:<code>bodyclass</code>
+
:; bodyclass : Applies an CSS<code>class</code> to the entire navbox. Use sparingly!
:: Applies an HTML <code>class</code> attribute to the entire navbox. Use sparingly!
+
:; titlestyle : A CSS style for the title-bar, such as: <code>background:gray;</code> Use sparingly!
:<code>titlestyle</code>
+
:; groupstyle : A CSS style for the group-cells, such as: <code>background:#EEEEEE;</code> Use sparingly!
:: A CSS style for the title-bar, such as: <code>background:gray;</code> Use sparingly!
+
:; image : An optional right-side image, coded as the whole image. Typically it is purely decorative, so it should be coded as <code><nowiki>[[File:</nowiki><var>XX</var><nowiki>.jpg|90px|link=|alt=]]</nowiki></code>. Use sparingly!
:<code>groupstyle</code>
+
:; imageleft : An optional left-side image (code the same as the "image" parameter). Use sparingly!
:: A CSS style for the group-cells, such as: <code>background:#eee;</code> Use sparingly!
+
:; above : Text to appear above the group/list section (could be a list of overall wikilinks).
:<code>image</code>
+
:; group<sub>n</sub> : The left-side text before list-n (if group-n omitted, list-n starts at left of box).
:: An optional right-side image, coded as the whole image. Typically it is purely decorative, so it should be coded as <code><nowiki>[[File:</nowiki><var>XX</var><nowiki>.jpg|90px|link=|alt=]]</nowiki></code>. Use sparingly!
+
:; list<sub>n</sub> : Text listing links. See [[Template:Flatlist]].
:<code>imageleft</code>
+
:; below : Optional text to appear below the group/list section.
:: An optional left-side image (code the same as the "image" parameter). Use sparingly!
+
 
:<code>above</code>
+
;Sample
:: Text to appear above the group/list section (could be a list of overall wikilinks).
 
:<code>group<sub>n</sub></code>
 
:: The left-side text before list-n (if group-n omitted, list-n starts at left of box).
 
:<code>list<sub>n</sub></code>
 
:: Text listing links. See [[Template:Flatlist]].
 
:<code>below</code>
 
:: Optional text to appear below the group/list section.
 
;Sample output
 
 
<pre>
 
<pre>
 
{{Navbox
 
{{Navbox
Line 136: Line 140:
 
|below = Text written below the link lists.
 
|below = Text written below the link lists.
 
}}
 
}}
;See also:
+
 
 +
; See also:
 
:* [[Template:Flatlist]]
 
:* [[Template:Flatlist]]
 
:* [https://en.wikipedia.org/wiki/Template:Navbox Wikipedia Navbox]
 
:* [https://en.wikipedia.org/wiki/Template:Navbox Wikipedia Navbox]

Revision as of 14:18, 20 June 2022

Description
This template allows a navigational template to be set up relatively quickly by supplying it one or more lists of links.
It comes equipped with default styles that should work for most navigational templates. Changing the default styles is not recommended, but is possible.
Dependencies
Uses
{{NavboxCSS}}
{{Navbar}}
Used by
{{AnomicMissionNav}}
{{COREClassNav}}
{{EVEUniversityNav}}
{{EWAR Links}}
{{GasNebulaeNav}}
{{GettingStartedNav}}
{{Incursions sites horizontal}}
{{Limited time events}}
{{Mining Links}}
{{Missionrelated}}
{{UniWikiNav}}
Syntax
{{Navbox
|name            = {{subst:PAGENAME}}
|title           = 
|titleclass      = 
|state           =
|bodyclass       = 
|bodystyle       =
|innerstyle      =
|basestyle       =
|titlestyle      =
|groupstyle      = 
|titlegroupstyle =
|image           = 
|imagestyle      =
|imageleft       =
|imageleftstyle  =
|above           = 
|abovestyle      =
|liststyle       =

|group1          = 
|list1           = 

|group2          = 
|list2           = 
 ...
|group20         = 
|list20          = 

|below           = 
|belowstyle      =
}}
Parameters
The only mandatory parameters are name, title and list1. Use all style parameters sparingly!
name
The name of the template. Set to {{subst:PAGENAME}} by default.
title
Text in the title bar.
titleclass
Applies an CSS class to the title bar. Use sparingly!
state = [autocollapse, collapsed, expanded, plain, off]
The status of box expansion. Use sparingly!
  • Defaults to autocollapse. A navbox with autocollapse will start out collapsed if there are two or more tables on the same page that use other collapsible tables. Otherwise, the navbox will be expanded.
  • If set to collapsed, the navbox will always start out in a collapsed state.
  • If set to expanded, the navbox will always start out in an expanded state.
  • If set to plain, the navbox will always be expanded with no [hide] link on the right, and the title will remain centered.
  • If set to off, the navbox will always be expanded with no [hide] link on the right, but no padding will be used to keep the title centered. This is for advanced use only; the "plain" option should suffice for most applications where the [show]/[hide] button needs to be hidden.
bodyclass
Applies an CSSclass to the entire navbox. Use sparingly!
titlestyle
A CSS style for the title-bar, such as: background:gray; Use sparingly!
groupstyle
A CSS style for the group-cells, such as: background:#EEEEEE; Use sparingly!
image
An optional right-side image, coded as the whole image. Typically it is purely decorative, so it should be coded as [[File:XX.jpg|90px|link=|alt=]]. Use sparingly!
imageleft
An optional left-side image (code the same as the "image" parameter). Use sparingly!
above
Text to appear above the group/list section (could be a list of overall wikilinks).
groupn
The left-side text before list-n (if group-n omitted, list-n starts at left of box).
listn
Text listing links. See Template:Flatlist.
below
Optional text to appear below the group/list section.
Sample
{{Navbox
|name = {{subst:PAGENAME}}
|title = Navigational box title
|above = Text written below the title and above the link lists.

|group1 = Group One
|list1 = {{flatlist|
* [[EVE University]]
* [[EVE University Management]]
* [[EVE University Rules]]
}}

|group2 = Group Two
|list2 = {{flatlist|
# [[EVE University]]
# [[EVE University Management]]
# [[EVE University Rules]]
}}

|group20 = Group Twenty
|list20 = {{flatlist|
* [[EVE University]]
** [[EVE University Management]]
** [[EVE University Rules]]
}}

|below = Text written below the link lists.
}}
gives...
See also