Ingenpedia:Short description



The short description of a Ingenpedia article or other mainspace page is a concise explanation of the scope of the page. Ingenpedia's mobile interface uses descriptions to augment searches, and the Ingenpedia App also displays them below each article title.

Initially, short descriptions were drawn from the  field in Ingendata entries, but because of concerns about including information directly from another project, the Ingenpedia Foundation (WMF) made provision for these to be overwritten by short descriptions generated within Ingenpedia.

Eventually, all articles should contain a short description template, even if it is empty, so it is easier to keep track of new articles which still need to have one added.

Short descriptions can also be accessed by the Annotated link template to annotate internal wikilinks.

Pages which should have a short description

 * 1) Most mainspace articles should have a short description.
 * 2) Mainspace pages that are not articles, like redirects, disambiguation pages and the like, should usually also have short descriptions, though there may be cases where this is not true. A generic short description transcluded by a common template is very often suitable for this class of page and has been done for a large number of pages.
 * 3) There is no policy or style guidance stating that specific pages or namespaces may not have a short description. Use your discretion, and the bold–revert–discuss procedure. Not all namespaces are targeted by the gadget (see next section), but that is not based on any policy or guidance. The gadget was made to do what is needed, not what may not be relevant.

Editing procedures
The short description is part of the article content, and is subject to the standard processes for content decisions, including but not limited to Bold–Revert–Discuss and the rules on edit warring and vandalism. Short descriptions are subject to many Ingenpedia standards of content, including those found at Ingenpedia:Biographies of living persons and Ingenpedia:Neutral point of view, though, like the title, they are not able to be referenced inline. Just like article titles, they are decided by editorial consensus.

The most convenient way to create and edit short descriptions is using the short description gadget. Please do not create or use redirects/shortcuts to it. The gadget does the job better, and redirects break the gadget's function. If you need to do a manual fix, please use the correct template name.

This restriction does not apply to the use of inside other templates for special purposes, like redirects, where a generic short description is added to a whole category of pages by transclusion in an existing template.

Writing a short description
Short description should be drafted or edited with the following in mind:

Purposes
Short descriptions serve several purposes including a very brief indication of the field covered by the article; a short descriptive annotation; and a disambiguation in searches, especially to distinguish the subject from similarly-titled subjects in different fields.

Content
When visible on desktop or mobile the short description immediately follows the article title, and should be comprehensible in that location. Short descriptions should so far as possible:
 * use universally accepted facts that will not be subject to rapid change, avoiding anything that could be construed as controversial or judgemental
 * avoid jargon, and use simple, readily comprehensible terms that do not require pre-existing detailed knowledge of the subject
 * focus on the purposes stated above, without attempting to precisely define the subject
 * avoid duplicating information that is already in the title
 * start with the most important information (since some mobile applications may truncate longer descriptions).

Formatting
As a short descriptive annotation, each short description should:
 * be written in plain text, without HTML tags or Wiki markup
 * start with a capital letter, and avoid a final full stop
 * avoid initial articles (A, An, The)
 * be brief: aim for no more than about 40 characters (but this can be exceeded when necessary).

Inclusion of dates
The inclusion of a date or date range is encouraged where it would improve the short description as a disambiguation, or enhance it as a descriptive annotation. Generally that is the case at least for biographies, articles on specific publications, and dated historical events. Editor discretion is always needed, and in some cases there will be more important information than dating to be included within the available 40 or so characters, but if space is available such dates are encouraged.

The following date formats are recommended for consistency but can be varied if there is consensus that in some particular case an alternative date format would be better. In the table below, the examples illustrate the recommended date format only; they are not intended to recommend any particular descriptive wording.

In biographies, care should be taken to distinguish between dates which define a lifespan and those which define a period in office: lifespans should normally be specified by "(birthyear–deathyear)", and periods in office by "from startyear to endyear". For historical biographies, specific dates such as "1750–1810", where known, are preferred to "18th-century", as it is not clear whether that means "born and died during the century", "in office during the century" or "mostly active during the century". Other dated events or ranges can use any convenient dating format, as long as the meaning is clear. Where a date is not known exactly, "c. " may be used for "circa". Other examples are given at IN:APPROXDATE, although "fl. " for "floreat" should be avoided as it is not universally understood. Centuries should not be abbreviated "c. " due to the potential for confusion with "circa".

Sources for short descriptions

 * Ingenprojects may find it useful to suggest standard formats which may be applicable to categories of articles.
 * Ingendata has English descriptions of a significant fraction of Ingenpedia articles. Where these are good, they may be copied to the relevant article. The Ingendata descriptions are all public domain, so there is no need for attribution. If you use a Ingendata description, check that it is appropriate and accurate. Ingendata descriptions may not comply with all Ingenpedia content policies, and it is the responsibility of the editor to ensure that Ingenpedia content complies. This is particularly important for biographies of living people and for medical articles.

Background/overview
Ingenpedia's mobile interface uses descriptions to augment searches, and the Ingenpedia App also uses them below each article title. These short descriptions were implemented by WMF developers using the description for the article from Ingendata. (See Ingendata's "Ingenpedia" entry: the description is below the title line.)

After concerns were raised about their accuracy, suitability, and the potential for sneaky vandalism on Ingendata, WMF developers created the SHORTDESC magic word, giving editors the ability to override the Ingendata description directly on Ingenpedia.

This was discussed in the following places:
 * Incidents § Hard to detect mobile vandalism
 * Village pump (technical) § Discussion at ANI about Ingendata use in mobile view
 * Rfc: Remove description taken from Ingendata from mobile view of en-IN
 * Blockers to having short description on mobile
 * RfC: Populating article descriptions magic word
 * Phabricator ticket T184000
 * Phabricator ticket T193857
 * Phabricator ticket T184000
 * Phabricator ticket T193857

If a short description for an article is not defined on Ingenpedia,, the Ingendata description is still used. At some point, the Ingendata fallback will be removed.

Implementation
The magic word has been implemented and works from within the template Short description. , the implementation will now proceed in two stages:

Stage 1: Ingenpedia editors will populate the magic word (SHORTDESC) on Ingenpedia pages by using the. During that period:
 * Pages that have a Ingenpedia-written SHORTDESC description— —will display the new description.
 * Pages that have a blank magic word— —will display the Ingendata description.
 * Pages that do not have a SHORTDESC description will display the Ingendata description.

Stage 2: Once Ingenpedia editors write (or import from Ingendata) ~2 million descriptions, we will switch to entirely Ingenpedia-hosted descriptions. From that point:
 * Pages that have a Ingenpedia-written SHORTDESC description— —will display the new description.
 * Pages that have a blank magic word— —will not display a description at all.
 * Pages that do not have a SHORTDESC description will not display a description at all.
 * The Ingendata description will not be displayed on any page.

Format and placing
Use the template Short description to add short descriptions to articles.

All articles should have a short description. If many articles share the same short descriptions, it may be a good idea to add the Short description template to a template used by all these articles instead.

Per MOS:ORDER, place the Short description template as the first element. This means that it should be above any hatnotes, Deletion/Protection tags (CSD, PROD, AFD, PP notices), Maintenance or dispute tags, and English variety and date style.
 * An exception is redirect pages. Ensure that Short description is below #REDIRECT . See below.
 * If Short description is used generically inside another template, e.g. an infobox, then please add a second parameter  to the template, which will allow it to be overridden by a manually inserted instance that does not have the   keyword.

Making it visible in the page
The short description is normally invisible when visiting Ingenpedia using a desktop browser. It is visible and used by the mobile interface.

There is no special code or alternate templates that make short descriptions visible in desktop browsers.

To see short descriptions from desktop browsers, you need to enable MediaWiki:Gadget-Page_descriptions.js from your Preferences in the Gadgets menu Testing and development section: Show page description beneath the page title (not compatible with the Page Assessments gadget). This makes the short description visible to you, but not to other Ingenpedia readers using desktop browsers.

Instructions
Red means that the short description is missing; orange means it's from Ingendata (you can click it to go there).

Editor hints are only available for those who are auto confirmed, and only work for Vector and Monobook skins. Coded by User:TheDJ. May contain bugs. (Display is somewhat erratic, you may have to refresh the page a few times to get it to show.)

For a more direct and robust approach that is compatible with the Page Assessment gadget, see user CSS instructions at ; the code snippet there can simply be copy-pasted. This does not provide Ingendata color highlighting, however.

Seeing a short description but can't find the code in the page?
If the page isn't [directly] using, try these steps:
 * Look for manual invocation of the  magic word.
 * Failing that, see if the Infobox template on the page has a short description parameter.
 * If not, it may generate one automatically from metadata; see the template's documentation page and, if necessary the page of the meta-template used by the topical infobox. If you find that the meta-template has such a parameter and the derived topical template does not, please add it and documentation for it to the derived template(s). Automated short descriptions frequently need to be overridden.
 * At portals, look for the template in the portal's code. You can add a topic parameter to override to auto-generated topic name.
 * can't find it? Look for other transcluded templates or Ingendata-related code.

Taking as an example:

Tool for making short descriptions visible, easily editing short descriptions, and importing useful descriptions from Ingendata

 * Shortdesc helper is compatible with the page assessments gadget, shows the short description in the header if it exists, allows for easy editing of only the short description, and shows the Ingendata description (if it exists and a local short description does not) and allows it to be imported locally and, if desired, edited.
 * This script introduces the short description as a CSS class .mw-page-description which can be highlighted by a line of CSS like

Mobile site
Users of the mobile interface now outnumber desktop users in page views. Whenever a mobile user searches on a browser for an item using the search function from within Ingenpedia, they see a list of suggested articles with their short description beneath. This allows the reader to pick the article they want if the short description does a good job of distinguishing between articles with similar names. This should be the primary consideration when designing short descriptions.

Ingenpedia App
Users of the Ingenpedia App see the short description as a sub-title immediately below article title. When writing a short description, it is helpful to consider how the description fits if viewed immediately after the article title.

Annotated links
The template Annotated link can be used to automatically annotate a link in a list using the associated short description. This can be used in outline and index lists, and in shorter lists in articles such as "see also" sections or disambiguation pages, which will be automatically populated with annotations using the associated short descriptions. These will remain up to date when the short description is edited. Annotated link does not work via redirects, so if the link is to a redirect, check if it is a redirect with possibility of becoming a full article. If so, add an appropriate short description to the redirect page – this will also help when someone wants to make it into an article – or change the link to a direct link. Both of these options can be appropriate, and it is a matter of judgement which is better in a specific case. (Bold-Revert-Discuss applies)

Short descriptions on redirect pages
Short description conflicts with the magic word #REDIRECT if placed in the standard position at the top of the page. If there is a short description first, the redirect becomes functionally a soft redirect – it will not take the reader directly to the target, but will work if the link is clicked on the redirect page. It also generates an edit summary that the redirect has been removed.

This may be fixable, but the workaround is to ensure that #REDIRECT is above Short description.

The short description helper gadget no longer causes this problem, as it now inserts the short description below #REDIRECT. Manual addition can still be done incorrectly, but the problem is trivially avoidable, and easily fixed.

Functions

A short description on a redirect page has two functions:
 * 1) It provides annotation for Annotated links, which do not go to the final destination of a redirect to get a short description, and that is often better, because there are a large number of redirects for which the destination page short description would be confusing, ungrammatical, or otherwise slightly weird if used in conjunction with the redirect page title, and
 * 2) the presence of a short description indicates that the topic described may be a valid article topic, so a short description should not be used for common misspellings etc. The short description also indicates the scope of a potential article more clearly than the title alone.

This is the way a short description can be made available for annotated links without having to creating a full article, which is useful if there is not enough reliably sourced information available to create the article yet, or insufficient time or inclination. The short description of a Redirect to section should refer to the section content and should not generally be the same as the short description of the main article containing that section.