View source for Template:Regions of France/doc

{{Heavily used template}}
{{TemplateBox
  |1        =prefix
  |1d-en    =prefix to use before the subdivision name in the generated link to the full target page name<!-- English description of the first parameter the template takes -->
  |1d-td    =prefix to use before the subdivision name in the generated link to the full target page name<!-- description of the first parameter the template takes without any wiki marking-->
  |1type    =string/wiki-page-name
  |1def     =<!-- default value for the parameter -->
  |1stat    =optional<!-- required, optional or optional-; optional- means it is optional and omitted in the usage-sample -->

  |2        =sep
  |2d-en    =default separator to use after the prefix or before the suffix in the generated link to the full target page name<!-- English description of the first parameter the template takes -->
  |2d-td    =default separator to use after the prefix or before the suffix in the generated link to the full target page name<!-- description of the first parameter the template takes without any wiki marking-->
  |2type    =string/wiki-page-name
  |2def     =(space)<!-- default value for the parameter -->
  |2stat    =optional<!-- required, optional or optional-; optional- means it is optional and omitted in the usage-sample -->

  |3        =presep
  |3d-en    =separator to use between the prefix and the subdivision name in the generated link to the full target page name<!-- English description of the first parameter the template takes -->
  |3d-td    =separator to use between the prefix and the subdivision name in the generated link to the full target page name<!-- description of the first parameter the template takes without any wiki marking-->
  |3type    =string/wiki-page-name
  |3def     =value of sep<!-- default value for the parameter -->
  |3stat    =optional-<!-- required, optional or optional-; optional- means it is optional and omitted in the usage-sample -->

  |4        =sufsep
  |4d-en    =separator to use between the subdivision name and the suffix in the generated link to the full target page name<!-- English description of the first parameter the template takes -->
  |4d-td    =separator to use between the subdivision name and the suffix in the generated link to the full target page name<!-- description of the first parameter the template takes without any wiki marking-->
  |4type    =string/wiki-page-name
  |4def     =value of sep<!-- default value for the parameter -->
  |4stat    =optional-<!-- required, optional or optional-; optional- means it is optional and omitted in the usage-sample -->

  |5        =suffix
  |5d-en    =suffix to use after the subdivision name in the generated link to the full target page name<!-- English description of the first parameter the template takes -->
  |5d-td    =suffix to use after the subdivision name in the generated link to the full target page name<!-- description of the first parameter the template takes without any wiki marking-->
  |5type    =string/wiki-page-name
  |5def     =<!-- default value for the parameter -->
  |5stat    =optional<!-- required, optional or optional-; optional- means it is optional and omitted in the usage-sample -->

  |6        =showcode
  |6d-en    =set a non-empty value in order to display the subdivision code after the subdivision name<!-- English description of the first parameter the template takes -->
  |6d-td    =set a non-empty value in order to display the subdivision code after the subdivision name<!-- English description of the first parameter the template takes -->
  |6type    =string
  |6def     =<!-- default value for the parameter -->
  |6stat    =optional<!-- required, optional or optional-; optional- means it is optional and omitted in the usage-sample -->

  |7        =all
  |7d-en    =normally not used, this can be set temporarily to a non-empty value in order to display links to all possible subdivision names (including their known aliases), without checking for their existence<!-- English description of the first parameter the template takes -->
  |7d-td    =normally not used, this can be set temporarily to a non-empty value to display links in order to all possible subdivision names (including their known aliases), without checking for their existence<!-- English description of the first parameter the template takes -->
  |7type    =string
  |7stat    =optional<!-- required, optional or optional-; optional- means it is optional and omitted in the usage-sample -->

  |name               =Regions of France
  |desc               =
  |namespace          =
  |usergroup          =
  |placement          =
  |example-value      =
  |mustbesubst        =
  |relieson           =
  |usage-notes        =
  |shorthand          =
  |setscats           =
  |seealso            = * ''See [[Template:Countries of Africa/doc#Templates and country data]] for a list of similar templates of other regions.''
  |type               = navbox
  |i18n-desc          =
  |i18n-subpage       =
  |i18n-mediawiki-msg =
  |i18n-method        =
  |print              =
}}

== Examples showing only labels ==
* <code><nowiki>{{</nowiki>{{<noinclude>BASE</noinclude>PAGENAME}}<nowiki>|prefix=:Category:|showcode=|all=}}</nowiki></code>
{{{{<noinclude>BASE</noinclude>PAGENAME}}|prefix=:Category:|showcode=|all=}}
* <code><nowiki>{{</nowiki>{{<noinclude>BASE</noinclude>PAGENAME}}<nowiki>|prefix=:Category:|showcode=|all=1}}</nowiki></code>
{{{{<noinclude>BASE</noinclude>PAGENAME}}|prefix=:Category:|showcode=|all=1}}

== Examples showing labels with codes ==
* <code><nowiki>{{</nowiki>{{<noinclude>BASE</noinclude>PAGENAME}}<nowiki>|prefix=:Category:|showcode=1|all=}}</nowiki></code>
{{{{<noinclude>BASE</noinclude>PAGENAME}}|prefix=:Category:|showcode=1|all=}}
* <code><nowiki>{{</nowiki>{{<noinclude>BASE</noinclude>PAGENAME}}<nowiki>|prefix=:Category:|showcode=1|all=1}}</nowiki></code>
{{{{<noinclude>BASE</noinclude>PAGENAME}}|prefix=:Category:|showcode=1|all=1}}

== See also ==
* [[Module:Regions of France]]
* [[Module:Countries]]

<includeonly>
<!--[[Category:Internationalization templates using LangSwitch]]-->
[[Category:Navigational templates for politics of Europe|Regions of France]]
[[Category:Category navigational templates for France|Regions]]
[[Category:Regions of France|~Template]]
[[Category:Category navigational templates for country subdivision|France, Regions]]
</includeonly>