Difference between revisions of "Template:Abbreviations/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Colapeninsula
m (20 revisions imported)
 
(12 intermediate revisions by 10 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 +
{{Tsh|Abbrev}}
 +
{{Distinguish|Template:Abbreviation}}
 +
{{Redir|Template:Abbrev|the text formatting template that creates a tooltip that explains an abbreviation|Template:Abbr}}
  
This template should be used when the article appears to have abbreviations that may be confusing to the layman, or even to everyone.
+
This template should be used when the article appears to have abbreviations that may be confusing to the layman, or even to everyone. See [[WP:Manual of Style#Acronyms and abbreviations]] for the styleguide, and use {{tl|abbr}} for the mouseover-definition template.
  
 
==Placement==
 
==Placement==
Line 9: Line 12:
 
==Usage==
 
==Usage==
 
;articles
 
;articles
* For articles needing major clean-up, place {{tlx|abbreviations|article}} at the top of the main page to alert readers.
+
* For articles needing major clean-up, place {{tlx|abbreviations|article}} at the top of the ''main page'' to alert readers.
* For articles needing minor clean-up, place {{tlx|abbreviations|article}} at the top of the talk page to alert editors.
+
* For articles needing minor clean-up, place {{tlx|abbreviations|article}} at the top of the ''talk page'' to alert editors.
  
 
;sections
 
;sections
Line 17: Line 20:
 
;remarks
 
;remarks
 
* The default words "'''article or section'''" are replaceable so you can specify whether the template applies to the whole article or just a section, eg."<nowiki>{{abbreviations|section}}</nowiki>".
 
* The default words "'''article or section'''" are replaceable so you can specify whether the template applies to the whole article or just a section, eg."<nowiki>{{abbreviations|section}}</nowiki>".
* To replace the default text "'''abbreviations'''", you may use {{tlx|abbreviations|article/section|yourtext}} or {{tlx|abbreviations|2&#61;yourtext}}
+
* To point out specific abbreviations, you may use {{tlx|abbreviations|article/section|yourexamples}} or {{tlx|abbreviations|2&#61;yourexamples}}
 
* You may use the optional date parameter, e.g. <code><nowiki>{{abbreviations|</nowiki>date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></code>. This helps with the categorization of articles requiring attention.
 
* You may use the optional date parameter, e.g. <code><nowiki>{{abbreviations|</nowiki>date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></code>. This helps with the categorization of articles requiring attention.
 
* The simplest way to add this template to an article is to copy and paste<code> <nowiki>{{abbreviations|</nowiki>date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></code> at the top of the article or talk page.
 
* The simplest way to add this template to an article is to copy and paste<code> <nowiki>{{abbreviations|</nowiki>date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></code> at the top of the article or talk page.
 
* Add a new item to the talk page explaining the problem so editors will know what to address, and when to remove this tag.
 
* Add a new item to the talk page explaining the problem so editors will know what to address, and when to remove this tag.
* This template adds articles to [[:Category:Wikipedia articles needing style editing]]
 
  
 
==Notes==
 
==Notes==
*This template will add tagged articles to [[:Category:Wikipedia articles needing style editing]].
+
*This template will add tagged articles to dated subcategories of [[:Category:Wikipedia articles with style issues by month]] and to [[:Category:All articles with style issues]].
*This [[Wikipedia:Template|template]] is a [[Wikipedia:Avoid self-references|self-reference]].
+
* This [[Wikipedia:Template|template]] is a [[Wikipedia:Avoid self-references|self-reference]].
 
* Please do not [[Wikipedia:Subst|subst:]] this template.
 
* Please do not [[Wikipedia:Subst|subst:]] this template.
 
 
==Redirects==
 
#{{Tl|Abbrev}}
 
  
 
==See also==
 
==See also==
 
* [[Wikipedia:Template messages/Cleanup]]
 
* [[Wikipedia:Template messages/Cleanup]]
* [[Template:Expand acronym]]
+
* {{tl|Expand acronym}} – an inline template used to mark a specific term
 +
* {{tl|Abbr}} and {{tl|Abbrlink}}
  
<includeonly>
+
<includeonly>{{Sandbox other||
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
[[Category:Cleanup templates|{{PAGENAME}}]]
 
[[Category:Cleanup templates|{{PAGENAME}}]]
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
  
</includeonly>
+
[[sl:Predloga:Pomanjkljive kratice]]
 +
}}</includeonly>

Latest revision as of 15:05, 16 October 2020

Template:Redir

This template should be used when the article appears to have abbreviations that may be confusing to the layman, or even to everyone. See WP:Manual of Style#Acronyms and abbreviations for the styleguide, and use {{abbr}} for the mouseover-definition template.

Placement

Place at the top of the article and/or sections to alert editors.

Usage

articles
  • For articles needing major clean-up, place {{abbreviations|article}} at the top of the main page to alert readers.
  • For articles needing minor clean-up, place {{abbreviations|article}} at the top of the talk page to alert editors.
sections
  • To mark specific sections instead of the whole article, place {{abbreviations|section}} at the top of the section.
remarks
  • The default words "article or section" are replaceable so you can specify whether the template applies to the whole article or just a section, eg."{{abbreviations|section}}".
  • To point out specific abbreviations, you may use {{abbreviations|article/section|yourexamples}} or {{abbreviations|2=yourexamples}}
  • You may use the optional date parameter, e.g. {{abbreviations|date=November 2025}}. This helps with the categorization of articles requiring attention.
  • The simplest way to add this template to an article is to copy and paste {{abbreviations|date=November 2025}} at the top of the article or talk page.
  • Add a new item to the talk page explaining the problem so editors will know what to address, and when to remove this tag.

Notes

See also