Template:SHORTDESC/doc: Difference between revisions
imported>Deadfire Doc creation |
Tungstenchan (talk | contribs) m Text replacement - "BattleTechWiki" to "BattleIntelligence" |
||
| Line 4: | Line 4: | ||
{{important|Please use '''<nowiki>{{SHORTDESC:description}}</nowiki> '''rather than {{tlf|{{BASEPAGENAME}}|description}}, with a colon (":"), not a pipe symbol ("|"). This uses the [[mw:Help:Magic words|magic word]] directly instead of using the template to call the magic word.}} | {{important|Please use '''<nowiki>{{SHORTDESC:description}}</nowiki> '''rather than {{tlf|{{BASEPAGENAME}}|description}}, with a colon (":"), not a pipe symbol ("|"). This uses the [[mw:Help:Magic words|magic word]] directly instead of using the template to call the magic word.}} | ||
{{tlc|{{BASEPAGENAME}}}} is not actually a template, but instead is a [[Help:Magic words|magic word]], meaning it is a feature of the MediaWiki software. When used, it sets the page's [[ | {{tlc|{{BASEPAGENAME}}}} is not actually a template, but instead is a [[Help:Magic words|magic word]], meaning it is a feature of the MediaWiki software. When used, it sets the page's [[BattleIntelligence:Short description|short description]]. | ||
The purpose of the template is to ensure that if someone uses this magic word with a piped parameter, the template code will be invoked and it will not cause an error on the page. Parameter 1 will be used as the : parameter and other parameters will be discarded. This way, if someone mistakenly enters {{tlc|{{BASEPAGENAME}}|American actor}}, the template will change it to the correct <code><nowiki>{{SHORTDESC:American actor}}</nowiki></code>. | The purpose of the template is to ensure that if someone uses this magic word with a piped parameter, the template code will be invoked and it will not cause an error on the page. Parameter 1 will be used as the : parameter and other parameters will be discarded. This way, if someone mistakenly enters {{tlc|{{BASEPAGENAME}}|American actor}}, the template will change it to the correct <code><nowiki>{{SHORTDESC:American actor}}</nowiki></code>. | ||
Latest revision as of 01:16, 1 May 2025
 | This is a documentation subpage for Template:SHORTDESC. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
 | Please use {{SHORTDESC:description}} rather than {{SHORTDESC|description}}, with a colon (":"), not a pipe symbol ("|"). This uses the magic word directly instead of using the template to call the magic word. |
{{SHORTDESC}} is not actually a template, but instead is a magic word, meaning it is a feature of the MediaWiki software. When used, it sets the page's short description.
The purpose of the template is to ensure that if someone uses this magic word with a piped parameter, the template code will be invoked and it will not cause an error on the page. Parameter 1 will be used as the : parameter and other parameters will be discarded. This way, if someone mistakenly enters {{SHORTDESC|American actor}}, the template will change it to the correct {{SHORTDESC:American actor}}.
When a user mistakenly includes a pipe in a {{SHORTDESC}} call, the template code will add the page to the hidden category Category:Pages which use a template in place of a magic word. Pages in this category should be fixed by willing editors.
Tracking category