Difference between revisions of "Template:Block notice/doc"

From blackwiki
Jump to navigation Jump to search
imported>Andrybak
(→‎Parameters: expand)
imported>Andrybak
(→‎Parameters: fix defaults)
Line 9: Line 9:
 
:Additional banners (aka [[:Category:Documentation header templates|header templates]]) to put at the top of documentation at the template page, like {{tl|Twinkle standard installation}}.
 
:Additional banners (aka [[:Category:Documentation header templates|header templates]]) to put at the top of documentation at the template page, like {{tl|Twinkle standard installation}}.
 
;{{para|temp or indef}}
 
;{{para|temp or indef}}
:Whether or not the template supports parameters {{para|time}} and {{para|indef|yes}}, which differentiate between temporary and indefinite blocks. Default is <code>yes</code>.
+
:Whether or not the template supports parameters {{para|time}} and {{para|indef|yes}}, which differentiate between temporary and indefinite blocks. Default is <code>no</code>.
  
 
=== Usage example parameters ===
 
=== Usage example parameters ===
 
;{{para|allow notalk}}
 
;{{para|allow notalk}}
:Whether or not the template supports parameter {{para|notalk}}, which indicates, whether the block includes revoking of the ability to edit own talk page or not.
+
:Whether or not the template supports parameter {{para|notalk}}, which indicates, whether the block includes revoking of the ability to edit own talk page or not. Default is <code>yes</code>.
 
;{{para|allow anon}}
 
;{{para|allow anon}}
:Whether or not the template supports parameter {{para|anon}}.
+
:Whether or not the template supports parameter {{para|anon}}. Default is <code>yes</code>.
 
;{{para|extra params}}
 
;{{para|extra params}}
 
:Wikitext for the additional parameters in the template's usage example. For example, <code><nowiki>{{!}}name{{=}}<var>value</var>{{!}}flag{{=}}yes</nowiki></code>.
 
:Wikitext for the additional parameters in the template's usage example. For example, <code><nowiki>{{!}}name{{=}}<var>value</var>{{!}}flag{{=}}yes</nowiki></code>.

Revision as of 14:27, 3 July 2020

Usage

Place this template at the bottom of block-notice template pages, inside of <noinclude> tags, such as:

<noinclude>{{Block notice|banners={{Twinkle standard installation}}}}</noinclude>

Parameters

|banners=
Additional banners (aka header templates) to put at the top of documentation at the template page, like {{Twinkle standard installation}}.
|temp or indef=
Whether or not the template supports parameters |time= and |indef=yes, which differentiate between temporary and indefinite blocks. Default is no.

Usage example parameters

|allow notalk=
Whether or not the template supports parameter |notalk=, which indicates, whether the block includes revoking of the ability to edit own talk page or not. Default is yes.
|allow anon=
Whether or not the template supports parameter |anon=. Default is yes.
|extra params=
Wikitext for the additional parameters in the template's usage example. For example, {{!}}name{{=}}<var>value</var>{{!}}flag{{=}}yes.

See also