Difference between revisions of "Template:US"

From Bogleheads
Jump to navigation Jump to search
m (Readability spacing renders a space before full-stop; remove it.)
m (Update for moved category: 'Pages not applicable to Non-US investors' -> 'Pages not intended for non-US investors'.)
 
Line 10: Line 10:
 
   }}<!--
 
   }}<!--
 
-->{{#if: {{{NonUSlink| {{{non-US_link| {{{3|}}} }}} }}} |&#32;{{#ifeq: {{#invoke:string| match| {{{reason| {{{2|misleading}}} }}}| [%w_]+}}| none| [[:Category:Non-US domiciles|Non-US investors]]|Non-US investors}} can find related information at {{{NonUSlink| {{{non-US_link| {{{3|}}}}}}}}}.}}
 
-->{{#if: {{{NonUSlink| {{{non-US_link| {{{3|}}} }}} }}} |&#32;{{#ifeq: {{#invoke:string| match| {{{reason| {{{2|misleading}}} }}}| [%w_]+}}| none| [[:Category:Non-US domiciles|Non-US investors]]|Non-US investors}} can find related information at {{{NonUSlink| {{{non-US_link| {{{3|}}}}}}}}}.}}
}}<noinclude>{{Documentation}}</noinclude><includeonly>{{#if:{{NAMESPACE}}||[[Category:Pages not applicable to Non-US investors]]}}</includeonly>
+
}}<noinclude>{{Documentation}}</noinclude><includeonly>{{#if:{{NAMESPACE}}||[[Category:Pages not intended for non-US investors]]}}</includeonly>

Latest revision as of 13:03, 22 March 2021

Flag of the United States.svg.png This page contains details specific to United States (US) investors. It may not apply to non-US investors.
Template documentation[view] [edit] [history] [purge]

This template generates a hatnote for use at the top of pages or page sections where content is irrelevant, misleading, or harmful to non-US investors. In this context, "non-US investors" is taken to mean US nonresident aliens; that is, investors who are not US residents, not US citizens and not US green card holders.

Usage

Invoke with:

{{US|item = | reason = | non-US_link (or NonUSlink) = }}

All parameters are optional:

  • item: The text element to which this hatnote refers. Default is "article" in Main namespace, and "page" elsewhere.
  • reason: A specific reason for the hatnote. Enumerated. Default is "misleading". Value is one of
    • harmful: Appends "Acting on fund or ETF suggestions in it may have harmful US tax consequences for non-US investors.",
    • irrelevant: Appends "It does not apply to non-US investors."
    • misleading: Appends "It may not apply to non-US investors."
    • partially_irrelevant: Appends "Parts of it do not apply to non-US investors."
    • partially_misleading: Appends "Parts of it may not apply to non-US investors."
    • none: Appends nothing.
  • non-US_link: Appends "Non-US investors can find related information at (link)." This parameter accepts NonUSlink as an alternative name.

Parameters may also be supplied by position, in the order shown above. Mixing positional and named parameters in a single invocation becomes unclear. Use only one method or the other. This template adds pages in Main namespace to Category:Pages not intended for non-US investors.

Examples

General

Using {{US}} results in:

Flag of the United States.svg.png This page contains details specific to United States (US) investors. It may not apply to non-US investors.

Using {{US|reason=harmful}} results in:

Flag of the United States.svg.png This page contains details specific to United States (US) investors. Acting on fund or ETF suggestions in it may have harmful US tax consequences for non-US investors.

More precise

Using {{US|section}} results in:

Flag of the United States.svg.png This section contains details specific to United States (US) investors. It may not apply to non-US investors.

Using {{US|subsection|none}} results in:

Flag of the United States.svg.png This subsection contains details specific to United States (US) investors.

Using {{US|paragraph|harmful}} results in:

Flag of the United States.svg.png This paragraph contains details specific to United States (US) investors. Acting on fund or ETF suggestions in it may have harmful US tax consequences for non-US investors.

Using {{US|paragraph|harmful for non-US investors}} results in:

Flag of the United States.svg.png This paragraph contains details specific to United States (US) investors. Acting on fund or ETF suggestions in it may have harmful US tax consequences for non-US investors.

Using {{US|sentence|misleading}} results in:

Flag of the United States.svg.png This sentence contains details specific to United States (US) investors. It may not apply to non-US investors.

Using {{US|footnote|irrelevant}} results in:

Flag of the United States.svg.png This footnote contains details specific to United States (US) investors. It does not apply to non-US investors.

Using {{US|clause|partially_misleading}} results in:

Flag of the United States.svg.png This clause contains details specific to United States (US) investors. Parts of it may not apply to non-US investors.

Using {{US|postscript|partially_irrelevant}} results in:

Flag of the United States.svg.png This postscript contains details specific to United States (US) investors. Parts of it do not apply to non-US investors.

Using {{US|phrase|harmful|[[Outline of non-US domiciles]]}} results in:

Flag of the United States.svg.png This phrase contains details specific to United States (US) investors. Acting on fund or ETF suggestions in it may have harmful US tax consequences for non-US investors. Non-US investors can find related information at Outline of non-US domiciles.

Using {{US|item=appendix}} results in:

Flag of the United States.svg.png This appendix contains details specific to United States (US) investors. It may not apply to non-US investors.

Using {{US|item=discourse|NonUSlink=[[Getting started for non-US investors]]}} results in:

Flag of the United States.svg.png This discourse contains details specific to United States (US) investors. It may not apply to non-US investors. Non-US investors can find related information at Getting started for non-US investors.

Using {{US|item=essay|reason=harmful|non-US_link=[[Getting started for non-US investors]]}} results in:

Flag of the United States.svg.png This essay contains details specific to United States (US) investors. Acting on fund or ETF suggestions in it may have harmful US tax consequences for non-US investors. Non-US investors can find related information at Getting started for non-US investors.

Using {{US|item=treatise|reason=none|non-US_link=[[Getting started for non-US investors]]}} results in:

Flag of the United States.svg.png This treatise contains details specific to United States (US) investors. Non-US investors can find related information at Getting started for non-US investors.

Guidelines for use

Deciding whether to add this template to an article, and if yes, which options to use for that article, can be difficult. It is ultimately a judgement call. Some guidelines for how to go about this are shown below.

If this is too complex to unravel, as a general rule-of-thumb, if adding this template to an article, use {{US|reason=harmful}} for any articles that recommend specific US domiciled funds or ETFs, and {{US}} otherwise. Everything else is less important detail.

Guidelines and example pages:

  • Use: {{US}}
    • For: Articles that appear US-specific, but where none of the following use cases apply, or where it is unclear which might apply.
  • Use: {{US|reason=harmful}}
  • Use: {{US|reason=irrelevant}}
    • For: Articles covering topics that clearly have no relevance to non-US investors. US tax-shelter or tax-deferred plans, US social security payments, US tax brackets, and so on. Examples include IRA, 401k, and 529 plan. Relatively common in the wiki.
  • Use: {{US|reason=misleading}}
    • For: Articles that may mislead non-US investors into actions that make no sense outside of the context of US investors. Typically, an article that describes a topic without reference to US-only details, but where the article nevertheless relies on something US-specific. Index fund might be an example. It describes mutual funds in relatively country-agnostic terms, but assumes capital gains distributions, something that does not occur with non-US domiciled funds. ETFs vs mutual funds is another example. This class of article may be a candidate for applying {{US|item=section}} at the section level, or alternatively {{US|reason=partially_misleading}} at the article head.
  • Use: {{US|reason=partially_irrelevant}}
    • For: Articles with some content that is irrelevant to non-US investors, but where the bulk may be okay.
  • Use: {{US|reason=partially_misleading}}
    • For: Articles with some content that is misleading to non-US investors, but where the bulk may be okay. Exchange-traded fund might be a candidate. The general concepts of ETFs are country-agnostic, but this article merges them with US-specific information in a way that is difficult to separate out.
  • Use: {{US|reason=...|non-US_link=(link)}}
    • For: Articles where there is a related (but not specific) non-US article on the topic. Select reason=... as appropriate.
  • Use: {{US|reason=none|non-US_link=(link)}}
    • For: Articles where there is a specific non-US article on the topic. Getting started might be an example.
  • Use: {{US|item=section|...}}
    • For: Articles that are country-agnostic with the exception of one or more US-specific subsections. Apply to the section rather than to the article head.

See also