Changeset 487794

Timestamp:

01/10/2012 09:40:25 PM (14 years ago)

Author:

jonlynch

Message:

readme.txt updated to wordpress format

File:

• os-openspace-maps/trunk/Readme.txt (modified) (2 diffs)

os-openspace-maps/trunk/Readme.txt

@@ -1 @@
-readme for Openspace Wordpress Plugin By Jon Lynch
+=== OS Openspace Maps ===
+Contributors: jonlynch
+Donate link: http://example.com/
+Tags: maps, OS Openspace
+Requires at least: 3.0
+Tested up to: 3.3.1
+Stable tag: 1.1
 
-Installation - Unzip the os-maps.zip into your plugins directory. It should create a dirctory 
-called os-maps containing the plugin. Then activate the plugin from the wordpress dashboard.
-Before the plugin will work you need to add your API key to the settings page on the dashboard.
+A plugin to display UK Ordinance Survey maps with markers and tracks.
 
-This plugin works using the [osmap] shortcode anywhere in your post content.
+== Description ==
+
+This plugin works using the `[osmap]` shortcode anywhere in your post content.
 
 Currently the plugin only displays one marker from an OS grid reference or a gpx file or a kml
@@ -12 +18 @@
 the following parameters can be passed:
 
-height="xxx" sets the height of the map div
-width="xxx" sets the width of the map div
-color="red" or color="#ff0000" sets the colour of the lines note the US spelling
-gpx="http://www.example.com/myfile.gpx" specifies a gpx file to be displayed
-kml="http://www.example.com/myfile.kml" specifies a kml file to be displayed
-grid="ab1234512345" places a marker at ab1234512345 (only if there is no gpx file specified)
-  this can be a 6, 8 or 10 figure grid reference but must include the two letters.
-zoom="x" sets the zoom level (unless a gpx file is displayed when the map auto zooms)
-  try starting at 7 and have a play adjusting it to suit
-label="text here" sets the text for a popup for a marker
+* `height="xxx"` sets the height of the map div
+* `width="xxx"` sets the width of the map div
+* `color="red"` or `color="#ff0000"` sets the colour of the lines note the US spelling
+* `gpx="http://www.example.com/myfile.gpx"` specifies a gpx file to be displayed
+* `kml="http://www.example.com/myfile.kml"` specifies a kml file to be displayed
+* `grid="ab1234512345"` places a marker at ab1234512345 (only if there is no gpx file specified) this can be a 6, 8 or 10 figure grid reference but must include the two letters.
+* `zoom="x"` sets the zoom level (unless a gpx file is displayed when the map auto zooms) try starting at 7 and have a play adjusting it to suit
+* `label="text here"` sets the text for a popup for a marker
 
-eg [osmap height="300" width="300" color="yellow" gpx="http://www.jonlynch.co.uk/myfile.gpx"]
-displays a 300px by 300px window containing a yellow track from the file specified.
+= Examples =
+* `[osmap height="300" width="300" color="yellow" gpx="http://www.jonlynch.co.uk/myfile.gpx"]` displays a 300px by 300px window containing a yellow track from the file specified.
 
-[osmap grid="NY2000008000" label="Wasdale"]
-shows a default size and zoom window with a marker placed and the popup text "Wasdale"
+* `[osmap grid="NY2000008000" label="Wasdale"]`shows a default size and zoom window with a marker placed and the popup text "Wasdale"
 
+== Installation ==
+
+1. Unzip the os-maps.zip into your plugins directory. It should create a dirctory called os-maps containing the plugin. 
+1. Activate the plugin from the wordpress dashboard.
+1. Before the plugin will work you need to add your API key to the settings page on the dashboard.
+
+== Frequently Asked Questions ==
+
+= A question that someone might have =
+
+An answer to that question.
+
+= What about foo bar? =
+
+Answer to foo bar dilemma.
+
+== Screenshots ==
+
+1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from
+the directory of the stable readme.txt, so in this case, `/tags/4.3/screenshot-1.png` (or jpg, jpeg, gif)
+2. This is the second screen shot
+
+== Changelog ==
+
+= 1.1 =
+* Only adds one row to the options table
+* Fixed feed bug
+
+= 1.0 =
+* Initial Release
+
+== Upgrade Notice ==
+
+= 1.0 =
+* Fixes feed bug