Difference between revisions of "Template:Navbox/doc"

From EVE University Wiki
Jump to: navigation, search
(Wrote docs except for examples)
m (Update dependencies.)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Update|Ancient documentation. Poke Wiki Manager [[User:Arin Mara|Arin Mara]] ([[User talk:Arin Mara|talk]]) 19:44, 11 April 2022 (UTC).}}
+
; 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:
+
; Dependencies:
:* [[Template:NavboxCSS]]
+
:; Uses
;Syntax
+
:: {{T|NavboxCSS}}
 +
:: CSS class nowraplinks in [[MediaWiki:Common.css|Common.css]]
 +
:: {{T|Navbar}}
 +
:; Used by
 +
:: {{T|AnomicMissionNav}}
 +
:: {{T|COREClassNav}}
 +
:: {{T|EVEUniversityNav}}
 +
:: {{T|EWAR Links}}
 +
:: {{T|FactionsNav}}
 +
:: {{T|GasNebulaeNav}}
 +
:: {{T|GettingStartedNav}}
 +
:: {{T|Incursions sites horizontal}}
 +
:: {{T|Limited time events}}
 +
:: {{T|Mining Links}}
 +
:: {{T|Missionrelated}}
 +
:: {{T|UniWikiNav}}
 +
 
 +
; Syntax
 
<pre>{{Navbox
 
<pre>{{Navbox
|bodyclass =
+
|name           = {{subst:PAGENAME}}
|name = {{subst:PAGENAME}}
+
|navbar          =
|title =  
+
|title           =  
|titleclass =  
+
|titleclass     =  
|state =
+
|state           =
|titlestyle =
+
|bodyclass      =
|groupstyle =  
+
|bodystyle      =
|image =  
+
|innerstyle      =
|imageleft =
+
|basestyle      =
|above =  
+
|titlestyle     =
 +
|groupstyle     =
 +
|titlegroupstyle =
 +
|image           =
 +
|imagestyle      =
 +
|imageleft       =
 +
|imageleftstyle  =
 +
|above           =
 +
|abovestyle      =
 +
|liststyle      =
  
|group1 =  
+
|group1         =  
|list1 =  
+
|list1           =  
  
|group2 =  
+
|group2         =  
|list2 =  
+
|list2           =  
 
  ...
 
  ...
|group20 =  
+
|group20         =  
|list20 =  
+
|list20         =  
  
|below =  
+
|below           =
 +
|belowstyle      =
 
}}</pre>
 
}}</pre>
 +
 
; Parameters
 
; Parameters
The only mandatory parameters are <code>name</code>, <code>title</code> and <code>list1</code>.
+
: The only mandatory parameters are <code>title</code> and <code>list1</code>. Use all class and style parameters sparingly!
:<code>bodyclass</code>
+
:; name : The name of the template. Set to <nowiki>{{subst:PAGENAME}}</nowiki> by default. used for the (v)iew, (t)alk and (e)dit link options. May be omitted when navbar is set to plain.
:: Applies an HTML <code>class</code> attribute to the entire navbox. Use sparingly!
+
:; navbar : Controls the presence of the (v)iew, (t)alk and (e)dit link options. Use <code>plain</code> to suppress.
:<code>name</code>
+
:; title : Text in the title bar.
:: The name of the template. Set to <nowiki>{{subst:PAGENAME}}</nowiki> by default.
+
:; titleclass : Applies an CSS <code>class</code> to the title bar. Use sparingly!
:<code>title</code>
+
:; state = [autocollapse, collapsed, expanded, plain, off]</code> : The status of box expansion. Use sparingly!
:: Text in the title bar.
 
:<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 46: Line 69:
 
::* 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>titlestyle</code>
+
:; bodyclass : Applies an CSS<code>class</code> to the entire navbox. Use sparingly!
:: A CSS style for the title-bar, such as: <code>background:gray;</code> Use sparingly!
+
:; titlestyle : A CSS style for the title-bar, such as: <code>background:gray;</code> Use sparingly!
:<code>groupstyle</code>
+
:; groupstyle : A CSS style for the group-cells, such as: <code>background:#EEEEEE;</code> Use sparingly!
:: A CSS style for the group-cells, such as: <code>background:#eee;</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>image</code>
+
:; imageleft : An optional left-side image (code the same as the "image" parameter). Use sparingly!
:: 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!
+
:; above : Text to appear above the group/list section (could be a list of overall wikilinks).
:<code>imageleft</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 left-side image (code the same as the "image" parameter). Use sparingly!
+
:; list<sub>n</sub> : Text listing links. See [[Template:Flatlist]].
:<code>above</code>
+
:; below : Optional text to appear below the group/list section.
:: Text to appear above the group/list section (could be a list of overall wikilinks).
+
 
:<code>group<sub>n</sub></code>
+
;Sample
:: The left-side text before list-n (if group-n omitted, list-n starts at left of box).
+
<pre>
:<code>list<sub>n</sub></code>
+
{{Navbox
:: Text listing links. See [[Template:Flatlist]].
+
|name = {{subst:PAGENAME}}
:<code>below</code>
+
|title = Navigational box title
:: Optional text to appear below the group/list section.
+
|above = Text written below the title and above the link lists.
;Sample output
+
 
:<code><nowiki>{{templatename|foo1<!-- delete if N/A -->|foo2=<!-- delete if N/A -->}}</nowiki></code>
+
|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.
 +
}}
 +
</pre>
 
::gives...
 
::gives...
{{templatename|foo1<!-- delete if N/A -->|foo2=<!-- delete if N/A -->}}
+
{{Navbox
;See also:
+
|name = Navbox/doc
 +
|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]]
 +
}}
 +
 
 +
|list3 = {{flatlist|
 +
* ''list3''
 +
* ''(without group3)''
 +
}}
 +
 
 +
|group20 = Group Twenty
 +
|list20 = {{flatlist|
 +
* [[EVE University]]
 +
** [[EVE University Management]]
 +
** [[EVE University Rules]]
 +
}}
 +
 
 +
|below = Text written below the link lists.
 +
}}
 +
 
 +
; See also:
 
:* [[Template:Flatlist]]
 
:* [[Template:Flatlist]]
 
:* [https://en.wikipedia.org/wiki/Template:Navbox Wikipedia Navbox]
 
:* [https://en.wikipedia.org/wiki/Template:Navbox Wikipedia Navbox]
  
<includeonly>[[Category:Navigational templates]]</includeonly>
+
<includeonly>[[Category:Navbox templates]]</includeonly>
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 12:49, 8 July 2024

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}}
CSS class nowraplinks in Common.css
{{Navbar}}
Used by
{{AnomicMissionNav}}
{{COREClassNav}}
{{EVEUniversityNav}}
{{EWAR Links}}
{{FactionsNav}}
{{GasNebulaeNav}}
{{GettingStartedNav}}
{{Incursions sites horizontal}}
{{Limited time events}}
{{Mining Links}}
{{Missionrelated}}
{{UniWikiNav}}
Syntax
{{Navbox
|name            = {{subst:PAGENAME}}
|navbar          = 
|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 title and list1. Use all class and style parameters sparingly!
name
The name of the template. Set to {{subst:PAGENAME}} by default. used for the (v)iew, (t)alk and (e)dit link options. May be omitted when navbar is set to plain.
navbar
Controls the presence of the (v)iew, (t)alk and (e)dit link options. Use plain to suppress.
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