Difference between revisions of "Module:Region topic/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>SiBr4
(Category)
blackwiki>SiBr4
(Starting expansion)
Line 1: Line 1:
 
{{Module rating|alpha}}
 
{{Module rating|alpha}}
  
This module contains the main code for Lua-based continent-/region-topic navboxes. It should be used only from other templates, using the following syntax:
+
This module contains the main code for Lua-based [[Template:About continent and region topic templates|continent-/region-topic navboxes]].
 +
 
 +
==Usage==
 +
To create a customizable navbox based on this module, create a wrapper template invoking it with the parameters "data" and "name":
 
  {{((}}#invoke:Region topic|main
 
  {{((}}#invoke:Region topic|main
  |data = ''Page name of data module''
+
  |data = Module:<var>DataPageName</var>
  |name = {{param|name|''Template name''|nested=yes}}
+
  |name = {{param|name|{{((}}subst:PAGENAME{{))}}|nested=yes}}
 
  {{))}}
 
  {{))}}
 +
{{para|name}} is necessary for correct [[Template:Navbar|"V•T•E" links]]; the parameter {{param|name}} allows creation of [[Template:About continent and region topic templates#Creating a new template|further wrapper templates]]. {{para|data}} is the page name of the data module for the region names and other options.
  
 
==See also==
 
==See also==
*[[Template:About continent and region topic templates]] &ndash; general documentation of continent-topic templates
 
 
*Sandboxes using this module: {{hlist|style=display:inline-block;|[[Template:Africa topic/sandbox|Africa topic]]|[[Template:Asia topic/sandbox|Asia topic]]|[[Template:Europe topic/sandbox 2|Europe topic]]|[[Template:North America topic/sandbox|North America topic]]|[[Template:Oceania topic/sandbox|Oceania topic]]|[[Template:South America topic/sandbox|South America topic]]|[[Module:Region topic/tests|/tests]]}}
 
*Sandboxes using this module: {{hlist|style=display:inline-block;|[[Template:Africa topic/sandbox|Africa topic]]|[[Template:Asia topic/sandbox|Asia topic]]|[[Template:Europe topic/sandbox 2|Europe topic]]|[[Template:North America topic/sandbox|North America topic]]|[[Template:Oceania topic/sandbox|Oceania topic]]|[[Template:South America topic/sandbox|South America topic]]|[[Module:Region topic/tests|/tests]]}}
 
*[[Wikipedia:Lua/Requests/Archive 5#Re-write Template:World topic as a Lua module]]
 
*[[Wikipedia:Lua/Requests/Archive 5#Re-write Template:World topic as a Lua module]]

Revision as of 19:30, 24 March 2016

This module contains the main code for Lua-based continent-/region-topic navboxes.

Usage

To create a customizable navbox based on this module, create a wrapper template invoking it with the parameters "data" and "name":

{{#invoke:Region topic|main
|data = Module:DataPageName
|name = {{{name|{{subst:PAGENAME}}}}}
}}

|name= is necessary for correct "V•T•E" links; the parameter {{{name}}} allows creation of further wrapper templates. |data= is the page name of the data module for the region names and other options.

See also