Template:Validextension/doc: Difference between revisions

Latest revision as of 06:01, 9 June 2023

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Validextension.

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ кыргызча ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာမန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha / ўзбекча ∙ Tiếng Việt ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ 中文（臺灣） ∙ +/−

Postprocessor template to check the output of Module:File.

Usage

As long the module does not distinguish between valid extensions and other cruft, this template can be used to verify the output of the module.

Template parameters

Parameter	Description	Default	Status
`1`	file name: name of the file without namespace (e.g. PAGENAMEd)	empty	required
`2`	the name of the file without namespace and without dot_extension, e.g. {{#invoke:StripFilename\|main\|filename}} {{#invoke:File\|woExtension\|file=filename}} {{#invoke:FileName\|removeExtension\|filename}} or the result of such a function	empty	required
`3`	"Extension" when the valid extension should be returned ("e" is enough)	empty	optional
`4`	default value for extension to be returned when invalid extension	empty	optional

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: all users

Localization

This template is not intended to be localized.

The template does not generate any localizable text.

Explanation

Depending on the third parameter, it returns either

3=e: the file extension, if it is a valid one, otherwise a null string
otherwise: the file name without dot_extension

Examples

{{Validextension\|HSWikimedia.svg\|HSWikimedia\|\|???}}	HSWikimedia
{{Validextension\|HSWikimedia.svg\|HSWikimedia\|e\|???}}	svg
{{Validextension\|HSWikimedia.icon\|HSWikimedia\|\|''unknown ext''}}	unknown ext
{{Validextension\|HSWikimedia.icon\|HSWikimedia\|e\|''unknown ext''}}	unknown ext
{{Validextension\|HSWikimedia.icon\|HSWikimedia}}	HSWikimedia
{{Validextension\|HSWikimedia.icon\|HSWikimedia\|e}}	icon

@@ Line 4: / Line 4: @@
 |1stat=required
 |2=2
-|2d=the name of the file without namespace and dot_extension, e.g.<br>
+|2d=the name of the file without namespace and without dot_extension, e.g.<br>
 <nowiki>{{#invoke:StripFilename|main|</nowiki>''filename''<nowiki>}}</nowiki><br>
 <nowiki>{{#invoke:File|woExtension|file=</nowiki>''filename''<nowiki>}}</nowiki><br>
-<nowiki>{{#invoke:FileName|removeExtension}}</nowiki>
+<nowiki>{{#invoke:FileName|removeExtension|</nowiki>''filename''<nowiki>}}</nowiki><br>
-<small>or the result of such a function</small>
+:<small>or the result of such a function</small>
 |2stat=required
 |3=3
 |3d="Extension" when the valid extension should be returned ("e" is enough)
 |3stat=optional-
+|4=4
+|4d=default value for extension to be returned when invalid extension
+|4stat=optional-
 |name=Validextension
@@ Line 19: / Line 22: @@
 |usergroup=all
 |i18n-desc=The template does not generate any localizable text.
+|i18n-method=-
 |usage-notes=As long the module does not distinguish between valid extensions and other cruft, this template can be used to verify the output of the module.
 }}
@@ Line 26: / Line 30: @@
 *3=e: the file extension, if it is a valid one, otherwise a null string
 *otherwise: the file name without dot_extension
+=== Examples ===
+{|
+|-
+|<nowiki>{{Validextension|HSWikimedia.svg|HSWikimedia||???}}</nowiki>
+|{{Validextension|HSWikimedia.svg|HSWikimedia||???}}
+|-
+|<nowiki>{{Validextension|HSWikimedia.svg|HSWikimedia|e|???}}</nowiki>
+|{{Validextension|HSWikimedia.svg|HSWikimedia|e|???}}
+|-
+|<nowiki>{{Validextension|HSWikimedia.icon|HSWikimedia||''unknown ext''}}</nowiki>
+|{{Validextension|HSWikimedia.icon|HSWikimedia||''unknown ext''}}
+|-
+|<nowiki>{{Validextension|HSWikimedia.icon|HSWikimedia|e|''unknown ext''}}</nowiki>
+|{{Validextension|HSWikimedia.icon|HSWikimedia|e|''unknown ext''}}
+|-
+|<nowiki>{{Validextension|HSWikimedia.icon|HSWikimedia}}</nowiki>
+|{{Validextension|HSWikimedia.icon|HSWikimedia}}
+|-
+|<nowiki>{{Validextension|HSWikimedia.icon|HSWikimedia|e}}</nowiki>
+|{{Validextension|HSWikimedia.icon|HSWikimedia|e}}
+|}

commons>Sarang