View source for Template:Uw-mos1/doc

{{Documentation subpage}}
{{Templatesnotice/inner|param1=article|series = uw-mos|max = 4
  |hatnote=You may use this template to inform a user about a particular problem in their edit covered by the [[Wikipedia:Manual of style]]. Parameters {{para|issue}} and {{para|longissue}} are available to specify the exact nature of the problem.
  |extra usage={{pb}}

===Parameters===
There are two positional parameters and two named parameters, all optional:
* {{para|1}} – article
* {{para|2}} – additional text (default: {{pval|Thank you.}})
* {{para|issue}} – any shortcut in the [[WP:Manual of style]]; e.g., {{pval|MOS:CURLY}} appends "{{xt|Specifically, <nowiki>[[MOS:CURLY]]</nowiki>}}" to the message (see examples [[#Example1|1–3]]). If the value you provide is *not* an existing shortcut, then whatever value you type is appended to the message (see examples [[#Example7|7–8]]).
* {{para|longissue}} – if the value you provide matches a MOS section shortcut in the [[WP:MOS|Manual of style]] *AND* corresponds to an allowed value (see {{slink||Notes}}), the content of the corresponding section in {{t|Uw-mos1/reasons}} is appended to the message (see examples [[#Example4|4–6]]). (param alias: {{para|long}})

===Notes===
The value of {{para|issue}} may be any string. If it is an <span class=plainlinks>[https://en.wikipedia.org/w/index.php?search=MOS%3A+onlyredirects%3A&title=Special%3ASearch&profile=default&fulltext=1&sort=title_natural_asc existing MOS shortcut]</span>, it will be linked and added to the message. Otherwise, whatever value you provide is added to the message, as is.

The value of {{para|longissue}} must be a valid MOS shortcut, and must be a permitted value. Specify the value in all caps, and always include the {{pval|MOS:}} prefix; e.g.: {{para|longissue|MOS:BOLD}}, {{pval|MOS:CURLY}}, {{pval|MOS:TIES}}, etc. Any shortcut in the following list of permitted values comprising the most common MOS shortcuts may be used with {{para|longissue}} <small>(note that they are shown in lowercase below to avoid SHOUTING, and the '''MOS:''' prefix is dropped to save space)</small>:
{{cot|bg=#ccccff|bg2=#f0fdf4|fc=#555|indent=0.2em|Possible values for param <code>longissue</code>}}
{{hatnote|Click any link to see the words that will be added to the Uw-mos1 message for that param value:}}
{{Uw-mos1/reasons/Compact TOC|title='''Possible values for param <code>longissue</code>''' &nbsp; <small>(use upper-case, and prefix with 'MOS:')</small>}}
{{cob}}
If you want to use param {{para|longissue}} with a MOS shortcut that does not appear in the list, you can [[Template:Uw-mos1/reasons#Adding a new section|add a new section]] for it yourself.

If both {{para|issue}} and {{para|longissue}} are provided, the latter is ignored.

=== Examples===
{{cot|bg=#ccccff|bg2=#F0FDF4|fc=#555|indent=0.2em|Click [show] for examples}}
{{hatnote|These are working examples using {{t|Uw-mos1}}. Click [show] in each example to see the output.}}
{{cot|bg=khaki|align=left|{{anchor|Example1}}1. {{tlc|Uw-mos1|Underwater basket-weaving|issue{{=}}MOS:OVERLINK}}}}
{{hatnote|Param {{para|issue}} can be used to link an existing page or redirect. If the value you enter exists, it will be linked. It adds, {{xt|Specifically, [&#91;''MOS:Shortcut''&#93;]}} to the message. Typically, just place a shortcut redirect here, like, {{pval|MOS:CAPS}}, {{pval|MOS:NUM}}, etc. (enter the value without brackets)}}
{{Uw-mos1|Underwater basket-weaving|issue=MOS:OVERLINK |nosubst=y}}
{{cob}}
{{cot|bg=khaki|align=left|2. {{tlc|Uw-mos1|Underwater basket-weaving|issue{{=}}MOS:ERA}}}}
{{hatnote|The expression 'MOS:ERA' represents an existing page (which happens to be a redirect). It is linked and added to the message.}}
{{Uw-mos1|Underwater basket-weaving|issue=MOS:ERA |nosubst=y}}
{{cob}}
{{cot|bg=khaki|align=left|3. {{tlc|Uw-mos1|Star Trek|issue{{=}}MOS:ETHNICITY}}}}
{{hatnote|It adds, {{xt|Specifically, [&#91;''MOS:ETHNICITY''&#93;]}} to the message.}}
{{Uw-mos1|Star Trek|issue=MOS:ETHNICITY |nosubst=y}}
{{cob}}
{{cot|bg=khaki|align=left|{{anchor|Example4}}4. {{tlc|Uw-mos1|Underwater basket-weaving|longissue{{=}}MOS:INFOBOXFLAG}}}}
{{hatnote|If you use param {{para|longissue}} with a value that matches a section name in template configuration subpage {{t|Uw-mos1/reasons}}, then the value of that section will be substituted into the uw-mos1 message.}}
{{Uw-mos1|Underwater basket-weaving|longissue=MOS:INFOBOXFLAG |nosubst=y}}
{{cob}}
{{cot|bg=khaki|align=left|5. {{tlc|Uw-mos1|Underwater basket-weaving|longissue{{=}}MOS:SURNAME}}}}
{{hatnote|'MOS:SURNAME' is a section in {{t|Uw-mos1/reasons}}, so its value is substituted into the message.}}
{{Uw-mos1|Underwater basket-weaving|longissue=MOS:SURNAME |nosubst=y}}
{{cob}}
<!--
{{cot|bg=khaki|align=left|6. {{tlc|Uw-mos1|Underwater basket-weaving|long{{=}}MOS:RELTIME}}}}
{{hatnote|Param name {{para|long}} is a parameter alias of {{para|longissue}}, and means the same thing.}}
{{Uw-mos1|Underwater basket-weaving|long=MOS:RELTIME |nosubst=y}}
{{cob}}-->
{{cot|bg=khaki|align=left|6. {{tlc |Uw-mos1 |Underwater basket-weaving |long{{=}}MOS:REPEATLINK}}}}
{{hatnote|Param name {{para|long}} is a parameter alias of {{para|longissue}}, and means the same thing.}}
{{Uw-mos1/sandbox|Underwater basket-weaving |long=MOS:REPEATLINK |nosubst=y}}
{{cob}}
{{cot|bg=khaki|align=left|{{anchor|Example7}}7. {{tlc|Uw-mos1|Human Development Index |issue{{=}}Writing tables with conditional rows is...}}}}
{{hatnote|If you use param {{para|issue}} with a value that is not the pagename of an existing page, then whatever value you give for the param is substituted right into the uw-mos1 message. In this example, the value of param {{para|issue}} is:
* {{para|issue|Writing tables with conditional rows is tricky; for assistance, please see <nowiki>[[Help:Conditional tables]]</nowiki>.}}}}
{{Uw-mos1|Human Development Index |issue=Writing tables with conditional rows is tricky; for assistance, please see [[Help:Conditional tables]]. |nosubst=y}}
{{cob}}
{{cot|bg=khaki|align=left|8. {{tlc|Uw-mos1|Star Trek|issue{{=}}When writing about Klingons and Romulans, please...}}}}
{{hatnote|There is no page by the name 'When writing about Klingons...', so the content of param {{para|issue}} is inserted directly into the message. In this example, the value of param {{para|issue}} is:
* {{para|issue|When writing about Klingons and Romulans, please stick to the in-universe conceptions made by the original authors; adding your own is <nowiki>[[WP:OR]]</nowiki>.}}}}
{{Uw-mos1|Star Trek|issue=When writing about Klingons and Romulans, please stick to the in-universe conceptions made by the original authors; adding your own is [[WP:OR]]. |nosubst=y}}
{{cob}}
{{cob}}
<div style="margin-top:1em"></div>
}}
{{Multi notice links}}<includeonly>{{Sandbox other||
<!-- Categories below this line -->

}}</includeonly>