Plugin Directory

Changeset 2360250


Ignore:
Timestamp:
08/13/2020 02:47:13 PM (6 years ago)
Author:
techtimo
Message:

Updating readme/assets from GitHub

File:
1 edited

Legend:

Unmodified
Added
Removed
  • spotmap/trunk/readme.txt

    r2360233 r2360250  
    3232
    3333== Installation ==
    34 
     34### Test
    3535After installing the plugin, head over to your Dashboard  `Settings > Spotmap`. Add a feed by selecting `findmespot` from the dropdown and hit "Add Feed".
    3636
     
    4343
    4444👉 If you need help to configure your map, post a question in the [support forum](https://wordpress.org/support/plugin/spotmap/). 👈
    45 
     45= Additional attributes =
    4646**To fine tune the map, there are some attributes we can pass with the shortcode:**
    47 `maps=opentopomap` will show only the opentopomap as map. Default `"openstreetmap,opentopomap"`
    48 If you create a mapbox API Key and store it in the settings page. You can choose other map types as well: `outdoors,streets,satelite`
    49 Use it like this: `maps="mb-satelite,mb-streets,openstreetmap"` This will show a satelite image as the selected map, but it can be changed to the other two maps (mb-streets, openstreetmap).
    50 `map-overlays=openseamap` can be added to see the openseamap overlay in the map. (You need to zoom in quite a bit).
    51 `height=600` can define the height of the map in pixels.
    52 `width=full` if you add this the map will appear in full width. Default is `normal`.
    53 `mapcenter=last` can be used to zoom into the last known position. Default `all`. Can be set to `'gpx'` to center all GPX files (see below for configurations).
    54 `splitlines=8` will split the lines between points if two points are sent with a difference greater than X hours. Default 12. Set to 0 if you don't like to see any line.
    55 `date-range-from=2021-01-01` can be used to show all points starting from date and time X. (Can lie in the future).
    56 `date-range-to=2022-01-01 19:00` can be used to show all points until date and time X.
    57 `auto-reload=1` will auto update the map without the need to reload the page.
    58 `tiny-types=UNLIMITED-TRACK,STOP` can be used to configure if a point is shown with a big marker on the map or not
    59 `feeds` can be set, if multiple feeds get used. (See example below)
    60 
    61 The following attributes can be used to show GPX tracks:
    62 
     47- `maps=opentopomap` will show only the opentopomap as map. Default `"openstreetmap,opentopomap"`.
     48  If you create a mapbox API Key and store it in the settings page. You can choose other map types as well: `mb-outdoors,mb-streets,mb-satelite`
     49  Use it like this: `maps="mb-satelite,mb-streets,openstreetmap"` This will show a satelite image as the selected map, but it can be changed to the other two maps (mb-streets, openstreetmap).
     50- `map-overlays=openseamap` can be added to see the openseamap overlay in the map. (You need to zoom in quite a bit).
     51- `height=600` can define the height of the map in pixels.
     52- `width=full` if you add this the map will appear in full width. Default is `normal`.
     53- `mapcenter=last` can be used to zoom into the last known position. Default `all`. Can be set to `'gpx'` to center all GPX files (see below for configurations).
     54- `splitlines=8` will split the lines between points if two points are sent with a difference greater than X hours. Default 12. Set to 0 if you don't like to see any line.
     55- `date-range-from=2021-01-01` can be used to show all points starting from date and time X. (Can lie in the future).
     56- `date-range-to=2022-01-01 19:00` can be used to show all points until date and time X.
     57- `auto-reload=1` will auto update the map without the need to reload the page.
     58- `tiny-types=UNLIMITED-TRACK,STOP` can be used to configure if a point is shown with a big marker on the map or not
     59- `feeds` can be set, if multiple feeds get used. (See example below)
     60= GPX =
     61**The following attributes can be used to show GPX tracks:**
    6362`gpx-name="Track 1,Track 2"` give the tracks a nice name. (Spaces can be used)
    6463`gpx-url="yourwordpress.com/wp-content/track1.gpx,yourwordpress.com/wp-content/track2.gpx" specify the URL of the GPX files. (You can upload GPX files to your blog like an image)
     
    6766If there are areas where tracks overlap each other, the track named first will be on top of the others.
    6867
     68_Note:_ all the Default values of the attributes can be changed in the settings in Dashboard. This comes in handy, if you use several maps on the blog, and you like to configure them all in one place. Of course you can still use the attributes to overide the default values.
    6969
    70 Note: all the Default values of the attributes can be changed in the settings in Dashboard. This comes in handy, if you use several maps on the blog, and you like to configure them all in one place. Of course you can still use the attributes to overide the default values.
     70_Note:_ `feeds` must always match your feed name.
     71This will show a bigger map and the points are all in yellow:
    7172
    72 Note: `feeds` must always match your feed name.
    73 This will show a bigger map and the points are all in yellow:
    7473```
    7574[spotmap height=600 width=full feeds=spot colors=yellow]
     
    7877
    7978This will show a map where we zoom into the last known position, and we only show data from the the first of May:
     79
    8080```
    8181[spotmap mapcenter=last feeds=spot colors=red date-range-from="2020-05-01"]
     
    8484
    8585We can also show multiple feeds in different colors on a same day:
     86
    8687```
    8788[spotmap mapcenter=last feeds=spot,spot2 colors=gray,green date="2020-06-01"]
    8889```
    89 = GPX =
    90 test
     90
    9191
    9292== Frequently Asked Questions ==
Note: See TracChangeset for help on using the changeset viewer.