Difference between revisions of "Template:Helpbox/doc"

From blackwiki
Jump to navigation Jump to search
imported>Sardanaphalus
m (→‎Parameters: semisub)
imported>Sardanaphalus
(replaced Helpbox in "Parameters" section with Generic template demo at /doc's start, headings/levels)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
<includeonly>{{Intricate template}}</includeonly>
 
<includeonly>{{Intricate template}}</includeonly>
 +
{{Generic template demo |title |group1 |list1 |group2 |list2 |list3={{longitem|{{{list3}}}<br/>''without {{{group3}}}''}} |list4=''ditto'' {{{list4}}} |group5<!--={{longitem|{{{group5}}}<br/>{{nobold|''without {{{list5}}}''}}}}--> |group6 |list6={{{list6}}}<br/>''...... etc ......'' |group20 |list20}}
 +
 
This template allows a help-related [[Wikipedia:Navigational templates|navigational template]] to be set up relatively quickly by supplying it with one or more lists of links.
 
This template allows a help-related [[Wikipedia:Navigational templates|navigational template]] to be set up relatively quickly by supplying it with one or more lists of links.
  
===Usage===
+
== Usual syntax ==
 +
 
 
<pre style="overflow:auto;">
 
<pre style="overflow:auto;">
 
{{Helpbox
 
{{Helpbox
| name    =  <!--or: | templatename = -->
+
| name    =  <!-- or: | templatename = -->
| title  =  <!--or, if templatename used: | name = -->
+
| title  =  <!-- or, if templatename used: | name = -->
  
 
| group1  =  
 
| group1  =  
Line 15: Line 18:
 
| list2  =  
 
| list2  =  
  
...
+
<!-- etc, to: -->
  
 
| group20 =  
 
| group20 =  
 
| list20  =  
 
| list20  =  
 +
 
}}
 
}}
 
</pre>
 
</pre>
  
===Parameters===
+
== Parameters ==
{{Helpbox
 
| title = {{{title}}}
 
| group1 = {{{group1}}}
 
| list1 = {{{list1}}}
 
| group2 = {{{group2}}}
 
| list2 = {{{list2}}}
 
| list3 = {{{list3}}} ''without {{{group3}}}''
 
| group4 = {{{group4}}}
 
| list4 = {{{list4}}}
 
}}
 
  
====Required====
+
===Required===
 
:; ''title'' &nbsp;{{nobold|(or, if ''templatename'' used (see below),}} ''name''{{nobold|)}}
 
:; ''title'' &nbsp;{{nobold|(or, if ''templatename'' used (see below),}} ''name''{{nobold|)}}
 
:: The template's title, centered at the top of the template.
 
:: The template's title, centered at the top of the template.
Line 40: Line 34:
 
:: (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 {{tag|div}}.  At least one ''list'' parameter is required. Each ''list{{semisub|n}}'' may be preceded by a corresponding ''group{{semisub|n}}'' parameter, if provided (see below). There is a limit of 20 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 {{tag|div}}.  At least one ''list'' parameter is required. Each ''list{{semisub|n}}'' may be preceded by a corresponding ''group{{semisub|n}}'' parameter, if provided (see below). There is a limit of 20 lists/groups in a template.
  
====Optional====
+
===Optional===
 
:; ''group{{semisub|n}}''
 
:; ''group{{semisub|n}}''
 
:: (i.e. ''group1'', ''group2'', etc.) If specified, text appears in a header displayed above ''list{{semisub|n}}''.
 
:: (i.e. ''group1'', ''group2'', etc.) If specified, text appears in a header displayed above ''list{{semisub|n}}''.
Line 48: Line 42:
 
:: The template's pagename, activating the inclusion of the {{smaller|V•T•E}} links in its bottom righthand corner. [[Template:Helpbox]]'s pagename, for example, is "Helpbox".
 
:: The template's pagename, activating the inclusion of the {{smaller|V•T•E}} links in its bottom righthand corner. [[Template:Helpbox]]'s pagename, for example, is "Helpbox".
  
===Example===
+
== Example ==
 +
 
 
{{Helpbox |width:17.5em
 
{{Helpbox |width:17.5em
 
| name = Helpbox/doc
 
| name = Helpbox/doc

Revision as of 17:52, 7 August 2014

  1. redirect Template:Parameter names example

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

Usual syntax

{{Helpbox
| name    =  <!-- or: | templatename = -->
| title   =  <!-- or, if templatename used: | name = -->

| group1  = 
| list1   = 

| group2  = 
| list2   = 

<!-- etc, to: -->

| group20 = 
| list20  = 

}}

Parameters

Required

title  (or, if templatename used (see below), name)
The template's title, centered at the top of the template.
listTemplate:Semisub
(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 listTemplate:Semisub may be preceded by a corresponding groupTemplate:Semisub parameter, if provided (see below). There is a limit of 20 lists/groups in a template.

Optional

groupTemplate:Semisub
(i.e. group1, group2, etc.) If specified, text appears in a header displayed above listTemplate:Semisub.
first unnamed parameter
Inline CSS for the template.
name  (or, if name used as above, templatename)
The template's pagename, activating the inclusion of the V•T•E links in its bottom righthand corner. Template:Helpbox's pagename, for example, is "Helpbox".

Example

{{Helpbox |width:17.5em
| name = Helpbox/doc
| class = plainlist
| title = [[:Category:Wikipedia policies|Wikipedia policy]]

| group1 = Article standards
| list1 =
*[[Wikipedia:Neutral point of view|Neutral point of view]]
*[[Wikipedia:Verifiability|Verifiability]]
*[[Wikipedia:No original research|No original research]]
*[[Wikipedia:Biographies of living persons|Biographies of living persons]]

| group2 = Working with others
| list2 =
*[[Wikipedia:Civility|Civility]]
*[[Wikipedia:Consensus|Consensus]]
*[[Wikipedia:No personal attacks|No personal attacks]]
*[[Wikipedia:Dispute resolution|Dispute resolution]]
*[[WP:LEGAL|No legal threats]]

| group3 = Global principles
| list3 =
*[[Wikipedia:What Wikipedia is not|What Wikipedia is not]]
*[[Wikipedia:Ignore all rules|Ignore all rules]]
}}