Editing Template:Address restricted/doc

{{Documentation subpage}}
<!-------------------------------------------------------------------
     Place categories where indicated at the bottom of this page,
     please; interwikis to Wikidata (see [[Wikipedia:Wikidata]]).
 -------------------------------------------------------------------->
{{tl|{{PAGENAME}}}} aims to facilitate standardization in [[National Register of Historic Places]] lists and articles by providing a uniform style for address restricted notations, and a common approach to explaining address restrictions to the general reader. It is ''not appropriate'' for use in any article not related to the National Register. (Click on "What links here" in the bar on the left to see examples where this template has been used.)

== Usage ==
#This template is designed for use in specific locations on target pages. In lists, it is best used in the {{para|address}} and/or {{para|city}} parameters of {{tl|NRHP row}}. In articles, it is most appropriate in the {{para|location}} parameter of {{tl|Infobox NRHP}}.
#Use the following syntax when placing this template in an article:<syntaxhighlight lang="wikitext">{{Address restricted}}</syntaxhighlight>or to set the optional {{para|notes}} and {{para|spell_archaeology}} parameters:<syntaxhighlight lang="wikitext">{{Address restricted|notes=1|spell_archaeology=1}}</syntaxhighlight>
#The redirects {{tl|AR NRHP}} and {{tl|Address Restricted}} are aliases for this template.
#While this template may be [[Wikipedia:Substitution|substituted]], substitution is not recommended, in order to keep all instances updated with future edits to the template.
#This template takes three optional parameters:
:*{{para|notes}} Setting this parameter to ''any'' value will split the footnote to place the explanatory portion in the article's "Notes" section and the citation in the article's "References" section.
:::*In order for this option to work as intended, the list or article must have a separate footnotes section populated using {{tl|notelist}}.
:::*<s>When multiple instances of <nowiki>{{Address restricted}}</nowiki> occur on the same page, then all instances must have this parameter set or not set uniformly. Otherwise, unintended repetitions and/or omissions will occur in the footnotes/references.</s> '''Do not use this option when multiple instances of <nowiki>{{Address restricted}}</nowiki> occur on the same page.'''
:*{{para|group}} Sets the [[WP:CITELABEL|group name]] for the explanatory portion of the footnote. This parameter is operative ''only'' if the {{para|notes}} parameter is set. Defaults to "lower-alpha".
:::*<nowiki>{{Address restricted}}</nowiki> calls {{tl|efn}} to generate the explanatory footnote. Editors should ensure they are familiar with the functioning of {{tl|efn}} and {{tl|notelist}} before using this parameter. See documentation for those two templates for details.
:*{{para|spell_archaeology}} Setting this parameter to ''any'' value will change the spelling of "archeological" in the explanatory note to "archaeological", in order to have consistent usage in any one article. The default spelling is "archeological", due to the use of that spelling in the National Register name of many address restricted sites.
:::*When multiple instances of <nowiki>{{Address restricted}}</nowiki> occur on the same page, then the setting or omission of this parameter in the ''first'' instance will override the setting or omission in all subsequent instances.

== Editing ==
This template makes use of sub-templates to deliver most of the textual content in the footnote. To edit the footnote, navigate to these sub-templates:
*{{tl|Address restricted/Explanatory note}} to edit the explanatory portion of the footnote (''i.e.'' the first two sentences)
*{{tl|Address restricted/Reference note}} to edit the citation component of the footnote
This content was placed in sub-templates in order to facilitate use of the {{para|notes}} parameter (see above).

<includeonly>{{Sandbox other||
<!-- Categories below here, interwikis to Wikidata. -->
[[Category:National Register of Historic Places templates]]
}}</includeonly>