Difference between revisions of "Template:Portal description/doc"
test>AfroThundr3007730 (navbox) |
test>Hildeoc (removed surplus blank lines) |
||
| Line 14: | Line 14: | ||
===Parameter=== | ===Parameter=== | ||
| − | |||
The parameter {{para|topic}} or {{para|1}} can be used to override the default topic display, which is the base pagename. This is primarily to disambiguate or clarity; while our portal names are as [[WP:CONCISE|concise]] as we can make them while still being recognizable, this is not alway ideal, descriptively. | The parameter {{para|topic}} or {{para|1}} can be used to override the default topic display, which is the base pagename. This is primarily to disambiguate or clarity; while our portal names are as [[WP:CONCISE|concise]] as we can make them while still being recognizable, this is not alway ideal, descriptively. | ||
| Line 21: | Line 20: | ||
;Code{{colon}} | ;Code{{colon}} | ||
:{{tlx|Portal description|the English language}}<br />{{in5}}or<br />{{tlx|Portal description|topic=the English language}} | :{{tlx|Portal description|the English language}}<br />{{in5}}or<br />{{tlx|Portal description|topic=the English language}} | ||
| − | |||
{{strong|Do not}} add a separate {{tlx|Short description}} template to the portal in attempt to override the default output of this template; use this template's parameter instead, or the page will have two conflicting short descriptions. If a different style of short description is necessary, ''replace'' {{tlx|Portal description}} with {{tlx|Short description}}, in which the full short description is required as the parameter. | {{strong|Do not}} add a separate {{tlx|Short description}} template to the portal in attempt to override the default output of this template; use this template's parameter instead, or the page will have two conflicting short descriptions. If a different style of short description is necessary, ''replace'' {{tlx|Portal description}} with {{tlx|Short description}}, in which the full short description is required as the parameter. | ||
==Viewing short descriptions== | ==Viewing short descriptions== | ||
| − | |||
To temporarily or permanently turn on inline display of short description content on Wikipedia pages, see [[Template:Short description/doc#Testing]]. | To temporarily or permanently turn on inline display of short description content on Wikipedia pages, see [[Template:Short description/doc#Testing]]. | ||
| Line 33: | Line 30: | ||
* [[Template:Short description]] | * [[Template:Short description]] | ||
| − | {{portal templates navbox}} | + | {{portal templates navbox}}<includeonly> |
| − | + | {{sandbox other|| | |
| − | <includeonly>{{sandbox other|| | ||
<!-- Categories below this line, please; interwikis at Wikidata --> | <!-- Categories below this line, please; interwikis at Wikidata --> | ||
| − | |||
}}</includeonly> | }}</includeonly> | ||
Revision as of 20:08, 8 December 2019
| This is a documentation subpage for Template:Portal description. It contains usage information, categories and other content that is not part of the original template page. |
Purpose
Adds standardized WP:Short description metadata to the portal.
Usage
Output
- Code this will output:
{{Short description|Wikipedia's portal for exploring content related to {{PAGENAME}}}}- Resulting description:
- Wikipedia's portal for exploring content related to Portal title
Parameter
The parameter |topic= or |1= can be used to override the default topic display, which is the base pagename. This is primarily to disambiguate or clarity; while our portal names are as concise as we can make them while still being recognizable, this is not alway ideal, descriptively.
- Example:
- Portal:English would get a default description of "Wikipedia's portal for exploring content related to English", which might be confusing to some readers (English culture and people? English history?).
- Code:
{{Portal description|the English language}}
or{{Portal description}}
Do not add a separate {{Short description}} template to the portal in attempt to override the default output of this template; use this template's parameter instead, or the page will have two conflicting short descriptions. If a different style of short description is necessary, replace {{Portal description}} with {{Short description}}, in which the full short description is required as the parameter.
Viewing short descriptions
To temporarily or permanently turn on inline display of short description content on Wikipedia pages, see Template:Short description/doc#Testing.