வார்ப்புரு:Short description/doc
This is a documentation subpage for வார்ப்புரு:Short description. It may contain usage information, பகுப்புகள் and other content that is not part of the original வார்ப்புரு page. |
This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Please do not use redirects/shortcuts for this template, as they cause problems with the short description editing gadget and other maintenance tools. |
This template uses Lua: |
வார்ப்புரு:Short description is used to add a short description (which can be edited from within Wikipedia) to a Wikipedia page. These descriptions appear in Wikipedia mobile searches and elsewhere, and help users identify the desired article.
Usage
[தொகு]{{Short description|Write your short description here}}
This should be limited to about 40 characters, as explained at WP:SDFORMAT, along with the other guidance at WP:SDCONTENT.
Parameters
[தொகு]TemplateData for Short description
Creates a short description, for a Wikipedia article, which is used in the Visual Editor to provide context on wikilinks.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Description | 1 | The short description of the article or 'none'.
| Content | required |
No replace? | 2 | Should be unused or 'noreplace'. Templates with noreplace will not replace a short description defined by an earlier template. Mainly for use within transcluded templates.
| String | optional |
pagetype | pagetype | The type of page. This puts it in the appropriate category - Things with short description. Normally unneeded, since handled through namespace detection.
| String | optional |
About writing good short descriptions
[தொகு]This page is about the short description template; it does not provide guidelines for writing a good short description. If you plan to use this template, you should make sure you read and follow the detailed guidance at WP:HOWTOSD. General information can be found at Wikipedia:Short description.
Template information
[தொகு]Eventually all articles should have a short description:
- by directly using this template, in which case the short description will be unique to the article
- transcluded in another template, such as a disambiguation template, where a generic short description is adequate for a large class of pages
- where the short description is assembled from data in an infobox
Automatically generated descriptions within templates should set the second parameter as noreplace
so they do not override any short descriptions specifically added to the transcluding article.
Short descriptions are not normally needed for non-article pages, such as redirects, but can be added if 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.
Short descriptions do not necessarily serve the same function as the Wikidata description for an item and they do not have to be the same, but some overlap is expected in many cases. Some Wikidata 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.