Template:Emailentry/doc

From MozillaWiki
Jump to: navigation, search
Edit-copy green.svg
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 (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-sign (@). 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-sign (@). 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-sign (@) 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 "At-teken.png", i.e. an image of an at-sign.

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
i = Image (same as the default)
Value Displays Notes
uc AT No spaces between this and the surrounding text
lc at
ucs  AT  Enclosed in non-breaking spaces
lcs  at 
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] 
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) 
@ or at @ NB! Standard at-sign, no spaces
@s or ats  @  NB! Standard at-sign, 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
is  At-teken.png  The default at-image, 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

Group Case What you type What you see Notes
Basic
(def. img)
No parameters {{emailentry}} firstname.surnameAt-teken.pngexample.moz
With spaces at=is}} firstname.surname At-teken.png example.moz
Params 1 & 2 ethelred.unready|10thcentury.eng}} ethelred.unreadyAt-teken.png10thcentury.eng
Params 1 & 2, spaces ethelred.unready|10thcentury.eng|at=is}} ethelred.unready At-teken.png 10thcentury.eng
Normal at-sign @ ethelred.unready|10thcentury.eng|at=at}} ethelred.unready@10thcentury.eng Can easily be read by scanner-bots
@, spaces ethelred.unready|10thcentury.eng|at=ats}} ethelred.unready @ 10thcentury.eng
AT/at AT ethelred.unready|10thcentury.eng|at=uc}} ethelred.unreadyAT10thcentury.eng
AT, spaces ethelred.unready|10thcentury.eng|at=ucs}} ethelred.unready AT 10thcentury.eng
at ethelred.unready|10thcentury.eng|at=lc}} ethelred.unreadyat10thcentury.eng
at, spaces ethelred.unready|10thcentury.eng|at=ucs}} ethelred.unready AT 10thcentury.eng
Brackets [AT] ethelred.unready|10thcentury.eng|at=ucb}} ethelred.unready[AT]10thcentury.eng
[AT], spaces ethelred.unready|10thcentury.eng|at=ucbs}} ethelred.unready [AT] 10thcentury.eng
[at] ethelred.unready|10thcentury.eng|at=ucb}} ethelred.unready[AT]10thcentury.eng
[at], spaces ethelred.unready|10thcentury.eng|at=lcbs}} ethelred.unready [at] 10thcentury.eng
Parentheses (AT) ethelred.unready|10thcentury.eng|at=ucp}} ethelred.unready(AT)10thcentury.eng
(AT), spaces ethelred.unready|10thcentury.eng|at=ucps}} ethelred.unready (AT) 10thcentury.eng
(at) ethelred.unready|10thcentury.eng|at=lcp}} ethelred.unready(at)10thcentury.eng
(at), spaces ethelred.unready|10thcentury.eng|at=lcps}} ethelred.unready (at) 10thcentury.eng
Custom text AT ethelred.unready|10thcentury.eng|at=t|text={{sup|'''AT'''}}}} ethelred.unreadyAT10thcentury.eng You can wiki-code the custom text string
at ethelred.unready|10thcentury.eng|at=ts|text=<big>'''at'''</big>}} ethelred.unready at 10thcentury.eng
[krøllalfa] inge.krokrygg|12thcentury.no|at=tb|text=''krøllalfa''}} inge.krokrygg[krøllalfa]12thcentury.no "krøllalfa" is Norwegian for "@".
[krøllalfa] , spaces inge.krokrygg|12thcentury.no|at=tbs|text=''krøllalfa''}} inge.krokrygg [krøllalfa] 12thcentury.no
(snabel-a) emund.kolbraenna|11thcentury.se|at=tp|text=<u>snabel-a</u>}} emund.kolbraenna(snabel-a)11thcentury.se "snabel-a" is Swedish for "@".
(snabel-a), spaces emund.kolbraenna|11thcentury.se|at=tps|text=<u>snabel-a</u>}} emund.kolbraenna (snabel-a) 11thcentury.se