Template:Portal/doc: Difference between revisions
meta>Redrose64 (if you use a leading space, it's in a <pre> and so <code> is not just superfluous but it adds another border) |
meta>Funandtrvl (add tmp) |
||
| Line 1: | Line 1: | ||
{{#ifeq: {{{type|}}} | module || | {{#ifeq: {{{type|}}} | module || | ||
{{documentation subpage}} | {{documentation subpage}} | ||
{{high-risk| | {{high-risk|5,200,000+}} | ||
{{lua|Module:Portal}} | {{lua|Module:Portal}} | ||
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE.---> | <!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE.---> | ||
| Line 7: | Line 7: | ||
This {{{type|template}}} produces a box with links to a [[Portal:Contents/Portals|portal]] or to multiple portals. It is most often used in the "See also" section of an article. | This {{{type|template}}} produces a box with links to a [[Portal:Contents/Portals|portal]] or to multiple portals. It is most often used in the "See also" section of an article. | ||
}} | }} | ||
== Usage == | |||
{{Portal |Louisiana |Missouri |Arkansas |Texas |Minnesota |Kansas |Nebraska |Colorado |North Dakota |Montana |Wyoming |Saskatchewan |Alberta |Oklahoma |New Mexico |History }} | {{Portal |Louisiana |Missouri |Arkansas |Texas |Minnesota |Kansas |Nebraska |Colorado |North Dakota |Montana |Wyoming |Saskatchewan |Alberta |Oklahoma |New Mexico |History }} | ||
| Line 29: | Line 29: | ||
</div> | </div> | ||
== Location == | |||
Within articles, {{#ifeq: {{{type|}}} | module | the output of the portal function | this template }} is meant to be placed at the bottom of the article in the ''See also'' section. If there is no ''See also'' section, you can put it in the ''External links'' section instead; there is no need to create a new section just to house this template. If there is no ''External links'' section either, just put it below the article text in the place that seems most appropriate. | Within articles, {{#ifeq: {{{type|}}} | module | the output of the portal function | this template }} is meant to be placed at the bottom of the article in the ''See also'' section. If there is no ''See also'' section, you can put it in the ''External links'' section instead; there is no need to create a new section just to house this template. If there is no ''External links'' section either, just put it below the article text in the place that seems most appropriate. | ||
There are no particular rules about the placement of portals on other kinds of page. | There are no particular rules about the placement of portals on other kinds of page. | ||
== Image == | |||
The portal image names are stored in subpages of [[Module:Portal/images]], organised by the first letter of the portal name. For example, the first letter of [[Portal:Fishing]] is "F", so the image name is stored at [[Module:Portal/images/f]]. If there is an entry for a portal on the correct page then the corresponding image will be shown next to the portal link. If no image is found then [[:File:Portal-puzzle.svg]] will be shown instead. | The portal image names are stored in subpages of [[Module:Portal/images]], organised by the first letter of the portal name. For example, the first letter of [[Portal:Fishing]] is "F", so the image name is stored at [[Module:Portal/images/f]]. If there is an entry for a portal on the correct page then the corresponding image will be shown next to the portal link. If no image is found then [[:File:Portal-puzzle.svg]] will be shown instead. | ||
| Line 107: | Line 107: | ||
{{cob}} | {{cob}} | ||
== Example == | |||
{| style="background:transparent;" | {| style="background:transparent;" | ||
|- | |- | ||
| Line 117: | Line 117: | ||
|} | |} | ||
== Parameters == | |||
{| class="wikitable" | {| class="wikitable" | ||
| Line 134: | Line 134: | ||
|} | |} | ||
== Maintenance == | |||
The following tracking category lists instances where the {{{type|template}}} is used incorrectly: | The following tracking category lists instances where the {{{type|template}}} is used incorrectly: | ||
* [[:Category:Portal templates without a parameter]] | * [[:Category:Portal templates without a parameter]] | ||
{{#ifeq: {{{type|}}} | module || | {{#ifeq: {{{type|}}} | module || | ||
== See also == | |||
{{Portal template list}} | |||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | | |||
<!--Categories below this line, please; interwikis at Wikidata--> | |||
< | |||
[[Category:Internal link templates]] | [[Category:Internal link templates]] | ||
[[Category:Wikipedia Portal navflags]] | [[Category:Wikipedia Portal navflags]] | ||
| Line 150: | Line 149: | ||
[[bn:টেমপ্লেট:Portal]] | [[bn:টেমপ্লেট:Portal]] | ||
</includeonly> | }}</includeonly> | ||
{{cot|TemplateData}} | {{cot|TemplateData}} | ||
<TemplateData> | <TemplateData> | ||
Revision as of 21:13, 24 August 2014
 | This is a documentation subpage for Template:Portal. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on 9,340,000+ pages, or roughly 141859% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
 | This template uses Lua: |
This template produces a box with links to a portal or to multiple portals. It is most often used in the "See also" section of an article.
Usage
- Basic usage
{{Portal |Portal 1 |Portal 2 |Portal 3 |... }}
- All options
{{Portal
| Portal 1
| Portal 2
| Portal 3
| ...
| left =
| margin =
| break =
| boxsize =
}}
Location
Within articles, this template is meant to be placed at the bottom of the article in the See also section. If there is no See also section, you can put it in the External links section instead; there is no need to create a new section just to house this template. If there is no External links section either, just put it below the article text in the place that seems most appropriate.
There are no particular rules about the placement of portals on other kinds of page.
Image
The portal image names are stored in subpages of Module:Portal/images, organised by the first letter of the portal name. For example, the first letter of Portal:Fishing is "F", so the image name is stored at Module:Portal/images/f. If there is an entry for a portal on the correct page then the corresponding image will be shown next to the portal link. If no image is found then File:Portal-puzzle.svg will be shown instead.
It is also possible to specify aliases for portal images. For example, the code {{portal|Detroit}} produces the same image as the code {{portal|Metro Detroit}}. The "Detroit" alias is found on the page Module:Portal/images/aliases.
The image-detection algorithm is case-insensitive. For example, the code {{portal|Detroit}} will produce the same image as the code {{portal|detroit}} (although the portal links will be different). Portal names are stored in lower case in the image subpages, and input is converted to lower case before being checked.
To add new images to the list, please make a protected edit request at Template talk:Portal to get an administrator to edit the correct subpage for you. Portal images must be either in the public domain or available under a free license that allows commercial reuse and derivative works; fair-use images are not acceptable.
List of image subpages
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Example
| Code | Result |
|---|---|
{{Portal|Science}}
|
Parameters
| Name | Value | Description |
|---|---|---|
1, 2, 3 ... |
The portal name, e.g. Literature |
The positional parameters specify the portals to be displayed. |
left |
yes |
If set to yes, the portal appears on the left side of the page instead of the right.
|
margin |
CSS margin value, e.g. 1.2em 3em 0.5em 1em |
This allows you to set a custom margin. All valid CSS margin values are accepted. |
break |
yes |
If set to yes, a line break is inserted after the portal name and before the word portal.
|
boxsize |
Size in pixels, e.g. 300 |
This sets a custom box width in pixels. |
Maintenance
The following tracking category lists instances where the template is used incorrectly:
See also
Portal content templates
- To display "selected content" on the portal main page
- {{Transclude list item excerpts as random slideshow}}—transcludes excerpts from recognized content lists, which are populated by a bot.
- {{Transclude random subpage}}—transcludes random portal subpage.
- {{Random portal component}}—transcludes random portal subpage.
- {{Random subpage}}—transcludes random portal subpages.
- To organize "selected content" on subpages
- {{Numbered subpages}}—outputs an automatic index, transcluding numbered subpages.
- {{Portal subpage}}—outputs a box linking to and transcluding a single subpage.
- {{Portal subpage inline}}—outputs an unordered list item linking to and transcluding a single subpage.
Main portal page formatting templates
- {{Box-header}}
- {{Box-header-plain}}
- {{Box-header-round}}
- {{Box-header-square}}
- {{Box-header-watch}}
- {{Box-footer}}
Templates that configure links
- {{Portal}}
- {{Portal bar}}
- {{Portal-inline}}
- {{Portals}}
- {{Portal-image}}
- {{Portals browsebar}}
- {{Related portals}}
- {{Related portals2}}
- {{Wikimedia for portals}}
Selected page templates, used on subpages of older portals
- {{Selected article}}
- {{Selected biography}}
- {{Selected business}}
- {{Selected DYK}}
- {{Selected ingredient}}
- {{Selected location}}
- {{Selected picture}}
- {{Selected product}}
- {{Selected publication}}
- {{Selected quote}}
- {{Selected recipe}}
- {{Selected X}}
Related templates
- {{Project template list}}
- {{Basic portal start page}} (deleted)—Used to create portal main pages.
- {{Random box-header subpage}}—randomized selection from {{Box-header/1}} to {{Box-header/42}}.
TemplateData
| ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
A template to create a list of portals
| ||||||||||||||||||||||||||||||||||||||||
