Difference between revisions of "Template:Helpbox/doc"

From blackwiki
Jump to navigation Jump to search
imported>Uzume
imported>Vanisaac
m (clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other)
 
(9 intermediate revisions by 5 users not shown)
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 [[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-related [[Wikipedia:Navigation template|navigation 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    =  
+
| name    = <!-- or: | templatename = -->
 +
| title  =  <!-- or, if templatename used: | name = -->
  
|group1  =  
+
| group1  =  
|list1  =  
+
| list1  =  
  
|group2  =  
+
| group2  =  
|list2  =  
+
| list2  =  
  
...
+
<!-- etc, to: -->
  
|group10 =  
+
| group20 =  
|list10 =  
+
| list20 =  
}}</pre>
 
  
=== Parameters ===
+
}}
 +
</pre>
  
==== Mandatory ====
+
== Parameters ==
  
:; ''name''
+
===Required===
:: The name of the template appears centered in the top row of the table.
+
:; ''title'' &nbsp;{{nobold|(or, if ''templatename'' used (see below),}} ''name''{{nobold|)}}
 +
:: The template's title, centered at the top of the template.
 
: '''''list<sub>n</sub>'''''
 
: '''''list<sub>n</sub>'''''
:: (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 {{tag|div}}.  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 20 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>''.
:; first param
+
:; first unnamed parameter
:: inline [[CSS]] for the table
+
:: Inline [[CSS]] for the template.
 +
:; ''name'' &nbsp;{{nobold|(or, if ''name'' used as above,}} ''templatename''{{nobold|)}}
 +
:: 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".
  
=== Layout of table ===
+
== Example ==
  
Table generated by {{tl|helpbox}} parameters:
+
{{Helpbox |width:17.5em
{{helpbox
+
| name = Helpbox/doc
|name = {{{name}}}
+
| class = plainlist
|group1 = {{{group1}}}
+
| title = [[:Category:Wikipedia policies|Wikipedia policy]]
|list1 = {{{list1}}}
 
|group2 = {{{group2}}}
 
|list2 = {{{list2}}}
 
|list3 = {{{list3}}} ''without {{{group3}}}''
 
|group4 = {{{group4}}}
 
|list4 = {{{list4}}}
 
}}
 
{{-}}
 
  
=== Example ===
+
| group1 = Article standards
 
+
| list1 =
<pre style="overflow: auto">
 
{{helpbox|width:200px
 
|templatename=Helpbox/doc
 
|bodyclass=plainlist
 
|name=[[:Category:Wikipedia official policy|Wikipedia policy]]
 
|group1=Article standards
 
|list1=
 
 
*[[Wikipedia:Neutral point of view|Neutral point of view]]
 
*[[Wikipedia:Neutral point of view|Neutral point of view]]
 
*[[Wikipedia:Verifiability|Verifiability]]
 
*[[Wikipedia:Verifiability|Verifiability]]
 
*[[Wikipedia:No original research|No original research]]
 
*[[Wikipedia:No original research|No original research]]
 
*[[Wikipedia:Biographies of living persons|Biographies of living persons]]
 
*[[Wikipedia:Biographies of living persons|Biographies of living persons]]
|group2=Working with others
+
 
|list2=
+
| group2 = Working with others
 +
| list2 =
 
*[[Wikipedia:Civility|Civility]]
 
*[[Wikipedia:Civility|Civility]]
 
*[[Wikipedia:Consensus|Consensus]]
 
*[[Wikipedia:Consensus|Consensus]]
Line 73: Line 63:
 
*[[Wikipedia:Dispute resolution|Dispute resolution]]
 
*[[Wikipedia:Dispute resolution|Dispute resolution]]
 
*[[WP:LEGAL|No legal threats]]
 
*[[WP:LEGAL|No legal threats]]
|group3=Global principles
+
 
|list3=
+
| group3 = Global principles
 +
| list3 =
 
*[[Wikipedia:What Wikipedia is not|What Wikipedia is not]]
 
*[[Wikipedia:What Wikipedia is not|What Wikipedia is not]]
 
*[[Wikipedia:Ignore all rules|Ignore all rules]]
 
*[[Wikipedia:Ignore all rules|Ignore all rules]]
 
}}
 
}}
</pre>
 
  
{{helpbox|width:200px
+
<pre style="overflow:auto;">
|templatename=Helpbox/doc
+
{{Helpbox |width:17.5em
|bodyclass=plainlist
+
| name = Helpbox/doc
|name=[[:Category:Wikipedia official policy|Wikipedia policy]]
+
| class = plainlist
|group1=Article standards
+
| title = [[:Category:Wikipedia policies|Wikipedia policy]]
|list1=
+
 
 +
| group1 = Article standards
 +
| list1 =
 
*[[Wikipedia:Neutral point of view|Neutral point of view]]
 
*[[Wikipedia:Neutral point of view|Neutral point of view]]
 
*[[Wikipedia:Verifiability|Verifiability]]
 
*[[Wikipedia:Verifiability|Verifiability]]
 
*[[Wikipedia:No original research|No original research]]
 
*[[Wikipedia:No original research|No original research]]
 
*[[Wikipedia:Biographies of living persons|Biographies of living persons]]
 
*[[Wikipedia:Biographies of living persons|Biographies of living persons]]
|group2=Working with others
+
 
|list2=
+
| group2 = Working with others
 +
| list2 =
 
*[[Wikipedia:Civility|Civility]]
 
*[[Wikipedia:Civility|Civility]]
 
*[[Wikipedia:Consensus|Consensus]]
 
*[[Wikipedia:Consensus|Consensus]]
Line 97: Line 90:
 
*[[Wikipedia:Dispute resolution|Dispute resolution]]
 
*[[Wikipedia:Dispute resolution|Dispute resolution]]
 
*[[WP:LEGAL|No legal threats]]
 
*[[WP:LEGAL|No legal threats]]
|group3=Global principles
+
 
|list3=
+
| group3 = Global principles
 +
| list3 =
 
*[[Wikipedia:What Wikipedia is not|What Wikipedia is not]]
 
*[[Wikipedia:What Wikipedia is not|What Wikipedia is not]]
 
*[[Wikipedia:Ignore all rules|Ignore all rules]]
 
*[[Wikipedia:Ignore all rules|Ignore all rules]]
 
}}
 
}}
 +
</pre>
  
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
+
<includeonly>{{Sandbox other||
<!--Categories-->
 
[[Category:sidebar templates]]
 
[[Category:Wikipedia metatemplates|{{PAGENAME}}]]
 
  
<!--Other languages-->
+
[[Category:Wikipedia metatemplates]]
[[fa:الگو:جعبه‌راهنما]]
+
[[Category:Sidebar templates]]
[[ja:Template:Helpbox]]
+
}}
[[no:mal:Helpbox]]
 
[[pt:Predefinição:Helpbox]]
 
[[sl:Predloga:Helpbox]]
 
[[vi:Tiêu bản:Hộp trợ giúp]]
 
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 16:49, 25 April 2020

  1. redirect Template:Parameter names example

This template allows a help-related navigation 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.
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 20 lists/groups in a template.

Optional

groupn
(i.e. group1, group2, etc.) If specified, text appears in a header displayed above listn.
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]]
}}