Difference between revisions of "Template:Commons file"

From blackwiki
Jump to navigation Jump to search
imported>Mclay1
m (clean-up)
imported>Mclay1
(simplifying)
 
Line 1: Line 1:
<includeonly>{{#if:{{{1|}}}|{{#ifeq:{{{icon}}}|n||[[File:Commons-logo.svg|15px]]&#160;}}Wikimedia Commons has&#32;[[{{#ifeq:{{{p}}}|c|c}}:File:{{{1|}}}|a file]]&#32;available{{#if:{{{2|}}}|&#32;for&#32;{{{2|}}}}}{{{term|.}}}}}</includeonly><noinclude>
+
<includeonly>[[File:Commons-logo.svg|15px]]&nbsp;Wikimedia Commons has [[{{#ifeq:{{{p}}}|c|c}}:File:{{{1}}}|a file]] available{{#if:{{{2|}}}|&#32;for {{{2}}}}}.</includeonly><noinclude>
 
{{Commons file|Wikipedia-logo-v2.svg|this logo}}
 
{{Commons file|Wikipedia-logo-v2.svg|this logo}}
 
{{Documentation|content=
 
{{Documentation|content=
Line 8: Line 8:
 
In the box below. for presentation purposes only, required parameters are in {{bxtn|bold}}; [brackets] indicate parameter values; variables are {{em|italicized}}.
 
In the box below. for presentation purposes only, required parameters are in {{bxtn|bold}}; [brackets] indicate parameter values; variables are {{em|italicized}}.
 
{{csdoc|usage full}}
 
{{csdoc|usage full}}
:<code><nowiki>{{commons file|</nowiki>[{{bxtn|{{var|filename}}}}]<nowiki>|</nowiki>[{{var|appended text}}]<nowiki>|icon= |p= |term= }}</nowiki></code>
+
:<code><nowiki>{{commons file|</nowiki>[{{bxtn|{{var|filename}}}}]<nowiki>|</nowiki>[{{var|appended text}}]<nowiki>|p= }}</nowiki></code>
 
{{end}}
 
{{end}}
 
Copy a blank version to use. All parameter names must be in lowercase. Use the "{{!}}" (pipe) character between each parameter. Leading and trailing spaces (&#160;) are trimmed from parameter values; therefore, parameters will not display if they are only populated by spaces. By default, displayed values are separated by a single [[whitespace character]]. Delete unused parameters. See {{slink||Parameters}} for important details.
 
Copy a blank version to use. All parameter names must be in lowercase. Use the "{{!}}" (pipe) character between each parameter. Leading and trailing spaces (&#160;) are trimmed from parameter values; therefore, parameters will not display if they are only populated by spaces. By default, displayed values are separated by a single [[whitespace character]]. Delete unused parameters. See {{slink||Parameters}} for important details.
  
 
==Parameters==
 
==Parameters==
Parameter labels are in {{bxtn|bold}}; explanatory/expanded text may follow in (parentheses).
+
There are two ordered anonymous parameters; the target file page parameter (<code>[[#fname|[1]]]</code>) is {{em|required}}.
 
 
===Anonymous parameters===
 
There are two ordered anonymous parameters; the target file page parameter (<code>[[#fname|[1]]]</code>) is {{em|required}}.<br/>
 
In order of usage:
 
 
*{{anchor|fname}}{{bxtn|[1]}} (filename): use the first anonymous parameter for the filename of an associated [[Help:Files|file: namespace]] page, which becomes the target file page. Enter the file's name, including its extension, in plain text{{spaced en dash}}{{em|do not}} enter the [[wp:namespace|namespace prefix]] ("file:" or "image:"). Do not use any formatting or special editing. This parameter is {{em|required}}; output will not display otherwise.
 
*{{anchor|fname}}{{bxtn|[1]}} (filename): use the first anonymous parameter for the filename of an associated [[Help:Files|file: namespace]] page, which becomes the target file page. Enter the file's name, including its extension, in plain text{{spaced en dash}}{{em|do not}} enter the [[wp:namespace|namespace prefix]] ("file:" or "image:"). Do not use any formatting or special editing. This parameter is {{em|required}}; output will not display otherwise.
 
:{{em|Note:}} the default link is to the {{em|local copy}} of the Commons file page; for linking to the original, see parameter {{bxt|p}} [[#cp|below]].
 
:{{em|Note:}} the default link is to the {{em|local copy}} of the Commons file page; for linking to the original, see parameter {{bxt|p}} [[#cp|below]].
 
*{{bxtn|[2]}} (postscript): use the second anonymous parameter to append optional explanatory text that displays {{em|after}} the link to the target file page.
 
*{{bxtn|[2]}} (postscript): use the second anonymous parameter to append optional explanatory text that displays {{em|after}} the link to the target file page.
 
===Display parameters===
 
Optional.
 
*{{bxtn|icon}} (logo): by default, the Wikimedia logo appears first, as a 15px icon (&#8239;[[File:Commons-logo.svg|15px]]&#8239;); set {{para|icon|n}} to suppress its display.
 
*{{bxtn|term}} (termination): the template output displays a full stop as trailing (terminating) punctuation; use this parameter to replace or remove it.
 
 
===Other parameters===
 
Optional.
 
 
*{{anchor|cp}}{{bxtn|p}} (project): by default, the link to the file page targets the Wikipedia copy; set {{para|p|c}} to link the original at Wikimedia Commons.
 
*{{anchor|cp}}{{bxtn|p}} (project): by default, the link to the file page targets the Wikipedia copy; set {{para|p|c}} to link the original at Wikimedia Commons.
 
==Static text==
 
The static text output by the template is quoted in the box below. For presentation purposes only, the link text to the target file page is formatted as a non-linking example.
 
{{quote box|quote=Wikimedia Commons has <span style="color:#0645AD; text-decoration:underline">a file</span> available|fontsize=100|align=left}}
 
  
 
[[Category:Exclude in print]]
 
[[Category:Exclude in print]]

Latest revision as of 06:38, 2 February 2017

Commons-logo.svg Wikimedia Commons has a file available for this logo.

Template documentation

Template commons file implements and formats inline links to pages at the file: namespace. By default, the template displays a Wikimedia icon, pre-inserted text, and trailing punctuation, as well as static link text. Appended text may also be included. Several of the default options may be edited by the user.

Usage

Structure

In the box below. for presentation purposes only, required parameters are in bold; [brackets] indicate parameter values; variables are italicized.

Full parameter set in horizontal format
{{commons file|[filename]|[appended text]|p= }}

Copy a blank version to use. All parameter names must be in lowercase. Use the "|" (pipe) character between each parameter. Leading and trailing spaces ( ) are trimmed from parameter values; therefore, parameters will not display if they are only populated by spaces. By default, displayed values are separated by a single whitespace character. Delete unused parameters. See Script error: No such module "Section link". for important details.

Parameters

There are two ordered anonymous parameters; the target file page parameter ([1]) is required.

  • [1] (filename): use the first anonymous parameter for the filename of an associated file: namespace page, which becomes the target file page. Enter the file's name, including its extension, in plain textTemplate:Spaced en dashdo not enter the namespace prefix ("file:" or "image:"). Do not use any formatting or special editing. This parameter is required; output will not display otherwise.
Note: the default link is to the local copy of the Commons file page; for linking to the original, see parameter p below.
  • [2] (postscript): use the second anonymous parameter to append optional explanatory text that displays after the link to the target file page.
  • p (project): by default, the link to the file page targets the Wikipedia copy; set |p=c to link the original at Wikimedia Commons.