Difference between revisions of "Module:Attached KML/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Evad37
(→‎Usage: is called by)
blackwiki>Evad37
(→‎Set up on another wiki: better code for setting up template; add step for creating categories)
Line 6: Line 6:
 
== Set up on another wiki ==
 
== Set up on another wiki ==
 
# Create template and module
 
# Create template and module
#* Import this module to that wiki (or copy the code over, giving attribution in the edit summary). Give the module a name that makes sense in that wiki's language (hereafter referred to as <span style="font-style: italic; color: #008560;">MODULENAME</span>
+
#* Import this module to that wiki (or copy the code over, giving attribution in the edit summary). Give the module a name that makes sense in that wiki's language (hereafter referred to as <span style="font-style: italic; color: #008560;">MODULENAME</span>)
#* Create a template (which should probably have the same name as the module) containing the code <code><nowiki>{{#invoke:</nowiki><span style="font-style: italic; color: #008560;">MODULENAME</span><nowiki>|main}}</nowiki></code>
+
#* Create a template (which should probably have the same name as the module, but referred to here as <span style="font-style: italic; color: #008560;">TEMPLATENAME</span>) containing the code <code><nowiki><includeonly>{{#invoke:</nowiki><span style="font-style: italic; color: #008560;">MODULENAME</span><nowiki>|main}}</includeonly><noinclude>{{</nowiki><span style="font-style: italic; color: #008560;">TEMPLATENAME</span><nowiki>|demo=yes}}{{Documentation}}</noinclude></nowiki></code>
 
#* On Wikidata, add the template to [[d:Q6690822]] and the module to [[d:Q26689774]]
 
#* On Wikidata, add the template to [[d:Q6690822]] and the module to [[d:Q26689774]]
 
# Localise the module. Edit the top bits of the module, between the comments <code>-- ##### Localisation (L10n) settings #####</code> and <code>-- #### End of L10n settings ####</code>, replacing values between <code>"</code> <code>"</code> symbols with local values (as necessary)
 
# Localise the module. Edit the top bits of the module, between the comments <code>-- ##### Localisation (L10n) settings #####</code> and <code>-- #### End of L10n settings ####</code>, replacing values between <code>"</code> <code>"</code> symbols with local values (as necessary)
 +
# Create the categories defined in the module localisation. These should be made hidden categories, either by including a {{Q|Q5879327}} template, or by directly including the <code><nowiki>__HIDDENCAT__</nowiki></code> [[mw:Help:Magic words|magic word]].
 
# Add documentation to the template (e.g. by translating [[Template:Attached KML/doc]], adjusting as necessary per any localisations made in the previous step) and to the module (please transfer/translate these instructions so that wikimedians who read your wiki but not the English Wikipedia can also set up the module and template on another wiki).
 
# Add documentation to the template (e.g. by translating [[Template:Attached KML/doc]], adjusting as necessary per any localisations made in the previous step) and to the module (please transfer/translate these instructions so that wikimedians who read your wiki but not the English Wikipedia can also set up the module and template on another wiki).
  

Revision as of 12:06, 25 September 2016

Usage

On English Wikipedia, this module is called by {{Attached KML}}, see that template's documentation for usage instructions

Set up on another wiki

  1. Create template and module
    • Import this module to that wiki (or copy the code over, giving attribution in the edit summary). Give the module a name that makes sense in that wiki's language (hereafter referred to as MODULENAME)
    • Create a template (which should probably have the same name as the module, but referred to here as TEMPLATENAME) containing the code <includeonly>{{#invoke:MODULENAME|main}}</includeonly><noinclude>{{TEMPLATENAME|demo=yes}}{{Documentation}}</noinclude>
    • On Wikidata, add the template to d:Q6690822 and the module to d:Q26689774
  2. Localise the module. Edit the top bits of the module, between the comments -- ##### Localisation (L10n) settings ##### and -- #### End of L10n settings ####, replacing values between " " symbols with local values (as necessary)
  3. Create the categories defined in the module localisation. These should be made hidden categories, either by including a Lua error in Module:Wd at line 196: attempt to index field 'wikibase' (a nil value). (Q5879327) template, or by directly including the __HIDDENCAT__ magic word.
  4. Add documentation to the template (e.g. by translating Template:Attached KML/doc, adjusting as necessary per any localisations made in the previous step) and to the module (please transfer/translate these instructions so that wikimedians who read your wiki but not the English Wikipedia can also set up the module and template on another wiki).