Difference between revisions of "Template:MOS/doc"

From blackwiki
Jump to navigation Jump to search
imported>Mr. Guye
(→‎Redirects: Replaced content with accurate info)
imported>SMcCandlish
(+cat.)
 
(4 intermediate revisions by 4 users not shown)
Line 14: Line 14:
  
 
===Placement===
 
===Placement===
Place at the top of the article to alert readers and editors that the article needs one or more kinds of non-trivial style cleanup throughout:
+
Place at the top of the article to alert editors that the article needs one or more kinds of non-trivial style cleanup throughout:
  
 
{{tlx|MOS|<nowiki>{{subst:DATE}}</nowiki>}}
 
{{tlx|MOS|<nowiki>{{subst:DATE}}</nowiki>}}
Line 24: Line 24:
  
 
===Parameters===
 
===Parameters===
* <code>|section</code> or {{para|1|section}} or {{para|section|y}} &ndash; changes the word "article" to "section" in the first sentence of the template.
+
====section====
* {{para|reason|{{var|text}}}} or {{para|2|{{var|text}}}} (or {{para|for|{{var|text}}}}, as used by {{tlx|Copyedit}}) &ndash; gives a particular reason in the form "In particular, it has problems with {{var|text}}.", e.g. "using unexplained acronyms", "capitalizing things that are not [[proper names]]", "[[MOS:ENGVAR|US/UK spelling]] consistency", etc.
+
* <code>|section</code> or {{para|1|section}} or {{para|section|y}} &mdash; changes the word "article" to "section" in the first sentence of the template.
* {{para|subpage|{{var|/MOS subpage name}}}} or {{para|subpage|{{var|#MOS subsection name}}}} or {{para|3|{{var|/MOS subpage name}}}} or {{para|3|{{var|#MOS subsection name}}}} &ndash; extends the MOS link to go directly to a more specific MOS subpage and/or subsection.  Examples: To have the template link to [[WP:Manual of Style/Icons]], use {{para|subpage|/Icons}}; for [[WP:Manual of Style#Ampersand]] use {{para|subpage|#Ampersand}}; for [[WP:Manual of Style/Capital letters#Proper names]] use {{para|subpage|/Capital letters#Proper names}}. {{strong|Note:}} This parameter is case-sensitive, and the proper <code>/</code> and <code>#</code> characters must be included for the link to work.
+
====reason====
* {{Para|shortcut|{{var|MOS: or WP: shortcut}}}} &ndash; for the rare case that a provision in the Manual of Style has a shortcut to it, but is not the subject of its own subpage or subsection for linking (i.e., there is no other way to link to it directly).  E.g., for the advice about capitalization of doctrines, at the bottom of the [[WP:Manual of Style/Capital letters#Religions, deities, philosophies, doctrines and their adherents section]], use {{para|shortcut|MOS:DOCTCAPS}}
+
* {{para|reason|{{var|text}}}} or {{para|2|{{var|text}}}} (or {{para|for|{{var|text}}}}, as used by {{tlx|Copyedit}}) &mdash; gives a particular reason in the form "In particular, it has problems with {{var|text}}.", e.g. "using unexplained acronyms", "capitalizing things that are not [[proper names]]", "[[MOS:ENGVAR|US/UK spelling]] consistency", etc.
 +
====subpage and subsection====
 +
* {{para|subpage|{{var|/MOS subpage name}}}} or {{para|subpage|{{var|#MOS subsection name}}}} or {{para|3|{{var|/MOS subpage name}}}} or {{para|3|{{var|#MOS subsection name}}}} &mdash; extends the MOS link to go directly to a more specific MOS subpage and/or subsection.  Examples: To have the template link to [[WP:Manual of Style/Icons]], use {{para|subpage|/Icons}}; for [[WP:Manual of Style#Ampersand]] use {{para|subpage|#Ampersand}}; for [[WP:Manual of Style/Capital letters#Proper names]] use {{para|subpage|/Capital letters#Proper names}}. {{strong|Note:}} Because subpages and section titles are [[case-sensitive]], this parameter is as well. The proper <code>/</code> and <code>#</code> characters must be included for the link to work.
 +
====shortcut====
 +
* {{Para|shortcut|{{var|MOS: or WP: shortcut}}}} &mdash; for the rare case that a provision in the Manual of Style has a shortcut to it, but is not the subject of its own subpage or subsection for linking (i.e., there is no other way to link to it directly).  E.g., for the advice about capitalization of doctrines, at the bottom of the [[WP:Manual of Style/Capital letters#Religions, deities, philosophies, doctrines and their adherents section]], use {{para|shortcut|MOS:DOCTCAPS}} .
  
 
==Notes==
 
==Notes==
*This template will add tagged articles to [[:Category:Articles needing MOS compliance]].
+
*This template will add tagged articles to [[:Category:Wikipedia 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.
Line 41: Line 45:
 
* [[Wikipedia:Template messages/Cleanup]]
 
* [[Wikipedia:Template messages/Cleanup]]
  
<includeonly>
+
<includeonly>{{Sandbox other||
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
[[Category:Cleanup templates|{{PAGENAME}}]]
 
[[Category:Cleanup templates|{{PAGENAME}}]]
 +
[[Category:Wikipedia Manual of Style templates]]
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
  
</includeonly>
+
}}</includeonly>

Latest revision as of 16:32, 20 November 2020

This template should be used when the article appears to use styles that may be confusing to the layman, or even to everyone.

Unless the tag is being placed in response to a discussion already underway, it is advisable to add a new topic to the talk page explaining the problem so editors will know what to address, and when to remove this tag.

Usage

Simple

{{MOS|{{subst:DATE}}}}

Giving a reason

{{MOS|{{subst:DATE}}|reason=not using logical quotation}}

Placement

Place at the top of the article to alert editors that the article needs one or more kinds of non-trivial style cleanup throughout:

{{MOS|{{subst:DATE}}}}

For articles needing only minor clean-up, place {{MOS|{{subst:DATE}}}} at the top of the article's talk page to alert editors.

Sections
  • To mark specific sections instead of the whole article, place {{MOS|section|{{subst:DATE}}}} at the top of the section.

Parameters

section

  • |section or |1=section or |section=y — changes the word "article" to "section" in the first sentence of the template.

reason

  • |reason=text or |2=text (or |for=text, as used by {{Copyedit}}) — gives a particular reason in the form "In particular, it has problems with text.", e.g. "using unexplained acronyms", "capitalizing things that are not proper names", "US/UK spelling consistency", etc.

subpage and subsection

  • |subpage=/MOS subpage name or |subpage=#MOS subsection name or |3=/MOS subpage name or |3=#MOS subsection name — extends the MOS link to go directly to a more specific MOS subpage and/or subsection. Examples: To have the template link to WP:Manual of Style/Icons, use |subpage=/Icons; for WP:Manual of Style#Ampersand use |subpage=#Ampersand; for WP:Manual of Style/Capital letters#Proper names use |subpage=/Capital letters#Proper names. Note: Because subpages and section titles are case-sensitive, this parameter is as well. The proper / and # characters must be included for the link to work.

shortcut

Notes

Redirects

  1. {{mos}}
  2. {{MOS1}}

See also