WordPress.org
Get WordPress

Plugin Directory

Changeset 2360271


Ignore:
Timestamp:
08/13/2020 03:00:50 PM (6 years ago)
Author:
techtimo
Message:

Updating readme/assets from GitHub

File:
1 edited

Legend:

Unmodified
Added
Removed

  • spotmap/trunk/readme.txt

    r2360259 r2360271  
    1 === Spotmap ===
     1# Spotmap
    22Contributors: techtimo
    33Donate link: paypal.me/ebaytimo
    … …  
    77Requires at least: 5.3
    88Tested up to: 5.5
    9 Stable tag: trunk
    109
    1110See your Spot device movements on an embedded map inside your Blog! 🗺 Add GPX tracks, routes and waypoints to see a planned route.
    1211
    13 == Description ==
     12## Description
    1413
    1514Spot does not offer a history of sent positions for more than 7 days. That's where Spotmap comes into the game:
    … …  
    3231
    3332## Installation
    34 ### Test
     33
    3534After installing the plugin, head over to your Dashboard  `Settings > Spotmap`. Add a feed by selecting `findmespot` from the dropdown and hit "Add Feed".
    3635
    … …  
    4342
    4443👉 If you need help to configure your map, post a question in the [support forum](https://wordpress.org/support/plugin/spotmap/). 👈
    45 = Additional attributes =
     44### Additional attributes
    4645**To fine tune the map, there are some attributes we can pass with the shortcode:**
    4746- `maps=opentopomap` will show only the opentopomap as map. Default `"openstreetmap,opentopomap"`.
    … …  
    5655- `date-range-to=2022-01-01 19:00` can be used to show all points until date and time X.
    5756- `auto-reload=1` will auto update the map without the need to reload the page.
     57
    5858- `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
    5960- `feeds` can be set, if multiple feeds get used. (See example below)
    60 = GPX =
     61#### GPX
    6162**The following attributes can be used to show GPX tracks:**
    62 `gpx-name="Track 1,Track 2"` give the tracks a nice name. (Spaces can be used)
    63 `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)
    64 `gpx-color="green,#347F33"` give your tracks some color. (It can be any color you can think of, or some hex values)
     63- `gpx-name="Track 1,Track 2"` give the tracks a nice name. (Spaces can be used)
     64
     65- `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)
     66
     67- `gpx-color="green,#347F33"` give your tracks some color. (It can be any color you can think of, or some hex values)
    6568
    6669If there are areas where tracks overlap each other, the track named first will be on top of the others.
    … …  
    7174This will show a bigger map and the points are all in yellow:
    7275
    73 ``` [spotmap height=600 width=full feeds=spot colors=yellow] ```
     76`[spotmap height=600 width=full feeds=spot colors=yellow]`
    7477
    7578
    … …  
    8184We can also show multiple feeds in different colors on a same day:
    8285
    83 ```
    84 [spotmap mapcenter=last feeds=spot,spot2 colors=gray,green date="2020-06-01"]
    85 ```
     86`[spotmap mapcenter=last feeds=spot,spot2 colors=gray,green date="2020-06-01"]`
    8687
    8788
    88 == Frequently Asked Questions ==
     89## Frequently Asked Questions
    8990
    90 = How do I get my Feed ID? =
     91### How do I get my Feed ID?
    9192You need to create an XML Feed in your spot account. ([See here](https://github.com/techtimo/spotmap/issues/4#issuecomment-638001718) for more details)
    9293Unless you like to group devices under one name, it's good to create one feed per device, so you can manage the devices independently.
    9394Your XML Feed id should look similar to this: `0Wl3diTJcqqvncI6NNsoqJV5ygrFtQfBB`
    9495
    95 = Which 3rd Party Services are getting used? =
     96### Which 3rd Party Services are getting used?
    9697The plugin uses the following thrid party services:
    97981.  From [SPOT LLC](http://findmespot.com) it uses the [Public API](https://www.findmespot.com/en-us/support/spot-x/get-help/general/spot-api-support) to get the points.
    … …  
    101102
    102103
    103 = Can I use/add other maps? =
     104### Can I use/add other maps?
    104105Have you created your mapbox/thunderforest API key yet? If not this is a good way to start and get other map styles.
    105106If you still search for another map search [here](https://leaflet-extras.github.io/leaflet-providers/preview/) and also [here](https://wiki.openstreetmap.org/wiki/Tiles).
    106107If you have found a map, create a new post in the [support forum](https://wordpress.org/support/plugin/spotmap/).
    107108
    108 = I have a question, an idea, ... =
     109### I have a question, an idea, ...
    109110Head over to the wordpress.org [support forum](https://wordpress.org/support/plugin/spotmap/), and ask your question there. I am happy to assist you.
    110111If you found a bug, you can open an issue on the [GitHub Repo](https://github.com/techtimo/spotmap). (But you can also mentioned it in the forum 😉).
    111112
    112 == Screenshots ==
     113## Screenshots
    113114 
    1141151. This screenshot was taken after using the plugin for 3 months.
    1151162. You can click on every sent positions to get more information. Points sent from a 'normal' Tracking will appear as small dots.
    116117
    117 == Changelog ==
     118## Changelog
    118119= 0.9 =
    119120
    … …  
    134135- First working draft
    135136
    136 == Upgrade Notice ==
     137## Upgrade Notice
    137138 
    138139= 0.9 =
    … …  
    148149= 0.3 =
    149150This version fixes a security related bug.  Upgrade immediately.
     151
     152## My custom area
Note: See TracChangeset for help on using the changeset viewer.