aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/osm/discussion.mdwn
blob: 5736a24305c27c5a3b5dd46703f6ed0d13df090f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
### CGI requirement when using \[\[\!waypoint\]\] on pages?

Most of the osm plugin works well without cgi. The link from waypoints however use ikiwiki.cgi, at least in my configuration. Is this actually required or is it possible to use a pre rendered page to avoid running cgi on the server?

At the moment I'd prefer not running cgi and one of the advantages of a wiki compiler is that you could run without cgi on the server.

This is a minor issue but I'd be interested if you think it's possible to prerender waypoint maps. I.e maps that center on a specific waypoint whilst having all waypoints of that map visible.

> I think it would be possible, but it would require a patch. I do think however that this is the way it works: all waypoints are shown, and the only difference is that the map is centered. --[[anarcat]]

### Configure all osm tags to use same icon?

Setting the default `osm_tag_default_icon` does not seem to work? All tagged waypoint pages now want their own unique icon and display broken image if not present. Populating the tag folder with identical icons gets a bit much when there are a lot of tags.

> That looks like a bug. Please file it as such in [[bugs]]. --[[anarcat]]

### \[Wishlist\] Setting unigue icon for "active waypoint"

For usability it would be great if it was possible to display the active waypoint with a different icon. So that clicking a waypoint map symbol takes you to a map with lots of waypoints but the waypoint from the sources page is centered (as per current behaviour) **and** has a different icon.

> This *would* indeed be awesome. --[[anarcat]]

*PS. The osm plugin is amazing!*

> Thanks! --[[anarcat]]

-----

## Updated plugin needs review and merge

[[!template id=gitbranch branch=tincho-osm author="[[users/Tincho]]"]]

[[schmonz]] here. I recently tried to use this plugin, had some trouble, and discovered on IRC that [[users/Tincho]] has a largely [rewritten version](https://blog.tincho.org/posts/OSM_in_IkiWiki/) that looks good [on his site](https://blog.tincho.org/Mingle/), but hadn't gotten around to submitting for merge. So we remote-paired on it today, improved a few things, and wrote down what we noticed:

### Features removed

- Google Maps API
- Multiple layers
- Customized waypoint icons
- Full-screen map (via the CGI)
- Whatever "editable" did (maybe something interactive?)
- OpenLayers -> Leaflet (if anyone was somehow depending on OpenLayers)

### Features added

- Maps actually work again
- Maps work when embedded in HTTPS sites
- Multiple maps and multiple waypoints in a page work properly
- Maps _do_ appear in inlines
- Pagestate hash gets cleaned up better after edit/preview/delete
- Unigue icon for "active waypoint" works, also possible to select manually any waypoint to highlight
- Good test coverage, including inlines and multiple maps/waypoints per page

### Wishlist

- Optionally do something (render a static image?) for RSS
- When drawing lines between waypoints that are linked, optionally draw an arrow
- Performance/ikiwiki-idiomaticness: generate one GeoJSON file per waypoint, then rely on getting changed waypoints from the `changes()` hook
- Treat optional waypoint description as Markdown (or whatever input format you're using)
- Simplify scrubbing (maybe avoid needing HTML::Scrubber)

### Questions for reviewers

- Given this is backward-incompatible, dhould we call it something other than "osm"?
- What needs scrubbing? Have we covered all the bases? Too many bases?
- Should we vendor Leaflet into an underlay, instead of needing a URL to load it from a CDN? [[schmonz]] somewhat prefers this, so we avoid needing external resources by default, avoid breaking when the Leaflet CDN is down, etc.
- Should we write some tests before merging? `osm.pm` hadn't had any, FWIW -- [[users/Tincho]] Done

Bump! Tincho would like to see us merge his effort, and FWIW I'd also
rather not have to carry around a local copy of his work to get a map
with waypoints on my HTTPS site. [[smcv]], can you spare some round
tuits to give us your thoughts? --[[schmonz]]

----

Just stumbled onto this. 

With regards to features lost my only concern would be customizable waypoint icons. It would be really great to be able to at least change colour from the config. The wishlist point of generating one file per waypoint might solve an issue I have with osm only showing the most recently added waypoints unless I rebuild. I have however a huge number of waypoints.

Looks like good changes to me!

> did a grep `Placemark pois.kml|wc -l` which returned 3468. Which perhaps isn't that much? I'm thinking about how individual poi files might affect performance. My performance troubles are more likely to be with my tweaked album and img plugins though.

--[[kjs]]

> The issue about not getting all the waipoints until you rebuild has been solved, the current plugin had issues with keeping track of updated and deleted waypoints which is now fixed in my branch. --[[users/Tincho]]

----

I've done some initial testing now and I'm wondering if behaviour has changed with regards to the waypoint link. With the old plugin I get a map marker and link to the main map from each waypoint. See <http://img.kalleswork.net/Peter_Celsing-Filmhuset/IMGP7104/> for example, the marker is below the image. My initial tests with your plugin doesn't create this link as far as I can tell. Have I misconfigured something or is it indeed missing? --[[users/kjs]]

> It is not there any more (I should document this, thanks for pointing it out). I thought that it was not good to have that marker inserted unconditionally; also, there is no full-page map any more with this plugin (which required a cgi mode). The alternative will be to have a page with the map, and adding a link to it. --[[users/Tincho]]

>> That's unfortunate for me as embedding a map on each page with a waypoint is a bit to expensive bandwidth wise. It will slow down the browsing to much. Are there any means of creating maps with subsets of waypoints. Perhaps tags somehow? Can a waypoint appear on multiple maps? I'm thinking having the waypoint appear on a central mega-map and on a sub map, In my case a per building map. Currently all my map info is automatically generated from the exif data. So I just upload the images to an underlay dir and git push my 'building' page which then generates an image gallery and a map of all my photos. I'm trying to avoid typing to much! ;) --[[users/kjs]]

>>> What I meant was that you could add a wiki link (to a page with a map) next to each waypoint to simulate the old behaviour. 
>>> Maps with subsets of waypoints, waypoint in multiple maps: no, because a single GeoJSON file is created for each "map". But something that could be added is the ability to merge multiple maps into one view, as separate layers. --[[users/tincho]]