View source for Template:Sock list/doc

{{Documentation subpage}}
{{Lua|Module:Sock list}}
== Usage ==
Create a list of suspected sockpuppets for an [[WP:SPI|SPI]] report. Supports an arbitrary number of users. Usernames get wrapped in {{tl|checkuser}} or {{tl|checkip}} as applicable, and editor interaction tool links are generated for all listed users.

<code><nowiki>{{sock list|Example|Example2|2601:1223:5679:BCD:D75:9A71:3A10:B794|2600:8804::/32|8.8.8.8|8.8.4.0/24|127.0.0.1|tools_link=yes}}</nowiki></code>

{{sock list|Example|Example2|2601:1223:5679:BCD:D75:9A71:3A10:B794|2600:8804::/32|8.8.8.8|8.8.4.0/24|127.0.0.1|tools_link=yes}}

=== Parameters ===
* {{param|tools_link}} is a {{tl|yesno}} parameter determining whether to include the "Tools" link at the end of the sockpuppet list. It is false by default.
* If the suspected sockmaster is something other than the current subpage name, {{param|master}} can be set accordingly.
* {{param|hidden}} is a {{tl|yesno}} parameter determining whether the list should be hidden (<code>visibility:none;</code>). This can be useful if one wants to create a list of sox that tools like SPIhelper and spi-tools will pick up, but which won't clutter up the page, perhaps because they've all already been mentioned.
* {{param|remove_master}} is a {{tl|yesno}} parameter determining whether to remove the master's name if it shows up in the sock list.
* {{param|template}} provides a template to be used in place of {{tlf|checkuser}} and {{tlf|checkip}}. {{param|account_template}} overrides just the former; {{param|IP_template}} overrides just the latter.
* {{param|strike1}}, {{param|strike2}}, etc., are {{tlf|yesno}} parameters that can be used to strike out a name in the sock list, based on the number that sock appears at in the template's markup. This is often done if an account is renamed.
* {{param|note1}}, {{param|note2}}, etc., can be used to add a note after a name in the sock list, based on the number that sock appears at in the template's markup. This is often done if a case is moved, to indicate the original mover.

=== Full demonstration ===
To see a few of these parameters in action together, <code><nowiki>{{sock list|Example|Example2|2601:1223:5679:BCD:D75:9A71:3A10:B794|Example male|2601:1223:5679:BCD:D75:9A71:3A10:B794|2600:8804::/32|8.8.8.8|8.8.4.0/24|127.0.0.1|Example female|tools_link=yes|master=Example|remove_master=yes|strike3=yes|note3=renamed|note6=({{clerk note}} Original case name)}}</nowiki></code> becomes
{{sock list|Example|Example2|2601:1223:5679:BCD:D75:9A71:3A10:B794|Example male|2600:8804::/32|8.8.8.8|8.8.4.0/24|127.0.0.1|Example female|tools_link=yes|master=Example|remove_master=yes|strike3=yes|note3=renamed|note6=({{clerk note}} Original case name)}}

<includeonly>{{sandbox other||
<!-- Categories below this line -->

}}</includeonly>