View source for Template:Portal description/doc

{{Documentation subpage}}
{{auto short description}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
==Purpose==
Adds standardized [[WP:Short description]] metadata to the portal.

==Usage==
{{tlx|Portal description}}

===Output===
;Code this will output{{colon}}
:<code><nowiki>{{Short description|Wikipedia portal for content related to {{PAGENAME}}}}</nowiki></code>
;Resulting description{{colon}}
:Wikipedia's portal for exploring content related to {{var|Portal title}}

===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 always ideal, descriptively.

;Example{{colon}}
:[[Portal:English]] would get a default description of "Wikipedia portal for content related to English", which might be confusing to some readers (English culture and people? English history?).
;Code{{colon}}
:{{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.

==Viewing short descriptions==
To temporarily or permanently turn on inline display of short description content on Wikipedia pages, see [[Template:Short description/doc#Testing]].

==See also==
* [[Wikipedia:Short description]]
* [[Template:Short description]]

{{portal templates navbox}}<includeonly>
{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
}}</includeonly>