Template:NonSpamEmail/doc

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

This template may be used in a file's description (in the "Author" field, "Source" field, or some other field), on a user page, on a user talk page, or anywhere else on Commons to allow a person's posted email address there to be unreadable by Internet tools which troll Commons looking for addresses to which to send SPAM email as it prevents the address from appearing as a clickable link. Any editor may place this template. The template has two parameters for the account and domain name, but it can also be simply placed between the two, like account{{@}}example.com.

Usage

Or use the shorthand {{NoSpam}} , {{Email}}, {{@}}

Template parameters

Parameter text is empty

<templatedata>JSON</templatedata> ./. {{TemplateBox}}

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either useTemplateData=1 or useTemplateData=only on the /doc subpage and transcluding it with {{Documentation}} into the template. <nowiki>...</nowiki>-tags can be wrapped around the the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw <templatedata>-tags into the Wikitext or the template as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.

Wikipedia's help about TemplateData • Commons-specific information

This template may be used in a file's description (in the "Author" field, "Source" field, or some other field), on a user page, on a user talk page, or anywhere else on Commons to allow a person's posted email address there to be unreadable by Internet tools which troll Commons looking for addresses to which to send SPAM email as it prevents the address from appearing as a clickable link. Any editor may place this template. The template has two parameters for the account and domain name, but it can also be simply placed between the two, like account{{@}}example.com.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
account	`1`	Account name of the address (the part before the at sign)	Line	optional
domain	`2`	Domain name of the address (the part after the at sign)	Line	optional

Additional information

The template is intended to be used in the following namespaces: all namespaces

The template is intended to be used by the following user groups: all users

Example

{{NonSpamEmail|account|example.com}}

renders as:

accountexample.com

Localization

This template is not intended to be localized.