Difference between revisions of "Template:Helpbox/doc"

From blackwiki
Jump to navigation Jump to search
imported>Kbdank71
(Remove category per per CFD 2008 August 20)
imported>Thumperward
(tidy this up)
Line 1: Line 1:
 
{{documentation subpage}}
 
{{documentation subpage}}
 
<includeonly>{{Intricate template}}</includeonly>
 
<includeonly>{{Intricate template}}</includeonly>
__NOTOC__
+
 
 
This template allows a help [[Wikipedia:Navigational templates|navigational template]] to be set up relatively quickly by supplying it one or more lists of links.
 
This template allows a help [[Wikipedia:Navigational templates|navigational template]] to be set up relatively quickly by supplying it one or more lists of links.
== Usage ==
+
 
<pre>{{helpbox
+
=== Usage ===
 +
 
 +
<pre style="overflow: auto">
 +
{{helpbox
 
|name    =  
 
|name    =  
  
Line 19: Line 22:
 
}}</pre>
 
}}</pre>
  
==Parameters==
+
=== Parameters ===
===Mandatory===
+
==== Mandatory ====
 +
 
 
:; ''name''
 
:; ''name''
 
:: The name of the template appears centred in the top row of the table.
 
:: The name of the template appears centred in the top row of the table.
Line 26: Line 30:
 
::  (i.e. ''list1'', ''list2'', etc.) The body of the template, usually a list of links. Format is inline, although the text can be entered on separate lines if the entire list is enclosed within <code><nowiki><div> </div></nowiki></code>.  At least one ''list'' parameter is required. Each ''list<sub>n</sub>'' may be preceded by a corresponding ''group<sub>n</sub>'' parameter, if provided (see below). There is a limit of 10 lists/groups in a template.
 
::  (i.e. ''list1'', ''list2'', etc.) The body of the template, usually a list of links. Format is inline, although the text can be entered on separate lines if the entire list is enclosed within <code><nowiki><div> </div></nowiki></code>.  At least one ''list'' parameter is required. Each ''list<sub>n</sub>'' may be preceded by a corresponding ''group<sub>n</sub>'' parameter, if provided (see below). There is a limit of 10 lists/groups in a template.
  
===Optional===
+
==== Optional ====
 +
 
 
:; ''group<sub>n</sub>''
 
:; ''group<sub>n</sub>''
 
:: (i.e. ''group1'', ''group2'', etc.) If specified, text appears in a header displayed above ''list<sub>n</sub>''.
 
:: (i.e. ''group1'', ''group2'', etc.) If specified, text appears in a header displayed above ''list<sub>n</sub>''.
Line 32: Line 37:
 
:: inline [[CSS]] for the table
 
:: inline [[CSS]] for the table
  
== Layout of table ==
+
=== Layout of table ===
 +
 
 
Table generated by {{tl|helpbox}} parameters:
 
Table generated by {{tl|helpbox}} parameters:
 
{{helpbox
 
{{helpbox
Line 45: Line 51:
 
}}
 
}}
 
{{-}}
 
{{-}}
== Example ==
 
  
<pre>
+
=== Example ===
 +
 
 +
<pre style="overflow: auto">
 
{{helpbox|width:200px;
 
{{helpbox|width:200px;
 
|name=[[:Category:Wikipedia official policy|Wikipedia policy]]
 
|name=[[:Category:Wikipedia official policy|Wikipedia policy]]
Line 73: Line 80:
 
|list3=
 
|list3=
 
[[Wikipedia:What Wikipedia is not|What Wikipedia is not]]<br />[[Wikipedia:Ignore all rules|Ignore all rules]]
 
[[Wikipedia:What Wikipedia is not|What Wikipedia is not]]<br />[[Wikipedia:Ignore all rules|Ignore all rules]]
}}<includeonly>
+
}}
 +
 
 +
<includeonly>
 +
{{pp-template|small=yes}}
 
<!--Categories-->
 
<!--Categories-->
 
[[Category:Navbox (navigational) templates]]
 
[[Category:Navbox (navigational) templates]]

Revision as of 15:33, 6 May 2009


This template allows a help navigational template to be set up relatively quickly by supplying it one or more lists of links.

Usage

{{helpbox
|name    = 

|group1  = 
|list1   = 

|group2  = 
|list2   = 

 ...

|group10 = 
|list10  = 
}}

Parameters

Mandatory

name
The name of the template appears centred in the top row of the table.
listn
(i.e. list1, list2, etc.) The body of the template, usually a list of links. Format is inline, although the text can be entered on separate lines if the entire list is enclosed within <div> </div>. At least one list parameter is required. Each listn may be preceded by a corresponding groupn parameter, if provided (see below). There is a limit of 10 lists/groups in a template.

Optional

groupn
(i.e. group1, group2, etc.) If specified, text appears in a header displayed above listn.
first param
inline CSS for the table

Layout of table

Table generated by {{helpbox}} parameters:

Example

{{helpbox|width:200px;
|name=[[:Category:Wikipedia official policy|Wikipedia policy]]
|group1=Article standards
|list1=
[[Wikipedia:Neutral point of view|Neutral point of view]]<br />[[Wikipedia:Verifiability|Verifiability]]<br />[[Wikipedia:No original research|No original research]]<br />[[Wikipedia:Biographies of living persons|Biographies of living persons]]
|group2=Working with others
|list2=
[[Wikipedia:Civility|Civility]]<br />[[Wikipedia:Consensus|Consensus]]<br />[[Wikipedia:No personal attacks|No personal attacks]]<br />[[Wikipedia:Dispute resolution|Dispute resolution]]<br/>[[WP:LEGAL|No legal threats]]
|group3=Global principles
|list3=
[[Wikipedia:What Wikipedia is not|What Wikipedia is not]]<br />[[Wikipedia:Ignore all rules|Ignore all rules]]
}}