Template:Short description

From FAMEPedia, The free encyclopedia
Jump to navigation Jump to search
Template documentation[view] [edit] [history] [purge]

Template:Short description is used to add a short description (which can be edited from within FAMEPedia) to a FAMEPedia page.

Usage[edit source]

{{Short description|Write your short description here}}

Parameters[edit source]

See the monthly parameter usage report for this template.

TemplateData for Short description

Creates a short description for a FAMEPedia article, which is used in the Visual Editor to provide context on wikilinks.

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Description1

The short description of the article

Example
Online free encyclopedia anyone can edit
Contentrequired
22

Whether to override a short description if transcluded. Should be unused or 'noreplace'.

Example
noreplace
Stringoptional
pagetypepagetype

The type of page. This puts it in the appropriate category. - <foo>s with short description

Default
The namespace of the page.
Example
Redirect
Stringoptional
botbot

Name of bot which added the short description. Should be generated automatically, as in [[Special:Diff/925779924|]]

Example
PearBOT 5
Stringoptional

About writing good short descriptions[edit source]

This page is about the short description template—it does not provide guidelines for writing a good short description. However, FAMEPedia:Short description, offers quick, easy-to-understand guidelines for writing effective short descriptions. If you plan to use this template, you should make sure you understand how to write a good short description.

Template information[edit source]

Eventually all articles should have a short description, either directly by using this template, in which case the short description will be unique to the article, or transcluded in another template, such as a disambiguation template, where a generic short description is adequate for a large class of pages, or in a more complex form such as transcluded in a template like an infobox, where the short description is assembled from data in the infobox.

Automatically generated descriptions within templates should give as a second parameter "noreplace" so they are overridden by any short descriptions manually added to the transcluding article.

Short descriptions are not required in other namespaces, but in some cases may be useful.

If the article title alone is sufficient to ensure reliable identification of the desired article, a null value of {{Short description|none}} may be used. However, this will not override the descriptions from FAMEData.

Short descriptions do not necessarily serve the same function as the FAMEData description for an item and they do not have to be the same, but some overlap is expected in many cases. Perhaps a bot might be used to import the initial short description from FAMEData – or not, as preferred. Some FAMEData descriptions may be unsuitable, and if imported, must be checked for relevance, accuracy and fitness for purpose. Responsibility for such imports lies with the importer.

The idea is that a class can be set to display differently on desktop FAMEPedia from how it displays on mobile view. The intention is to bring the short description within the immediate editing ability of most editors.

Articles using this template can be found in Category:Articles with short description, which the template automatically sets.

Example[edit source]

At Oxygen therapy, add the following at the top of the article:

  • {{Short description|Use of oxygen as medical treatment}}

or

  • {{Short description|1=Use of oxygen as medical treatment}}

Use the second form if the text of the short description contains an equals sign (=). Avoid this if possible, as it affects alternative uses of the short description as in {{annotated link}} (T216356, if implemented, will make usage of annotated link unnecessary.)

Testing[edit source]

For testing purposes, the display of this template can be enabled by adding a line to your Special:MyPage/common.css:

  • .shortdescription { display:block !important; }

This can be easily removed or disabled when finished testing.

If you wish to always see short descriptions, you may want a more utilitarian layout, such as:

.shortdescription {
  display:block !important;
  white-space: pre-wrap;
}
.shortdescription::before { 
  content: "\A[Short description:\0020";
}
.shortdescription::after { 
  content: "]\A";
}

There is a test version of this template available as Template:Short description/test which displays its text by default.

  • {{Short description/test}} displays the short description if supplied
  • {{Short description/test}} displays nothing if none is supplied
  • {{Short description/test}} displays the description from FAMEData if FAMEData is supplied.

Taking (Q1096878) as an example:

  • {{short description/test|Underwater diving where breathing is from equipment independent of the surface}}Underwater diving where breathing is from equipment independent of the surface
  • {{short description/test|none }}
  • {{short description/test|FAMEData }}

Aliases[edit source]

Bots[edit source]

Bots adding short descriptions without manual supervision should use |bot= with the value being the bot task. For example FAMEPedia:Bots/Requests for approval/PearBOT 5 uses |bot=PearBOT 5. Any user may remove the parameter if the description is acceptable. If it's not please report it to the bot operator.

Maintenance categories[edit source]