Difference between revisions of "Template:Commons/doc"

From blackwiki
Jump to navigation Jump to search
imported>Mitch Ames
(Replaced content with '1000')
Line 1: Line 1:
{{documentation subpage}}
+
1000
{{high-risk|600,000+}}
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
 
 
This template is part of Wikipedia's [[Wikipedia:Wikimedia sister projects|sister projects]]. This template links an article to a page on [[commons:|Wikimedia Commons]], containing a gallery of related images.
 
 
 
===Usage===
 
::{|
 
|-
 
|{{tl2|Commons}}||—puts link-box with current page's name.
 
|-
 
|{{tl2|Commons|''pagename''}}||—puts link-box connecting title ''pagename''.
 
|-
 
|{{tl2|Commons|''pagename''|''showname''}}||—puts link-box showing the title ''showname''.
 
|-
 
|{{tl2|Commons|''pagename''|3=position=left}}||—floats link-box to the left side.
 
|}
 
 
 
To place this template on the page, type '''<nowiki>{{</nowiki>Commons|''pagename''}}''', where ''pagename'' is the name of a page on Wikimedia Commons (defaults to <small><nowiki>"{{PAGENAME}}"</nowiki></small>, the end-name of a page where used).
 
* The optional 2nd parameter gives the displayed link text.
 
* The {{para|position}} parameter accepts one keyword, <code>left</code>, to float the box to the left instead of to the right.
 
* To link to a ''Category'', use {{tlx|Commons category|''catname''}}, where ''catname'' is the name of the category.
 
 
 
===Location===
 
[[File:Sister link template columns problem.jpg|thumb|If using a large, graphical template produces odd layout problems, like the excessive white space shown on the right of this screenshot, then switch to a different sister template.]]
 
 
 
{{cross}} '''Do not place this template in a section all by itself.'''
 
 
 
{{cross}} '''Do not place this template in a section containing columns.'''
 
 
 
This template should normally be placed at the top of the last section in the article, or consider using {{tlx|Commons-inline}} instead.  See [[Wikipedia:Wikimedia sister projects]] for further recommendations about the best choice of template for various situations.
 
 
 
On [[WP:DAB|disambiguation pages]], this template should be listed above other text, but below any cleanup templates, images, infoboxes or navboxes.<!-- Per WP:ACCESS, cleanup templates, images, infoboxes, and navboxes are always first. -->
 
 
 
===Defaults===
 
The ''pagenam'' defaults to wiki-variable <small><nowiki>"{{PAGENAME}}"</nowiki></small>, which is the end-name of the page where used. For a Template:Txxx, the <small><nowiki>{{PAGENAME}}</nowiki></small> would be the end-name "Txxx". For a Category:Catxxx, that page would have <small><nowiki>{{PAGENAME}}</nowiki></small> as the end-name "Catxxx".
 
 
 
The default positioning of the link-box is to the right-side.
 
 
 
===Examples===
 
{| style="border:1px solid #808080; padding:1px;"
 
|{{tl2|Commons}}
 
|}
 
produces
 
{{Commons}}
 
{{-}}
 
 
 
{| style="border:1px solid #808080; padding:1px;"
 
|{{tl2|Commons|Reconquista}}
 
|}
 
produces
 
{{Commons|Reconquista}}
 
{{-}}
 
 
 
{| style="border:1px solid #808080; padding:1px;"
 
|{{tl2|Commons|Category:Reconquista}}
 
|}
 
produces
 
{{Commons|Category:Reconquista}}
 
{{-}}
 
 
 
{| style="border:1px solid #808080; padding:1px;"
 
|{{tl2|Commons|Reconquista|retaking of the Iberian Peninsula}}
 
|}
 
produces
 
{{Commons|Reconquista|retaking of the Iberian Peninsula}}
 
{{-}}
 
 
 
{| style="border:1px solid #808080; padding:1px;"
 
|{{tlx|Commons|Reconquista|position{{=}}left}}
 
|}
 
produces
 
{{Commons|Reconquista|position=left}}
 
{{-}}
 
 
 
===Template data===
 
{{TemplateDataHeader}}
 
<templatedata>{
 
"description": "Creates a small box with a link to a related page on Wikimedia Commons.",
 
"params": {
 
  "1": {
 
    "label": "Pagename",
 
    "description": "The page name on Commons. The article's page name is used as a default.",
 
    "type": "string",
 
    "required": false
 
  },
 
  "2": {
 
    "label": "Showname",
 
    "description": "Optional displayed link text.",
 
    "type": "string",
 
    "required": false
 
  },
 
  "position": {
 
    "label": "Position",
 
    "description": "Position to display the box: 'left' floats the box to the left rather than the default which is on the right.",
 
    "type": "string",
 
    "required": false
 
  }
 
}}</templatedata>
 
 
 
===See also===
 
* [[Template:Commons-inline]]—shows Commons gallery inline
 
* [[Template:Commons category]]
 
* [[Template:Commons category-inline]]—shows Commons category inline
 
* [[Template:Commons category multi]]—to list up to six categories
 
* [[Template:Commons and category]]—shows Commons box with both gallery and category
 
* [[Template:Commons and category-inline]]—shows Commons gallery and category inline
 
* [[Template:Sister project links]]—to link all Wikinews, Wikisource, etc.
 
* {{tl|Wikilivres}}
 
 
 
 
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
[[Category:Exclude in print]]
 
[[Category:Interwiki link templates]]
 
[[Category:Wikimedia Commons templates]]
 
}}</includeonly>
 

Revision as of 04:19, 31 October 2015

1000