Template:Hidden ping

Template documentation follows
Note: the template above may sometimes be partially or fully invisible.
Visit "Template:Hidden ping/doc" to edit its documentation if it is available. (How does this work?)

This template is used to trigger a notification to one or several registered user(s) you are replying to in a discussion without displaying any text. The notification will only work successfully if you sign your post in the same edit in which you use this template. If you make a mistake in placing this template or in signing, see Help:Fixing failed pings. It is an alternative to the {{Reply to}} template. It works on any talk page or Wikipedia namespace page.

For transparency reasons, please be cautious and judicious when using this template, and make sure you are familiar with the guideline on canvassing.

Usage

{{Hidden ping|Username}}Message text. ~~~~

The edit that adds this template must be signed with new signature tildes at a minimum, or the notification(s) will not work. See Wikipedia:Notifications and mw:Help:Echo § Technical details for more information.

It is not necessary to use this template to ping the user if you are already linking to the username from your post, neither is it necessary when posting on their own talk page.

Single recipient

Use the following syntax:

{{Hidden ping|Username}}Message text. ~~~~

For example, {{hidden ping|Jimbo Wales}}This is a message that Jimbo might be interested in. would display "​This is a message that Jimbo might be interested in." and notify Jimbo Wales.

The comment must be signed and belong to a named section of a "Talk" or "Wikipedia" namespace page in order for the notification to work.

Multiple recipients

You can reply to up to 50 people at once. Use the following syntax:

{{hidden ping|User1|User2|User3|User4|User5|User6|User7|User8|User9|User10|...}}Message text. ~~~~

For example, {{hidden ping|Example|Jimbo Wales}} would notify User:Example and User:Jimbo Wales if used in a signed comment.

Warning: If the total number of detected to-be-pinged users in an edit exceeds 50, no notifications will be delivered. An error message will be displayed when previewing the page, but not once the page has been saved.

Error messages

As the intention of this template is that it not produce any output, error messages are only displayed when previewing a page. Once the page has been saved, this template will not display any output.

This error indicates that one or more of the usernames specified contained a character that is not allowed in Wikipedia usernames.

This indicates that no usernames were specified. This error can also be produced when the recipient's username contains an equal sign, for example {{hidden ping|test=test}}. To fix this, simply add 1= at the beginning of the username, 2= at the second username, 3= at the third username and so on: {{hidden ping|1=test=test}}

If the total number of detected to-be-pinged users in an edit exceeds 50, no notifications will be delivered. An error message will be displayed when previewing the page, but not once the page has been saved. This is a limitation of the Echo software that provides the notifications (as of August 2015).

See also

• Module:Hidden ping – the Lua module on which this template is based
• {{Reply to}} – Links to one or more users names preceded by the @ sign and followed by a colon
• {{user link}} – Links to a single user's page (without the @ sign and colon)
• {{no ping}} – Links a user's name without triggering the echo notification system
• {{to}} – Uses "To " (with a space) at the beginning instead of the @ sign
• {{talkback}} – Allows a user to direct the attention of another user to a discussion via a notification
• Manual:Echo – the manual page for the underlying Echo feature that provides the notifications
• Help:Fixing failed pings

Template:Hidden ping invokes Module:Navbox using Lua.

Usage

This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.

The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.

Syntax

{{navbox
|state      = uncollapsed, collapsed, plain, autocollapse (default)
|name       = mandatory - name of the template
|style      = optional - style for the whole table
|title      = mandatory - navbox header
|gtitleN    = optional - title of N-th group of items
|styleN     = optional - style for groupN; i.e. text-align
|groupN     = mandatory - list of groups of items
|fstyle     = optional - style for footer ; i.e. text-align
|footer     = optional - navbox footer
}}

• Groups: Currently there is no technical limit to the maximum number of groups.
  • Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
• Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
• Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
  • Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
• Line breaks: Line-breaks (<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN.
• Bullets: Create unordered lists with lines beginning with *.
• Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! ({{!}}).

States

• Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
  • Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
• Uncollapsed: Forces the navbox to be displayed.
  • All of the navboxes in this documentation are in the uncollapsed state.
• Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
  • Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
• Plain: Removes the "show/hide" link.

Sub-groups

• For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
• To create sub-groups within {{navbox}}, certain parameters are to be included:
  • The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
  • The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.

{{navbox
|name    =
|title   =
|gtitle1 =
|group1  =
|gtitle2 =  
|gtype2  = Subgroup (mandatory)
|group2  = 
  {{navbox
  |subgroup = yes (mandatory)
  |gtitle1  = 
  |group1   =
  |gtitle2  = 
  |group2   = 
  }}
}}

Collapsible sub-groups

• For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
• To create collapsible sub-groups within {{navbox}}, these parameters need to be included:
  • The parent navbox is almost always uncollapsed (state=uncollapsed).
  • The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
  • The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
  • The nested collapsible navbox is forcefully collapsed (state=collapsed).

{{navbox
|state  = uncollapsed
|name   = 
|gtype1 = Subgroup
|group1 = 
  {{navbox
  |collapsible = yes
  |state   = collapsed
  |title   = 
  |gtitle1 = 
  |group1  = 
  |gtitle2 = 
  |group2  = 
  }}
}}

Use of images

• The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
• Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.

Link and file share the same name

{{plink|Item}}

File name differs from the link

{{plink|Item|File}}

Link and file share the same name, but different text is desired to display

{{plink|Item|alt=Text}}

File name differs from the link and different text is desired to display

{{plink|Item|File|alt=Text}}

Categorising

Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.

There are 2 methods of categorising pages with navboxes:

The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.

Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.

Examples

To see the following navboxes in action, see Template:Navbox.

Single line navbox with centered list

{{navbox
|name    = 
|title   = 
|style1  = text-align:center
|group1  =
}}

Navbox with standard footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|footer  = Centered footer
}}

Navbox with styled footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|fstyle  = text-align:right
|footer  = Right-aligned footer
}}

Multiple line navbox

{{navbox
|name    = 
|title   = 
|gtitle1 = Group title 1
|group1  = 
|gtitle2 = Group title 2
|group2  = 
|gtitle3 = Group title 3
|group3  = 
}}

Collapsed navbox

{{navbox
|state   = collapsed
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox with Tnavbar

{{navbox
|state   = plain
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox without Tnavbar

{{navbox
|state   = plain
|title   = 
|style1  = text-align:center
|group1  = 
}}

Complicated navbox

{{navbox
|state   = uncollapsed
|name    = 
|title   = 
|gtitle1 = Level 1 Title 1
|group1  = 
|gtitle2 = Level 1 Title 2
|group2  = 
|gtitle3 = Level 1 Title 3
|group3  = 
|gtitle4 = Level 1 Title 4
|group4  = 
|gtitle5 = Level 1 Title 5
|gtype5  = Subgroup
|group5  = 
  {{navbox
  |subgroup = Yes
  |gtitle1  = Level 2 Title 1
  |group1   =
  |gtitle2  = Level 2 Title 2
  |group2   =
  |gtitle3  = Level 2 Title 3
  |gtype3   = Subgroup
  |group3   = 
    {{navbox
    |subgroup = Yes
    |gtitle1  = Level 3 Title 1
    |group1   =
    |gtitle2  = Level 3 Title 2
    |group2   =
    }}
  |gtitle4  = Level 2 Title 4
  |group4   = 
  }}
|gtitle6 = Level 1 Title 6
|group6  = 
|gtitle7 = Level 1 Title 7
|group7  = 
|fstyle  = 
|footer  = 
}}

Preventing unwanted documentation

The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).

Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Hidden ping in articles based on its TemplateData.

TemplateData for Hidden ping

Trigger a notification to one or several registered user(s) you are replying to in a discussion without displaying any text.

Template parameters[Edit template data]

Parameter		Description	Type	Status
Username	1	The name of a user that you want to notify	User	required
Additional username	2	The name of an additional user you want to notify	User	optional
Additional username	3	The name of an additional user you want to notify	User	optional
Additional username	4	The name of an additional user you want to notify	User	optional
Additional username	5	The name of an additional user you want to notify	User	optional
Additional username	6	The name of an additional user you want to notify	User	optional
Additional username	7	The name of an additional user you want to notify	User	optional
Additional username	8	The name of an additional user you want to notify	User	optional
Additional username	9	The name of an additional user you want to notify	User	optional
Additional username	10	The name of an additional user you want to notify	User	optional