.svg)
16,952
edits
Template:Short description/doc: Difference between revisions
Template:Short description/doc (view source)
Revision as of 10:27, 5 December 2023
, 5 December 2023clean up
No edit summary |
CleanupBot (talk | contribs) m (clean up) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{High risk|all-pages = yes}} | {{High risk|all-pages = yes}} | ||
{{Warning|'''Please do not use redirects/shortcuts for this template''', as they cause problems with the [[ | {{Warning|'''Please do not use redirects/shortcuts for this template''', as they cause problems with the [[Bharatpedia:Shortdesc helper|short description editing gadget]] and other maintenance tools.}} | ||
{{Lua|Module:Check for unknown parameters|Module:String}} | {{Lua|Module:Check for unknown parameters|Module:String}} | ||
'''[[Template:Short description]]''' is used to add a [[ | '''[[Template:Short description]]''' is used to add a [[Bharatpedia:Short description|short description]] (which can be edited from within Bharatpedia) to a Bharatpedia page. These descriptions appear in Bharatpedia searches and elsewhere, and help users identify the desired article. | ||
== Usage == | == Usage == | ||
{{tld|Short description|''Write your short description here''}} | {{tld|Short description|''Write your short description here''}} | ||
This should be limited to about 40 characters, as explained at [[ | This should be limited to about 40 characters, as explained at [[BP:SDFORMAT]], along with the other guidance at [[BP:SDCONTENT]]. | ||
== Parameters == | == Parameters == | ||
| Line 16: | Line 16: | ||
{ | { | ||
"description": { | "description": { | ||
"en": "Creates a short description for a | "en": "Creates a short description for a Bharatpedia page, which is displayed in search results and other locations.", | ||
"es": "Crea una breve descripción, para un artículo de | "es": "Crea una breve descripción, para un artículo de Bharatpedia, que se utiliza en el Editor Visual para proporcionar contexto en los wikilinks (wikienlaces)." | ||
}, | }, | ||
"params": { | "params": { | ||
| Line 70: | Line 70: | ||
== About writing good short descriptions == | == About writing good short descriptions == | ||
This page is about the short description {{em|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 [[ | This page is about the short description {{em|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 [[BP:HOWTOSD]]. General information can be found at [[Bharatpedia:Short description]]. | ||
== Template information == | == Template information == | ||
| Line 84: | Line 84: | ||
If the article title alone is sufficient to ensure reliable identification of the desired article, a null value of {{tnull|Short description|none}} may be used. | If the article title alone is sufficient to ensure reliable identification of the desired article, a null value of {{tnull|Short description|none}} may be used. | ||
Short descriptions do not necessarily serve the same function as the | Short descriptions do not necessarily serve the same function as the Bharatdata description for an item and they do not have to be the same, but some overlap is expected in many cases. Some Bharatdata 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. {{crossref|(See also [[d:Help:Description|Bharatdata:Help:Description]].)}} | ||
=== Example === | === Example === | ||
| Line 112: | Line 112: | ||
* {{tld|Short description/test}} displays the short description if supplied | * {{tld|Short description/test}} displays the short description if supplied | ||
* {{tld|Short description/test}} displays nothing if <code>none</code> is supplied | * {{tld|Short description/test}} displays nothing if <code>none</code> is supplied | ||
* {{tld|Short description/test}} displays the description from | * {{tld|Short description/test}} displays the description from Bharatdata if <code>wikidata</code> is supplied. | ||
Taking {{Q|Q1096878}} as an example: | Taking {{Q|Q1096878}} as an example: | ||
| Line 130: | Line 130: | ||
== Aliases == | == Aliases == | ||
{{shortcut| | {{shortcut|BP:SDNOALIASES}} | ||
While there are currently <span class="plainlinks">[{{fullurl:Special:WhatLinksHere/Template:Short_description|hidetrans=1&hidelinks=1&limit=500}} redirects to this template]</span>, '''they must not be used''', for the reasons below: | While there are currently <span class="plainlinks">[{{fullurl:Special:WhatLinksHere/Template:Short_description|hidetrans=1&hidelinks=1&limit=500}} redirects to this template]</span>, '''they must not be used''', for the reasons below: | ||
| Line 141: | Line 141: | ||
* {{clc|Templates that generate short descriptions}} | * {{clc|Templates that generate short descriptions}} | ||
* {{clc|Modules that create a short description}} | * {{clc|Modules that create a short description}} | ||
* {{clc|Short description matches | * {{clc|Short description matches Bharatdata}} | ||
* {{clc|Short description is different from | * {{clc|Short description is different from Bharatdata}} | ||
* {{clc|Short description with empty | * {{clc|Short description with empty Bharatdata description}} | ||
== Maintenance categories == | == Maintenance categories == | ||
| Line 154: | Line 154: | ||
* {{tlx|Annotated link}} | * {{tlx|Annotated link}} | ||
* {{tlx|laal}} – displays an article's pagelinks alongside its short description | * {{tlx|laal}} – displays an article's pagelinks alongside its short description | ||
* [[ | * [[Bharatpedia:Short descriptions]] — background information | ||
* [[ | * [[Bharatpedia:WikiProject Short descriptions]] — project to add Short descriptions to all articles | ||
<includeonly>{{Sandbox other|| | <includeonly>{{Sandbox other|| | ||
<!-- Categories below this line, please; interwikis at | <!-- Categories below this line, please; interwikis at Bharatdata --> | ||
<!-- Category:Articles with short description (maintenance category)? --> | <!-- Category:Articles with short description (maintenance category)? --> | ||
[[Category:Templates that add a tracking category]] | [[Category:Templates that add a tracking category]] | ||
[[Category:Templates that generate short descriptions]] | [[Category:Templates that generate short descriptions]] | ||
}}</includeonly> | }}</includeonly> | ||