Template:Portal description/doc

Jump to navigation Jump to search

Purpose[edit source]

Adds standardized SF:Short description metadata to the portal.

Usage[edit source]

{{Portal description}}

Output[edit source]

Code this will output:
{{Short description|Starfleet Logistics's portal for exploring content related to {{PAGENAME}}}}
Resulting description:
Starfleet Logistics's portal for exploring content related to Portal title

Parameter[edit source]

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 "Starfleet Logistics'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[edit source]

To temporarily or permanently turn on inline display of short description content on Starfleet Logistics pages, see Template:Short description/doc#Testing.

See also[edit source]

External links[edit source]