Template:Emailentry/doc

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

Usage

{{emailentry}} is designed to be used for entering e-mail addresses as text, e.g. into tables, lists or as inline text. It it also meant to be used as a standardizing tool on pages and within groups of pages, where the user's enter their own e-mail addresses. All options but one can be used to enter an e-mail address without making it immediately recognizable to scanner-bots.

Parameters

There are 4 parameters, 2 unnamed and 2 named, none of which is required. If no parameters are specified, the template will display an example address.

Parameter	Description	Default value
`1` (unnamed)	First part of the address	`firstname.surname`
`2` (unnamed)	Second part of the address	`example.moz`
`at`	Style of displaying the "AT"	(At-teken.png)
`text`	Custom text for "AT"	null (dependant on the parameter `at=)`

Syntax

The template's syntax is

{{emailentry|first part|second part|at= |text= }}

Optional parameters

1

Address part before the @

The first address part, i.e. the part preceding the at-symbol (@). Enter it with all the dots, underscores, etc. that your address contains.

If left out, the default value is "firstname.surname".

Example

example.exampleton
example-andrew.exampleton
example_exampleton

Note

This parameter must be placed before the 2nd parameter.

Usage

{{emailentry|1}}

2

Address part after the @

The second address part, i.e. the part following the at-symbol (@). Enter it with all the dots, underscores, etc. that your address contains.

If left out, the default value is "example.moz".

Example

domain.moz
domain-upon-avon.moz
domain_server.moz

Note

This parameter must be placed after the 1st parameter.

Usage

{{emailentry|1|2}}

at

Presentation of the AT part

There are a number of way, in which you can display the at-symbol (@) in a textual e-mail address. By using the values in the table below, you wall be able to regulate how the concept of @ is displayed in the address.

By default, the value is "", i.e. an image of an at-symbol.

Note

If one of the values for entering custom text is used, you must also specify the parameter text= (see below).

Usage

{{emailentry|1|2|at=value}}

Available values for the parameter "at"
Table legend

uc	=	UPPER CASE
lc	=	lower case
b	=	Within brackets […]
p	=	Within parentheses (…)
s	=	Surrounded by non-breaking spaces ] [
t	=	Specify custom text

Value	Displays	Notes
`uc`	AT	No spaces between this and the surrounding text
`lc`	at	No spaces between this and the surrounding text
`ucs`	AT	Enclosed in non-breaking spaces
`lcs`	at	Enclosed in non-breaking spaces
`ucb`	[AT]	In brackets, no spaces between this and the surrounding text
`lcb`	[at]
`ucbs`	[AT]	In brackets, enclosed in non-breaking spaces
`lcbs`	[at]	In brackets, enclosed in non-breaking spaces
`ucp`	(AT)	In parentheses, no spaces between this and the surrounding text
`lcp`	(at)
`ucps`	(AT)	In parentheses, enclosed in non-breaking spaces
`lcps`	(at)	In parentheses, enclosed in non-breaking spaces
`@` or `at`	@	NB! Standard at-symbol, no spaces
`@s` or `ats`	@	NB! Standard at-symbol, enclosed in non-breaking spaces
`t`	custom text	No spaces between this and the surrounding text
`ts`	custom text	Enclosed in non-breaking spaces
`tb`	[custom text]	In brackets, no spaces between this and the surrounding text
`tbs`	[custom text]	In brackets, enclosed in non-breaking spaces
`tp`	(custom text)	In parentheses, no spaces between this and the surrounding text
`tps`	(custom text)	In parentheses, enclosed in non-breaking spaces

text

Custom text for presenting the AT part

If you want to use something other than the preset ways of presenting the AT part, you may specify your own, custom text.

Note

This parameter can only be used together with the appropriate values for the parameter at= (see the table above).
These values are t, ts, tb, tbs, tp and tps.

Usage

{{emailentry|1|2|at=value|text=custom text}}

Examples

Case	What you type	What you see	Notes
No parameters	`{{emailentry}}`	firstname.surnameexample.moz
1st and 2nd params	`{{emailentry\|ethelred.the.unready\|10thcentury.se}}`	ethelred.the.unready10thcentury.se
@	`{{emailentry\|ethelred.the.unready\|10thcentury.se\|at=at}}`	ethelred.the.unready@10thcentury.se	Can easily be read by scanner-bots
@ with spaces	`{{emailentry\|ethelred.the.unready\|10thcentury.se\|at=ats}}`	ethelred.the.unready @ 10thcentury.se	Can easily be read by scanner-bots
AT	`{{emailentry\|ethelred.the.unready\|10thcentury.se\|at=uc}}`	ethelred.the.unreadyAT10thcentury.se
AT with spaces	`{{emailentry\|ethelred.the.unready\|10thcentury.se\|at=ucs}}`	ethelred.the.unready AT 10thcentury.se
[at]	`{{emailentry\|ethelred.the.unready\|10thcentury.se\|at=lcb}}`	ethelred.the.unready[at]10thcentury.se
[at] with spaces	`{{emailentry\|ethelred.the.unready\|10thcentury.se\|at=lcbs}}`	ethelred.the.unready [at] 10thcentury.se
(AT)	`{{emailentry\|ethelred.the.unready\|10thcentury.se\|at=ucp}}`	ethelred.the.unready[at]10thcentury.se
(AT) with spaces	`{{emailentry\|ethelred.the.unready\|10thcentury.se\|at=ucps}}`	ethelred.the.unready [at] 10thcentury.se
[krøllalfa]	`{{emailentry\|inge.krokrygg\|12thcentury.se\|at=tb\|text=krøllalfa}}`	inge.krokrygg[krøllalfa]12thcentury.se	"krøllalfa" is Norwegian for "@".
[krøllalfa] with spaces	`{{emailentry\|inge.krokrygg\|12thcentury.se\|at=tbs\|text=krøllalfa}}`	inge.krokrygg [krøllalfa] 12thcentury.se	"krøllalfa" is Norwegian for "@".
(snabel-a)	`{{emailentry\|emund.kolbraenna\|11thcentury.se\|at=tp\|text=snabel-a}}`	emund.kolbraenna(snabel-a)11thcentury.se	"snabel-a" is Swedish for "@".
(snabel-a) with spaces	`{{emailentry\|emund.kolbraenna\|11thcentury.se\|at=tps\|text=snabel-a}}`	emund.kolbraenna (snabel-a) 11thcentury.se	"snabel-a" is Swedish for "@".