Template:No spam/doc - Revision history

SockyPaws: Fix duplicate template parameters

2025-08-26T06:50:04Z

Fix duplicate template parameters

← Older revision		Revision as of 06:50, 26 August 2025
Line 1:		Line 1:
	{{Documentation subpage}}		{{Documentation subpage}}
	The {{Template link general\|plaincode=on\|No spam}} template is designed to help prevent spam from being sent to email addresses which are part of the content of wiki pages. As nearly all email address harvesting for these purposes is automated,<ref name="pearce">{{Cite book\|last=Pearce\|first=Robyn\|date=January 2006\|title=About Time for Teaching: 120 Time-Saving Tips for Teachers and Those Who Support Them\|url=https://robynpearce.com/products/about-time-for-teachers\|publisher=Getting a Grip Publishing\|place=Auckland\|page=137\|oclc=156759530\|isbn=978-0-7900-1044-1\|access-date=2024-08-10\|df=mdy-all}}</ref> altering the format of the email address to where it does not match the [[wikipedia:Regular expression\|regular expression]](s) used by the tools which scrape them from web page content helps prevent spam. It works by displaying an ''image'' of the '@' symbol instead of the typographical "Commercial At" symbol ([[wikipedia:Unicode\|Unicode]] U+0040<ref name="U0040">The Unicode Consortium ({{#formatdate:2023-09-12\|ymd}}). [https://www.unicode.org/charts/PDF/U0000.pdf The Unicode Standard, Version 15.1, ''C0 Controls and Basic Latin'']. Accessed {{#formatdate:2024-08-10\|mdy}}.</ref>). This prevents automated search engines and crawlers that use the '@' symbol to detect email addresses from identifying them here, preventing their retrieval and addition to any spam recipient lists.		The {{Template link general\|bold=on\|plaincode=on\|No spam}} template is designed to help prevent spam from being sent to email addresses which are part of the content of wiki pages. As nearly all email address harvesting for these purposes is automated,<ref name="pearce">{{Cite book\|last=Pearce\|first=Robyn\|date=January 2006\|title=About Time for Teaching: 120 Time-Saving Tips for Teachers and Those Who Support Them\|url=https://robynpearce.com/products/about-time-for-teachers\|publisher=Getting a Grip Publishing\|place=Auckland\|page=137\|oclc=156759530\|isbn=978-0-7900-1044-1\|access-date=2024-08-10\|df=mdy-all}}</ref> altering the format of the email address to where it does not match the [[wikipedia:Regular expression\|regular expression]](s) used by the tools which scrape them from web page content helps prevent spam. It works by displaying an ''image'' of the '@' symbol instead of the typographical "Commercial At" symbol ([[wikipedia:Unicode\|Unicode]] U+0040<ref name="U0040">The Unicode Consortium ({{#formatdate:2023-09-12\|ymd}}). [https://www.unicode.org/charts/PDF/U0000.pdf The Unicode Standard, Version 15.1, ''C0 Controls and Basic Latin'']. Accessed {{#formatdate:2024-08-10\|mdy}}.</ref>). This prevents automated search engines and crawlers that use the '@' symbol to detect email addresses from identifying them here, preventing their retrieval and addition to any spam recipient lists.

	== Usage ==		== Usage ==
Line 37:		Line 37:
	or		or

	{{Template link general\|code=on\|italic=on\|~~{{ROOTPAGENAME}}~~\|1=account\|2=example.com}} → {{No spam\|1=account\|2=example.com}}		{{Template link general\|code=on\|italic=on\|No spam\|2=account\|3=example.com}} → {{No spam\|account\|example.com}}

	== TemplateData ==		== TemplateData ==

SockyPaws: Add TemplateData header template

2024-11-26T07:56:35Z

Add TemplateData header template

← Older revision		Revision as of 07:56, 26 November 2024
Line 1:		Line 1:
	{{Documentation subpage}}		{{Documentation subpage}}
	The ~~{{[[~~Template~~:No spam~~\|No spam~~]]}}~~ template is designed to help prevent spam from being sent to email addresses which are part of the content of wiki pages. As nearly all email address harvesting for these purposes is automated,<ref name="~~Pearce2006~~">Robyn ~~Pearce (~~January 2006~~). [https://robynpearce.com/products/about-time-for-teachers ''~~About Time for Teaching: 120 Time-Saving Tips for Teachers and Those Who Support Them~~'']. Auckland: Getting a Grip Publishing. p. 137. [[wikipedia:ISBN~~\|~~ISBN]] [~~https://~~search~~.~~worldcat.org~~/~~title~~/156759530~~?oclcNum~~=~~156759530~~ 978-0-7900-1044-1~~]. Retrieved {{#formatdate:~~2024-08-10\|mdy}}.</ref> altering the format of the email address to where it does not match the [[wikipedia:Regular expression\|regular expression]](s) used by the tools which scrape them from web page content helps prevent spam. It works by displaying an ''image'' of the '@' symbol instead of the typographical "Commercial At" symbol ([[wikipedia:Unicode\|Unicode]] U+0040<ref name="U0040">The Unicode Consortium ({{#formatdate:2023-09-12\|ymd}}). [https://www.unicode.org/charts/PDF/U0000.pdf The Unicode Standard, Version 15.1, ''C0 Controls and Basic Latin'']. Accessed {{#formatdate:2024-08-10\|mdy}}.</ref>). This prevents automated search engines and crawlers that use the '@' symbol to detect email addresses from identifying them here, preventing their retrieval and addition to any spam recipient lists.		The {{Template link general\|plaincode=on\|No spam}} template is designed to help prevent spam from being sent to email addresses which are part of the content of wiki pages. As nearly all email address harvesting for these purposes is automated,<ref name="pearce">{{Cite book\|last=Pearce\|first=Robyn\|date=January 2006\|title=About Time for Teaching: 120 Time-Saving Tips for Teachers and Those Who Support Them\|url=https://robynpearce.com/products/about-time-for-teachers\|publisher=Getting a Grip Publishing\|place=Auckland\|page=137\|oclc=156759530\|isbn=978-0-7900-1044-1\|access-date=2024-08-10\|df=mdy-all}}</ref> altering the format of the email address to where it does not match the [[wikipedia:Regular expression\|regular expression]](s) used by the tools which scrape them from web page content helps prevent spam. It works by displaying an ''image'' of the '@' symbol instead of the typographical "Commercial At" symbol ([[wikipedia:Unicode\|Unicode]] U+0040<ref name="U0040">The Unicode Consortium ({{#formatdate:2023-09-12\|ymd}}). [https://www.unicode.org/charts/PDF/U0000.pdf The Unicode Standard, Version 15.1, ''C0 Controls and Basic Latin'']. Accessed {{#formatdate:2024-08-10\|mdy}}.</ref>). This prevents automated search engines and crawlers that use the '@' symbol to detect email addresses from identifying them here, preventing their retrieval and addition to any spam recipient lists.

	== Usage ==		== Usage ==
	If an email address input is provided as parameters, the template will display the email address and with an image of the '@' symbol inserted, instead of the actual typographical symbol. When invoked without parameters, only the image of the '@' symbol is displayed, and the user is responsible for placing the local and domain parts of the email address on both sides.		If an email address input is provided as parameters, the template will display the email address and with an image of the '@' symbol inserted, instead of the actual typographical symbol. When invoked without parameters, only the image of the '@' symbol is displayed, and the user is responsible for placing the local and domain parts of the email address on both sides.

	; With parameters : <code~~>{{~~{{ROOTPAGENAME}}\|account\|example.com~~}}</code>~~ → {{~~{{ROOTPAGENAME}}~~\|account\|example.com}}		; With parameters : {{Template link general\|code=on\|italic=on\|{{ROOTPAGENAME}}\|account\|example.com}} → {{No spam\|account\|example.com}}
	; Without parameters : <code~~>{{~~{{ROOTPAGENAME}}~~}}</code>~~ → {{No spam}}		; Without parameters : {{Template link general\|code=on\|{{ROOTPAGENAME}}}} → {{No spam}}

	=== Parameters ===		=== Parameters ===
Line 31:		Line 31:
	…'''''every''''' ASCII character, including the equality symbol (<code>=</code>), a space (<code> </code>) or even ''ANOTHER <code>@</code> SYMBOL'' is perfectly valid in the local part of the address provided both user and server take care to enclose the local part in quotation marks. With the knowledge that email addresses using one of these uncommon characters may occasionally be encountered and cause this template to malfunction, a solution was identified to overcome this failure mode.		…'''''every''''' ASCII character, including the equality symbol (<code>=</code>), a space (<code> </code>) or even ''ANOTHER <code>@</code> SYMBOL'' is perfectly valid in the local part of the address provided both user and server take care to enclose the local part in quotation marks. With the knowledge that email addresses using one of these uncommon characters may occasionally be encountered and cause this template to malfunction, a solution was identified to overcome this failure mode.

	Such email addresses '''''must''''' be supplied to the template as ''named'' parameters and not unnamed (positional) ones. The parameter names and aliases are identified below in the [[#TemplateData\|TemplateData]] section, but examples of using them would be:		Such email addresses '''''must''''' be supplied to the template as ''named'' parameters and not unnamed (positional) ones. The parameter names and aliases are identified below in the [[#TemplateData\|§ TemplateData]] section, but examples of using them would be:

	<code~~>{{~~{{ROOTPAGENAME}}\|local=account\|domain=example.com~~}}</code>~~ → {{~~{{ROOTPAGENAME}}~~\|local=account\|domain=example.com}}		{{Template link general\|code=on\|{{ROOTPAGENAME}}\|2=local={{Var\|account}}\|3=domain={{Var\|example.com}}}} → {{No spam\|local=account\|domain=example.com}}

	or		or

	<code~~>{{~~{{ROOTPAGENAME}}\|1=account\|2=example.com~~}}</code>~~ → {{~~{{ROOTPAGENAME}}~~\|1=account\|2=example.com}}		{{Template link general\|code=on\|italic=on\|{{ROOTPAGENAME}}\|1=account\|2=example.com}} → {{No spam\|1=account\|2=example.com}}

	== TemplateData ==		== TemplateData ==
			{{TemplateData header}}
	<templatedata>{		<templatedata>{
	"description": "Displays an email address with the '@' symbol replaced by an image, to thwart automated harvesting for spam",		"description": "Displays an email address with the '@' symbol replaced by an image, to thwart automated harvesting for spam",

SockyPaws: Bonehead move (see what I did there?), accidentally wrote my documentation on the sandbox page. Copying here, will edit sandbox to appropriate content forthwith.

2024-08-10T11:27:13Z

Bonehead move (see what I did there?), accidentally wrote my documentation on the sandbox page. Copying here, will edit sandbox to appropriate content forthwith.

New page

{{Documentation subpage}}
The {{[[Template:No spam|No spam]]}} template is designed to help prevent spam from being sent to email addresses which are part of the content of wiki pages. As nearly all email address harvesting for these purposes is automated,<ref name="Pearce2006">Robyn Pearce (January 2006). [https://robynpearce.com/products/about-time-for-teachers ''About Time for Teaching: 120 Time-Saving Tips for Teachers and Those Who Support Them'']. Auckland: Getting a Grip Publishing. p. 137. [[wikipedia:ISBN|ISBN]] [https://search.worldcat.org/title/156759530?oclcNum=156759530 978-0-7900-1044-1]. Retrieved {{#formatdate:2024-08-10|mdy}}.</ref> altering the format of the email address to where it does not match the [[wikipedia:Regular expression|regular expression]](s) used by the tools which scrape them from web page content helps prevent spam. It works by displaying an ''image'' of the '@' symbol instead of the typographical "Commercial At" symbol ([[wikipedia:Unicode|Unicode]] U+0040<ref name="U0040">The Unicode Consortium ({{#formatdate:2023-09-12|ymd}}). [https://www.unicode.org/charts/PDF/U0000.pdf The Unicode Standard, Version 15.1, ''C0 Controls and Basic Latin'']. Accessed {{#formatdate:2024-08-10|mdy}}.</ref>). This prevents automated search engines and crawlers that use the '@' symbol to detect email addresses from identifying them here, preventing their retrieval and addition to any spam recipient lists.

== Usage ==
If an email address input is provided as parameters, the template will display the email address and with an image of the '@' symbol inserted, instead of the actual typographical symbol. When invoked without parameters, only the image of the '@' symbol is displayed, and the user is responsible for placing the local and domain parts of the email address on both sides.

; With parameters : <code>{{{{ROOTPAGENAME}}|account|example.com}}</code> → {{{{ROOTPAGENAME}}|account|example.com}}
; Without parameters : <code>{{{{ROOTPAGENAME}}}}</code> → {{No spam}}

=== Parameters ===
The template accepts two parameters, meant to hold the portions of the address that precede and follow the '@' symbol, in that order.

==== Atypical characters ====
While this template should perform as expected in the vast majority of cases, email addresses with unusual characters present in the local or left-hand portion can lead to issues. In practice, most commercial email hosting services disallow the use of anything but a handful of non-ASCII glyphs when selecting a mailbox name, but this does not change the fact that they ''are'' acceptable as defined in RFC 821<ref name="RFC821">Postel, Jonathan B. (August 1982). [https://datatracker.ietf.org/doc/html/rfc821 ''"Simple Mail Transport Protocol"'']. [[wikipedia:Internet Engineering Task Force|IETF]]. pp. 29–30. [[wikipedia:Digital object identifier|doi]]:[https://doi.org/10.17487%2FRFC0821 10.17487/RFC0821]. Accessed {{#formatdate:2024-08-10|mdy}}.</ref>, the document which first defined the protocol used by servers to transmit and receive email still today. In [https://datatracker.ietf.org/doc/html/rfc821#section-4.1.2 § 4.1.2, "Command Syntax"], we learn that…
<pre style="margin: 1em 6em;">
<mailbox> ::= <local-part> "@" <domain>
<local-part> ::= <dot-string> | <quoted-string>
[…]
<dot-string> ::= <string> | <string> "." <dot-string>
<string> ::= <char> | <char> <string>
<quoted-string> ::= """ <qtext> """
<qtext> ::= "\" <x> | "\" <x> <qtext> | <q> | <q> <qtext>
<char> ::= <c> | "\" <x>
[…]
<SP> ::= the space character (ASCII code 32)
[…]
<c> ::= any one of the 128 ASCII characters, but not any <special> or <SP>
<x> ::= any one of the 128 ASCII characters (no exceptions)
<special> ::= "<" | ">" | "(" | ")" | "[" | "]" | "\" | "." | "," | ";" | ":" | "@" """ | the control characters (ASCII codes 0 through 31 inclusive and 127)
</pre>
…'''''every''''' ASCII character, including the equality symbol (<code>=</code>), a space (<code> </code>) or even ''ANOTHER <code>@</code> SYMBOL'' is perfectly valid in the local part of the address provided both user and server take care to enclose the local part in quotation marks. With the knowledge that email addresses using one of these uncommon characters may occasionally be encountered and cause this template to malfunction, a solution was identified to overcome this failure mode.

Such email addresses '''''must''''' be supplied to the template as ''named'' parameters and not unnamed (positional) ones. The parameter names and aliases are identified below in the [[#TemplateData|TemplateData]] section, but examples of using them would be:

<code>{{{{ROOTPAGENAME}}|local=account|domain=example.com}}</code> → {{{{ROOTPAGENAME}}|local=account|domain=example.com}}

or

<code>{{{{ROOTPAGENAME}}|1=account|2=example.com}}</code> → {{{{ROOTPAGENAME}}|1=account|2=example.com}}

== TemplateData ==
<templatedata>{
"description": "Displays an email address with the '@' symbol replaced by an image, to thwart automated harvesting for spam",
"format": "inline",
"paramOrder": [
"local",
"domain"
],
"params": {
"domain": {
"aliases": [
"mailhost",
"2"
],
"label": "Domain name",
"description": "The domain part of the address, which follows the '@' symbol",
"example": "mail.com",
"type": "line",
"required": true
},
"local": {
"aliases": [
"mailbox",
"1"
],
"label": "Mailbox name",
"description": "The local part of the address, which precedes the '@' symbol",
"example": "mail",
"type": "line",
"required": true
}
}
}</templatedata>

== References ==
{{Reflist}}

<includeonly>
[[Category:Character-substitution templates]]
</includeonly>