Difference between revisions of "Template:Location map/doc/Converting map definition templates to modules"

From blackwiki
Jump to navigation Jump to search
imported>Jackmcbarn
(→‎Converting definitions: make this copy and paste right)
imported>Jackmcbarn
(explain how to convert x,y)
Line 1: Line 1:
 
== Converting definitions ==
 
== Converting definitions ==
 
This checklist lists the steps required to convert a location map definition from a template to a module. In this example, the definition will be called "Foobar".
 
This checklist lists the steps required to convert a location map definition from a template to a module. In this example, the definition will be called "Foobar".
#Create [[Module:Location map/data/Foobar]] with the same values as [[Template:Location map Foobar]]. See [[Template:Location map/Creating a new map definition]] for more details on this step.
+
#Create [[Module:Location map/data/Foobar]] with the same values as [[Template:Location map Foobar]]. See [[Template:Location map/Creating a new map definition]] for more details on this step. Note that if a map contains formulas for x and/or y, all occurrences of <nowiki>{{{2}}} or {{{2|}}}</nowiki> need to be changed to $1, and all occurrences of <nowiki>{{{3}}} or {{{3|}}}</nowiki> need to be changed to $2.
 
#If [[Template:Location map Foobar]] is protected, request that [[Module:Location map/data/Foobar]] be protected at the same level.
 
#If [[Template:Location map Foobar]] is protected, request that [[Module:Location map/data/Foobar]] be protected at the same level.
 
#If any pages redirect to [[Template:Location map Foobar]], follow the steps under the [[#Converting redirects]] heading below for each of them.
 
#If any pages redirect to [[Template:Location map Foobar]], follow the steps under the [[#Converting redirects]] heading below for each of them.

Revision as of 21:03, 21 April 2014

Converting definitions

This checklist lists the steps required to convert a location map definition from a template to a module. In this example, the definition will be called "Foobar".

  1. Create Module:Location map/data/Foobar with the same values as Template:Location map Foobar. See Template:Location map/Creating a new map definition for more details on this step. Note that if a map contains formulas for x and/or y, all occurrences of {{{2}}} or {{{2|}}} need to be changed to $1, and all occurrences of {{{3}}} or {{{3|}}} need to be changed to $2.
  2. If Template:Location map Foobar is protected, request that Module:Location map/data/Foobar be protected at the same level.
  3. If any pages redirect to Template:Location map Foobar, follow the steps under the #Converting redirects heading below for each of them.
  4. If Template:Location map Foobar/doc exists, move it to Module:Location map/data/Foobar/doc and convert it following the instructions under the #Converting documentation heading below.
  5. If Template talk:Location map Foobar exists, move it to Module talk:Location map/data/Foobar.
  6. Blank Template:Location map Foobar.
  7. Move Template:Location map Foobar to Module talk:Location map/data/Foobar/attribution, or request this move at WP:RM/TR if you're unable to perform it yourself.
  8. Request that Module talk:Location map/data/Foobar/attribution be indefinitely fully protected, since it's only being kept for its history.
  9. Add the following to the top of Module talk:Location map/data/Foobar, or create it with this content if it doesn't exist:
    {{tmbox
    |type=notice
    |text=Revision history for the template that was converted to [[Module:Location map/data/Foobar]] can be found at [[Module talk:Location map/data/Foobar/attribution]].
    }}
  10. Update any links that point to Template:Location map Foobar to point to Module:Location map/data/Foobar.
  11. Request that Template:Location map Foobar be deleted under CSD G6.
  12. Request that any subpages or talk pages of Template:Location map Foobar be deleted under CSD G8.

Converting redirects

This checklist lists the steps required to convert a redirect to a location map definition from a template to a module. In this example, the redirect will be called "Foo" and will point to "Foobar".

  1. Create Module:Location map/data/Foo with
    return require('Module:Location map/data/Foobar')
    
    as the content.
  2. If Template:Location map Foo is protected, request that Module:Location map/data/Foo be protected at the same level.
  3. Create Module:Location map/data/Foo/doc as a redirect to Module:Location map/data/Foobar/doc.
  4. Request that Template:Location map Foo be deleted under CSD G6.
  5. Request that any subpages or talk pages of Template:Location map Foo be deleted under CSD G8.

Converting documentation

Replace the documentation page, except for comments, categories, etc. with a transclusion of Module:Location map/data/doc. To match the appearance of the old doc page, the following parameters are accepted:

  • image - the image displayed to the right of the introductory text. If omitted, no image is displayed.
  • projection - the type of projection the map uses. If omitted, defaults to "an equirectangular projection".
  • name - the name to use in the introductory text. If omitted, defaults to the name specified in the map definition.
  • examples - the contents of the Examples section. The Examples header itself and the final {{clear}} template are not required. If omitted, no examples section is displayed.
  • see also - additional links to display at the top of the See also section. If omitted, no additional links are displayed.

If any features are present in the old doc page that Module:Location map/data/doc does not support, please add support for them.

Here is an example of a converted doc page:

<!-- Categories and interwikis go at the bottom of this page. -->
{{Module:Location map/data/doc|image=<!-- [[File:|thumb|300px|Map of Sevastopol]] -->
|examples=
=== Location map, using default map (image) ===
{{Location map | Sevastopol
| width   = 250
| lat_deg = 44.5
| lon_deg = 33.6
| label   = Balaklava
}}
<pre style="width:25em">
{{Location map | Sevastopol
| width   = 250
| lat_deg = 44.5
| lon_deg = 33.6
| label   = Balaklava
}}
</pre>
|see also=
* [[Template:Location map Crimea]]
}}
<includeonly>
<!-- Categories and interwikis go here: -->

</includeonly>