Module:MapClip/doc - Revision history

Jackmcbarn: /* Optional parameters */ ! is a magic word now

2014-07-12T03:49:59Z

Optional parameters: ! is a magic word now

← Previous revision		Revision as of 03:49, 12 July 2014
Line 17:		Line 17:

	===Optional parameters===		===Optional parameters===
	* ''mapfile'' - specifies a custom set of map files to use. Map files are in <nowiki>[[ ]]</nowiki> listed from left to right. If multiple rows are present they should be separated by "\|" (I think this can be passed in with ~~[[:Template:~~!]]).		* ''mapfile'' - specifies a custom set of map files to use. Map files are in <nowiki>[[ ]]</nowiki> listed from left to right. If multiple rows are present they should be separated by "\|" (I think this can be passed in with {{tlf\|!}}).
	* ''grid'' - this important parameter specifies the color for a grid of latitude and longitude meridians used to annotate the map. Omitting it omits the grid. The spacing of the grid is presently only automatic.		* ''grid'' - this important parameter specifies the color for a grid of latitude and longitude meridians used to annotate the map. Omitting it omits the grid. The spacing of the grid is presently only automatic.
	* ''mapwestedge'',''mapeastedge''',''mapsouthedge'',''mapnorthedge'' - optional parameters set the edges in degrees of the entire set of map image files. Default to -180,180,-90,90. If mapfile is not specified the default is provided for these and overrides this parameter value (you don't need it).		* ''mapwestedge'',''mapeastedge''',''mapsouthedge'',''mapnorthedge'' - optional parameters set the edges in degrees of the entire set of map image files. Default to -180,180,-90,90. If mapfile is not specified the default is provided for these and overrides this parameter value (you don't need it).

Wnt: /* Example */ Might as well make this one grey also

2013-04-16T15:46:27Z

Example: Might as well make this one grey also

← Previous revision		Revision as of 15:46, 16 April 2013
Line 35:		Line 35:
	== Example ==		== Example ==

	<nowiki>{{#invoke:MapClip\|map\|regionwestedge=-82\|regioneastedge=-80\|regionnorthedge=26\|regionsouthedge=24\|feature1=Key West\|feature1lat=24°33′33″N\|feature1long=81°47′03″W\|feature2=Old Rhodes Key\|feature2lat=25.365957°N\|feature2long=80.241866°W\|feature3=Old Totten Key\|feature3lat=25.3796°N\|feature3long=80.2484°W\|feature4=Reid Key\|feature4lat=25.392779°N\|feature4long=80.240149°W\|feature5=Duck Key\|feature5lat=24°46′32″N\|feature5long=80°54′39″W\|feature6=Pigeon Key\|feature6lat=24.703991°N\|feature6long=81.155308°W\|feature7=Summerland Key\|feature7lat=24.657°N\|feature7long=81.441°W\|feature8text=[[Lower Keys]]\|feature8lat=24.4\|feature8long=-81.8\|feature9text=[[Middle Keys]]\|feature9lat=24.55\|feature9long=-81.13\|grid=~~red~~}}</nowiki>		<nowiki>{{#invoke:MapClip\|map\|regionwestedge=-82\|regioneastedge=-80\|regionnorthedge=26\|regionsouthedge=24\|feature1=Key West\|feature1lat=24°33′33″N\|feature1long=81°47′03″W\|feature2=Old Rhodes Key\|feature2lat=25.365957°N\|feature2long=80.241866°W\|feature3=Old Totten Key\|feature3lat=25.3796°N\|feature3long=80.2484°W\|feature4=Reid Key\|feature4lat=25.392779°N\|feature4long=80.240149°W\|feature5=Duck Key\|feature5lat=24°46′32″N\|feature5long=80°54′39″W\|feature6=Pigeon Key\|feature6lat=24.703991°N\|feature6long=81.155308°W\|feature7=Summerland Key\|feature7lat=24.657°N\|feature7long=81.441°W\|feature8text=[[Lower Keys]]\|feature8lat=24.4\|feature8long=-81.8\|feature9text=[[Middle Keys]]\|feature9lat=24.55\|feature9long=-81.13\|grid=grey}}</nowiki>

	''produces''		''produces''

	{{#invoke:MapClip\|map\|regionwestedge=-82\|regioneastedge=-80\|regionnorthedge=26\|regionsouthedge=24\|feature1=Key West\|feature1lat=24°33′33″N\|feature1long=81°47′03″W\|feature2=Old Rhodes Key\|feature2lat=25.365957°N\|feature2long=80.241866°W\|feature3=Old Totten Key\|feature3lat=25.3796°N\|feature3long=80.2484°W\|feature4=Reid Key\|feature4lat=25.392779°N\|feature4long=80.240149°W\|feature5=Duck Key\|feature5lat=24°46′32″N\|feature5long=80°54′39″W\|feature6=Pigeon Key\|feature6lat=24.703991°N\|feature6long=81.155308°W\|feature7=Summerland Key\|feature7lat=24.657°N\|feature7long=81.441°W\|feature8text=[[Lower Keys]]\|feature8lat=24.4\|feature8long=-81.8\|feature9text=[[Middle Keys]]\|feature9lat=24.55\|feature9long=-81.13\|grid=~~red~~}}		{{#invoke:MapClip\|map\|regionwestedge=-82\|regioneastedge=-80\|regionnorthedge=26\|regionsouthedge=24\|feature1=Key West\|feature1lat=24°33′33″N\|feature1long=81°47′03″W\|feature2=Old Rhodes Key\|feature2lat=25.365957°N\|feature2long=80.241866°W\|feature3=Old Totten Key\|feature3lat=25.3796°N\|feature3long=80.2484°W\|feature4=Reid Key\|feature4lat=25.392779°N\|feature4long=80.240149°W\|feature5=Duck Key\|feature5lat=24°46′32″N\|feature5long=80°54′39″W\|feature6=Pigeon Key\|feature6lat=24.703991°N\|feature6long=81.155308°W\|feature7=Summerland Key\|feature7lat=24.657°N\|feature7long=81.441°W\|feature8text=[[Lower Keys]]\|feature8lat=24.4\|feature8long=-81.8\|feature9text=[[Middle Keys]]\|feature9lat=24.55\|feature9long=-81.13\|grid=grey}}

Wnt at 05:00, 16 April 2013

2013-04-16T05:00:28Z

← Previous revision		Revision as of 05:00, 16 April 2013
Line 1:		Line 1:
	This module clips out a small region from a set of [[equirectangular]] world maps. It can cross boundaries between maps, pasting together pieces of up to four maps per figure. It adds markings for longitude and latitude, feature markings and annotations.		This module clips out a small region from a set of [[equirectangular]] world maps. It can cross boundaries between maps, pasting together pieces of up to four maps per figure. It adds markings for longitude and latitude, feature markings and annotations. You can click on marked features to go to the target articles.

	==Usage==		==Usage==

Wnt: /* Optional parameters */

2013-04-16T04:59:48Z

Optional parameters

← Previous revision		Revision as of 04:59, 16 April 2013
Line 22:		Line 22:
	* ''mapwidthpx'',''mapheightpx'' - tell the program how many pixel an individual map image file has. I've actually had it work with the wrong figure.		* ''mapwidthpx'',''mapheightpx'' - tell the program how many pixel an individual map image file has. I've actually had it work with the wrong figure.
	* ''float''- right or left to allow the image to "float" in the html sense (like a normal image)		* ''float''- right or left to allow the image to "float" in the html sense (like a normal image)
	* ''nowiki'' - returns the html text (a mass of divs and a file link) for display of the map, rather than the map itself		* ''nowiki'' - returns the html text (a mass of divs and a file link) for display of the map, rather than the map itself. This is ''not'' the same as simply enclosing the #invoke in nowiki tags.

	===Per-feature parameters===		===Per-feature parameters===

Wnt: ←Created page with 'This module clips out a small region from a set of equirectangular world maps. It can cross boundaries between maps, pasting together pieces of up to four m...'

2013-04-16T04:59:13Z

←Created page with 'This module clips out a small region from a set of equirectangular world maps. It can cross boundaries between maps, pasting together pieces of up to four m...'

New page

This module clips out a small region from a set of [[equirectangular]] world maps. It can cross boundaries between maps, pasting together pieces of up to four maps per figure. It adds markings for longitude and latitude, feature markings and annotations.

==Usage==
<nowiki>{{#invoke:MapClip|map|</nowiki>''parameters''<nowiki>}}</nowiki>

==Parameters==
Note that all parameters can be provided either as a single number (fractional degrees) or three numbers (fractional degrees, minutes, seconds).

Note that marks for degrees, minutes, seconds are ignored - the numbers are simply assumed to be deg, min, sec in that order, with any other numbers ignored.

Each of these values can be fractional. "W", "S", or "-" causes the latitude/longitude to be counted as negative (the module doesn't actually check to see it is in the right direction).

Giving a south value greater than a north value causes an error; east and west values can be swapped to show the other half of the world.

===Mandatory parameters===
* '''regionwestedge''','''regioneastedge''','''regionsouthedge''','''regionnorthedge''' - required parameters set the edges (in degrees) of the region to be mapped

===Optional parameters===
* ''mapfile'' - specifies a custom set of map files to use. Map files are in <nowiki>[[ ]]</nowiki> listed from left to right. If multiple rows are present they should be separated by "|" (I think this can be passed in with [[:Template:!]]).
* ''grid'' - this important parameter specifies the color for a grid of latitude and longitude meridians used to annotate the map. Omitting it omits the grid. The spacing of the grid is presently only automatic.
* ''mapwestedge'',''mapeastedge''',''mapsouthedge'',''mapnorthedge'' - optional parameters set the edges in degrees of the entire set of map image files. Default to -180,180,-90,90. If mapfile is not specified the default is provided for these and overrides this parameter value (you don't need it).
* ''mapwidthpx'',''mapheightpx'' - tell the program how many pixel an individual map image file has. I've actually had it work with the wrong figure.
* ''float''- right or left to allow the image to "float" in the html sense (like a normal image)
* ''nowiki'' - returns the html text (a mass of divs and a file link) for display of the map, rather than the map itself

===Per-feature parameters===
Each of these uses an independent number N. If a feature is present it '''must''' have a feature''N''lat and a feature''N''long; the others are optional per feature. Numbers should start from 1 and not skip any for best results.
* ''feature''N''lat'' - the latitude of the feature (can be one or three numbers like the others)
* ''feature''N''long'' - longitude
* ''feature''N''name'' - the main purpose of the name of the feature presently is to be a ''Wikilink''; apart from linking to an article this shouldn't be provided. There might be a way to distinguish mouseover from the link in the future...
* ''feature''N''image'' - overrides the default [[:File:Full Star Yellow.svg]] with a filename you specify. Omit File: from the parameter.
* ''feature''N''size'' - overrides the default 15px size for the image.
* ''feature''N''text'' - suppresses placement of any image - instead this arbitrary text is used. This can be a link or not, and is displayed with upper left corner at the ''latitude'' and ''longitude'' you've provided. The purpose is to allow annotation of general features or groups of features. It can also be used to add a caption to a star on the map, by displacing it a little to the right (larger longitude) or in some other direction.

== Example ==

<nowiki>{{#invoke:MapClip|map|regionwestedge=-82|regioneastedge=-80|regionnorthedge=26|regionsouthedge=24|feature1=Key West|feature1lat=24°33′33″N|feature1long=81°47′03″W|feature2=Old Rhodes Key|feature2lat=25.365957°N|feature2long=80.241866°W|feature3=Old Totten Key|feature3lat=25.3796°N|feature3long=80.2484°W|feature4=Reid Key|feature4lat=25.392779°N|feature4long=80.240149°W|feature5=Duck Key|feature5lat=24°46′32″N|feature5long=80°54′39″W|feature6=Pigeon Key|feature6lat=24.703991°N|feature6long=81.155308°W|feature7=Summerland Key|feature7lat=24.657°N|feature7long=81.441°W|feature8text=[[Lower Keys]]|feature8lat=24.4|feature8long=-81.8|feature9text=[[Middle Keys]]|feature9lat=24.55|feature9long=-81.13|grid=red}}</nowiki>

''produces''

{{#invoke:MapClip|map|regionwestedge=-82|regioneastedge=-80|regionnorthedge=26|regionsouthedge=24|feature1=Key West|feature1lat=24°33′33″N|feature1long=81°47′03″W|feature2=Old Rhodes Key|feature2lat=25.365957°N|feature2long=80.241866°W|feature3=Old Totten Key|feature3lat=25.3796°N|feature3long=80.2484°W|feature4=Reid Key|feature4lat=25.392779°N|feature4long=80.240149°W|feature5=Duck Key|feature5lat=24°46′32″N|feature5long=80°54′39″W|feature6=Pigeon Key|feature6lat=24.703991°N|feature6long=81.155308°W|feature7=Summerland Key|feature7lat=24.657°N|feature7long=81.441°W|feature8text=[[Lower Keys]]|feature8lat=24.4|feature8long=-81.8|feature9text=[[Middle Keys]]|feature9lat=24.55|feature9long=-81.13|grid=red}}