Jump to content
Toggle menu
  • 8 articles
  • 75 files
  • 7 users
  • 37.8K edits
Neodyland Wiki
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Template:Size/doc: Difference between revisions

Template page
extraneous heading
templatedata
 
(33 intermediate revisions by 16 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Lua|Module:Size}}
{{TemplateBox
|1=unit
|1d=Unit of input (must be one of: cm, m, mm, km, in, ft, yd, mi).
|1aliases=1
|1def=cm
|1stat=required


; <nowiki>{{Size}}, {{Dim}}, {{Dimensions}}</nowiki>
|2=height
: To display a 2D size (width × height) both in centimeters and inches, etc. (such as in the "Dimensions" field of a {{m|Painting}} template).
|2d=height (with word "height" displayed)
|2def=
|2stat=optional


; <nowiki>{{Size|1|2|3|4}}</nowiki>
|3=width
# Unit of input (must be one of: cm, m, km, in, ft, yd, mi).
|3d=width (with word "width" displayed)
# Width (in the declared unit, with "." as decimal separator).
|3def=
# Height (in the declared unit, with "." as decimal separator).
|3stat=optional
# Conversion precision (optional number of decimal digits, default: 2).


; Exemples
|4=length
<pre>{{Size|cm|123|456}}</pre>
|4d=length (with word "length" displayed)
: {{Size|cm|123|456}}
|4def=
<pre>{{Size|km|12.1234|98.1234|1}}</pre>
|4stat=optional-
: {{Size|km|12.1234|98.1234|1}}


<includeonly>
|5=depth
[[Category:Formatting templates]]
|5d=depth (with word "depth" displayed)
[[Category:Helper templates]]
|5def=
[[Category:Image description templates]]
|5stat=optional-
[[Category:Templates using ParserFunctions]]
 
|6=diameter
|6d=diameter (with word "diameter" displayed)
|6def=
|6stat=optional-
 
|7=thickness
|7d=thickness (with word "thickness" displayed)
|7def=
|7stat=optional-
 
|8=prec
|8d=Conversion precision (optional number of decimal digits).
|8def=1 (2 for mm to inches)
|8stat=optional-
 
|9=lang
|9d=language code (only needs to be provided if the language shall be fixed and independant from the user's preferences)
|9def=value of <nowiki>{{int:Lang}}</nowiki>
|9stat=optional-
 
|11=1
|11d=Alternative name for "unit". Unit of input (must be one of: cm, m, mm, km, in, ft, yd, mi). <span style="color:red">Deprecated.</span>
|11def=cm
|11stat=deprecated
 
|12=2
|12d=First dimension measured. <span style="color:red">Deprecated.</span>
|12def=
|12stat=deprecated
 
|13=3
|13d=A second dimension measured. <span style="color:red">Deprecated.</span>
|13def=
|13stat=deprecated
 
|14=4
|14d=A third dimension measured. <span style="color:red">Deprecated.</span>
|14def=
|14stat=deprecated
 
|name=Size
|desc=Displays a 1D (length), 2D (width × height) or 3D (width × height × depth) size, formatted according to localized format. For example if user language is English then measurements will be shown in both centimeters and inches, if user language is German than only metric units will be shown. This template is mainly used in the "Dimensions" field of an {{t|Artwork}} template.
|namespace=File
|usergroup=
|placement=
|usage-notes=
|type=formatting
|example=
|i18n-method=switch
|i18n-desc=All unit translations are in [[Module:I18n/units]].
|seealso=* {{tl|with frame}}
|setscats=
|lines=one
|shorthand=
|relieson= [[Module:Size]]
}}


<!--interwikis here-->
== {{Section header|Examples}} ==
{{LanguageSelector|be-tarask|ca|en|eo|fr|nl|pl}}
{|border="1" style="right"
|-
! Code
! Output
! Notes
|-
| <nowiki>{{Size|unit=m|height=10|width=20}}</nowiki>
| {{Size|unit=m|height=10|width=20}}
| Use of name parameters
|-
| <nowiki>{{Size|unit=mi|width=10|height=20|depth=30}}</nowiki>
| {{Size|unit=mi|width=10|height=20|depth=30}}
| Use of name parameters
|-
| <nowiki>{{Size|cm|12.1234|98.1234|prec=1}}</nowiki>
| {{Size|cm|12.1234|98.1234|prec=1}}
| Use of "prec" parameter
|-
| <nowiki>{{Size|in|12.12|98.12|lang=fr}}</nowiki>
| {{Size|in|12.12|98.12|lang=fr}}
| Use of "lang" parameter
|-
| <nowiki>{{Size|cm|123}}</nowiki>
| {{Size|cm|123}}
| 1D version
|-
| <nowiki>{{Size|in|123|456}}</nowiki>
| {{Size|in|123|456}}
| 2D version
|-
| <nowiki>{{Size|ft|123|456|789}}</nowiki>
| {{Size|ft|123|456|789}}
| 3D version
|-
|}


<includeonly>
[[Category:Formatting templates|{{PAGENAME}}]]
[[Category:Helper templates|{{PAGENAME}}]]
[[Category:Image description templates|{{PAGENAME}}]]
</includeonly>
</includeonly>
<templatedata>
{
"params": {
"lang": {
"description": "language code",
"type": "string",
"default": "value of {{int:Lang}}"
},
"unit": {
"description": "Unit of input ",
"example": "mm",
"type": "string",
"suggestedvalues": [
"cm",
"m",
"mm",
"km",
"in",
"ft",
"yd",
"mi"
],
"autovalue": "cm",
"required": true
},
"height": {
"type": "number"
},
"width": {
"type": "number"
},
"length": {
"type": "number"
},
"depth": {
"type": "number"
},
"diameter": {
"type": "number"
},
"thickness": {
"type": "number"
},
"prec": {
"description": "Conversion precision (optional number of decimal digits)",
"default": "1 (2 for mm to inches)",
"autovalue": "1"
}
},
"description": "Displays a size, formatted according to localised format.",
"format": "inline"
}
</templatedata>

Latest revision as of 12:56, 3 June 2024

Displays a 1D (length), 2D (width × height) or 3D (width × height × depth) size, formatted according to localized format. For example if user language is English then measurements will be shown in both centimeters and inches, if user language is German than only metric units will be shown. This template is mainly used in the "Dimensions" field of an {{Artwork}} template.

Usage

{{Size |unit= |height= |width= }}

Template parameters

ParameterDescriptionDefaultStatus
unit
1
Unit of input (must be one of: cm, m, mm, km, in, ft, yd, mi).cmrequired
heightheight (with word "height" displayed)emptyoptional
widthwidth (with word "width" displayed)emptyoptional
lengthlength (with word "length" displayed)emptyoptional
depthdepth (with word "depth" displayed)emptyoptional
diameterdiameter (with word "diameter" displayed)emptyoptional
thicknessthickness (with word "thickness" displayed)emptyoptional
precConversion precision (optional number of decimal digits).1 (2 for mm to inches)optional
langlanguage code (only needs to be provided if the language shall be fixed and independant from the user's preferences)value of {{int:Lang}}optional
1Alternative name for "unit". Unit of input (must be one of: cm, m, mm, km, in, ft, yd, mi). Deprecated.cmdeprecated
2First dimension measured. Deprecated.emptydeprecated
3A second dimension measured. Deprecated.emptydeprecated
4A third dimension measured. Deprecated.emptydeprecated

Additional information

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

The template is intended to be used by the following user groups: no user group specified

Relies on:
Module:Size

See also

Localization

To add your language to the list of languages supported by this template, please edit the template and add a row to the "{{LangSwitch|}}" construct. It takes the form "|xx= Your translation " (xx being the code of your language)

All unit translations are in Module:I18n/units.

Examples

Code Output Notes
{{Size|unit=m|height=10|width=20}} Height: 10 m (10.9 yd); Width: 20 m (21.9 yd) Use of name parameters
{{Size|unit=mi|width=10|height=20|depth=30}} Height: 20 miles (32.2 km); Width: 10 miles (16.1 km); Depth: 30 miles (48.3 km) Use of name parameters
{{Size|cm|12.1234|98.1234|prec=1}} 12.1 cm (4.8 in) × 98.1 cm (38.6 in) Use of "prec" parameter
{{Size|in|12.12|98.12|lang=fr}} 12.1 pouces (30.8 cm) × 98.1 pouces (249.2 cm) Use of "lang" parameter
{{Size|cm|123}} 123 cm (48.4 in) 1D version
{{Size|in|123|456}} 123 in (312.4 cm) × 456 in (11.6 m) 2D version
{{Size|ft|123|456|789}} 123 ft (37.5 m) × 456 ft (139 m) × 789 ft (240.5 m) 3D version


Displays a size, formatted according to localised format.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
langlang

language code

Default
value of {{int:Lang}}
Stringoptional
unitunit

Unit of input

Suggested values
cm m mm km in ft yd mi
Example
mm
Auto value
cm
Stringrequired
heightheight

no description

Numberoptional
widthwidth

no description

Numberoptional
lengthlength

no description

Numberoptional
depthdepth

no description

Numberoptional
diameterdiameter

no description

Numberoptional
thicknessthickness

no description

Numberoptional
precprec

Conversion precision (optional number of decimal digits)

Default
1 (2 for mm to inches)
Auto value
1
Unknownoptional
Cookies help us deliver our services. By using our services, you agree to our use of cookies.