Template:Sock vote/doc

This is a documentation subpage for Template:Sock vote.
It may contain usage information, categories and other content that is not part of the original template page.

__EXPECTED_UNCONNECTED_PAGE__

Shortcut

{{Sockvote}}

Purpose

Comments made by a sock with no replies may simply be removed with an appropriate edit summary. If comments are part of an active discussion, they should be struck instead of removed. To use this template, first strike the sockpuppet's vote or comment and signature using <s>...</s>, then add this template to inform editors about the sockpuppet. You may optionally add your signature after the template.

Usage

The template takes up to three unnamed parameters, plus two named ones, and it changes both its wording and its icon depending on what you give it.

|1= is the sockpuppet investigation case name, normally the suspected master's username. It's used to build the "of X" wording and to link to the relevant SPI page. If no SPI page exists for that name, the "see investigation" bit just doesn't appear, so you don't need to check first.
|2= sets the confidence level, and this is what changes the icon:
- Leave it blank, or use anything unrecognised, for blocked (the default). Shows a red padlock icon (File:Sock block.svg).
- Use sus for suspected. Shows a grey people icon if it's a lone sockpuppet, or a different icon if parameter 3 marks it as a sockpuppeteer.
- Use con for confirmed. Uses the same red padlock icon as blocked, just with different wording.
- Use ban for banned. Shows File:Banned user.JPG instead, and links the word "banned" to WP:BAN.
|3= switches between "sockpuppet" and "sockpuppeteer" wording. Leave it blank and the template describes a sockpuppet, adding "of [parameter 1]" at the end. Fill in anything at all (traditionally master or eer, though the actual value doesn't matter) and it describes a sockpuppeteer instead, dropping the "of X" part, since here the account being tagged is itself the alleged mastermind, not a sock of someone else.
|sock= is optional and names the actual sock account being tagged. Without it, the template just states the status as a bare phrase (relying on the struck comment above to make clear whose comment it was). With it, the sentence spells this out in full, for example "User123 is a blocked sockpuppet of Example, see investigation." It goes right after the icon, before the status word.
|noinvest=yes hides the "see investigation" link even when the SPI page for parameter 1 exists.
|4= is for signing the comment using ~~~~.

Examples

Some examples covering the different combinations:

{{Sock vote}} → — Blocked sockpuppet Blocked sockpuppet.
{{Sock vote|Example}} → — Blocked sockpuppet Blocked sockpuppet of Example.
{{Sock vote|Example|sus}} → — Suspected sockpuppet of Example.
{{Sock vote|Example||master}} → — Blocked sockpuppeteer Blocked sockpuppeteer.
{{Sock vote|Example|sus|master}} → — Suspected sockpuppeteer.
{{Sock vote|Example|con}} → — Confirmed sockpuppet Confirmed sockpuppet of Example.
{{Sock vote|Example|con|eer}} → — Confirmed sockpuppeteer Confirmed sockpuppeteer.
{{Sock vote|Example|ban}} → — Banned sockpuppet Banned sockpuppet of Example.
{{Sock vote|Example|ban|master}} → — Banned sockpuppeteer Banned sockpuppeteer.
{{Sock vote|Example|sock=User123}} → — Blocked sockpuppet User123 is a blocked sockpuppet of Example.
{{Sock vote|Example|con|eer|sock=User123}} → — Confirmed sockpuppeteer User123 is a confirmed sockpuppeteer.
{{Sock vote|Example4}} → — Blocked sockpuppet Blocked sockpuppet of Example4. (the SPI page for User:Example4 doesn't exist, so the investigation link doesn't show up)
{{Sock vote|Example|noinvest=yes}} → — Blocked sockpuppet Blocked sockpuppet of Example. (forced to hide the SPI link for User:Example, despite one existing)

If you find yourself typing out the same combination of parameters 2 and 3 often, it may be worth using a wrapper template instead, such as {{Blocked sockpuppet}}, {{Confirmed sockpuppet}}, or {{Banned sockpuppet}}, which hard code those two parameters and just ask for the username (and, if needed, the sock's own name).

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.

Template Data

No description.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Sockpuppeteer name	`1`	The name of the sockpuppeteer (sock master) on whose name a SPI page is/will be opened. If themself the sockpuppeteer, put their username.	User	required
Status	`2`	Status of sockpuppet; suspected, confirmed, blocked Suggested values `sus` `suspected` `con` `confirmed` `blocked` Default blocked	String	suggested
Sockpuppeteer	`3`	Hides "sockpuppet of User:XYZ" part if the user is themself the sockpuppeteer (sock master) Suggested values `master` `eer` `sockpuppeteer` Default N/A	String	suggested
No investigation	`4` `noinvest`	Hides investigation page even if one exists	Boolean	optional

Template:Sock vote/doc

Contents

Purpose

Usage

Examples

See also

Usage

Syntax

States

Sub-groups

Collapsible sub-groups

Use of images

Categorising

Examples

Single line navbox with centered list

Navbox with standard footer

Navbox with styled footer

Multiple line navbox

Collapsed navbox

Plain navbox with Tnavbar

Plain navbox without Tnavbar

Complicated navbox

Preventing unwanted documentation

Template Data