Hi all, today I've tried to update the wiki a bit. Please review. I wonder why many options are not documented in the wiki http://wiki.openstreetmap.org/wiki/Mkgmap/help/options I've compared it with the help file produced by mkgmap r2641 : 1) all optimization options are missing: --reduce-point-density=NUM --reduce-point-density-polygon=NUM --[no-]merge-lines --min-size-polygon=NUM --polygon-size-limits=limits code 2) other missing options --drive-on-left --drive-on-right --check-roundabouts --check-roundabout-flares --max-flare-length-ratio=NUM --ignore-builtin-relations --report-similar-arcs --report-dead-ends=LEVEL --delete-tags-file=FILENAME --show-profiles=1 --[no-]poi-address --verbose I think most of these options are for experts only. If they are missing by intension, ok. If not: Should I copy to help file text to this wiki page ? 3) out-aged customization help It would be great if someone else could update this page: http://wiki.openstreetmap.org/wiki/Mkgmap/help/custom Gerd -- View this message in context: http://gis.19327.n5.nabble.com/wiki-pages-tp5764347.html Sent from the Mkgmap Development mailing list archive at Nabble.com.
Hi Gerd, what's about explaining in the wiki only the basic functions (without default things) and in the beginning a short explanation with a link to https://github.com/openstreetmap/mkgmap/blob/master/resources/help/en/option... Maybe it would also be better to mark options used by default.Actual it's pretty hard to find out which options are useddefault. Henning Am 07.06.2013 09:48, schrieb GerdP:
Hi all,
today I've tried to update the wiki a bit. Please review.
I wonder why many options are not documented in the wiki http://wiki.openstreetmap.org/wiki/Mkgmap/help/options
I've compared it with the help file produced by mkgmap r2641 :
1) all optimization options are missing: --reduce-point-density=NUM --reduce-point-density-polygon=NUM --[no-]merge-lines --min-size-polygon=NUM --polygon-size-limits=limits code
2) other missing options --drive-on-left --drive-on-right --check-roundabouts --check-roundabout-flares --max-flare-length-ratio=NUM --ignore-builtin-relations --report-similar-arcs --report-dead-ends=LEVEL --delete-tags-file=FILENAME --show-profiles=1 --[no-]poi-address --verbose
I think most of these options are for experts only. If they are missing by intension, ok. If not: Should I copy to help file text to this wiki page ?
3) out-aged customization help It would be great if someone else could update this page: http://wiki.openstreetmap.org/wiki/Mkgmap/help/custom
Gerd
-- View this message in context: http://gis.19327.n5.nabble.com/wiki-pages-tp5764347.html Sent from the Mkgmap Development mailing list archive at Nabble.com. _______________________________________________ mkgmap-dev mailing list mkgmap-dev@lists.mkgmap.org.uk http://lists.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Hi, I prefer to remove the infos from the wiki and document it instead in the mkgmap manual. I think the style manual can be extended to add more documentation about mkgmap. This has the advantage that we don't have to add/change/remove all changes in three places: * options file * mkgmap documentation * wiki Additionally we don't have to check if others have added misleading information. A wiki is great if a lot of people contribute but I don't see that this happens with the mkgmap pages. Those who contribute (thanks!!) are also able to post their changes to the mailing list. WanMil
Hi Gerd,
what's about explaining in the wiki only the basic functions (without default things) and in the beginning a short explanation with a link to
https://github.com/openstreetmap/mkgmap/blob/master/resources/help/en/option...
Maybe it would also be better to mark options used by default.Actual it's pretty hard to find out which options are useddefault.
Henning
Am 07.06.2013 09:48, schrieb GerdP:
Hi all,
today I've tried to update the wiki a bit. Please review.
I wonder why many options are not documented in the wiki http://wiki.openstreetmap.org/wiki/Mkgmap/help/options
I've compared it with the help file produced by mkgmap r2641 :
1) all optimization options are missing: --reduce-point-density=NUM --reduce-point-density-polygon=NUM --[no-]merge-lines --min-size-polygon=NUM --polygon-size-limits=limits code
2) other missing options --drive-on-left --drive-on-right --check-roundabouts --check-roundabout-flares --max-flare-length-ratio=NUM --ignore-builtin-relations --report-similar-arcs --report-dead-ends=LEVEL --delete-tags-file=FILENAME --show-profiles=1 --[no-]poi-address --verbose
I think most of these options are for experts only. If they are missing by intension, ok. If not: Should I copy to help file text to this wiki page ?
3) out-aged customization help It would be great if someone else could update this page: http://wiki.openstreetmap.org/wiki/Mkgmap/help/custom
Gerd
-- View this message in context:http://gis.19327.n5.nabble.com/wiki-pages-tp5764347.html Sent from the Mkgmap Development mailing list archive at Nabble.com. _______________________________________________ mkgmap-dev mailing list mkgmap-dev@lists.mkgmap.org.uk http://lists.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
_______________________________________________ mkgmap-dev mailing list mkgmap-dev@lists.mkgmap.org.uk http://lists.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Hi,
I prefer to remove the infos from the wiki and document it instead in the mkgmap manual. I think the style manual can be extended to add more documentation about mkgmap. This has the advantage that we don't have to add/change/remove all changes in three places: * options file * mkgmap documentation * wiki
yes, I also don't like that we have three places, each containing almost the same info, and each being incomplete as well, on the other hand I also don't like writing docu about functions that I do not fully understand.
Additionally we don't have to check if others have added misleading information. A wiki is great if a lot of people contribute but I don't see that this happens with the mkgmap pages. Those who contribute (thanks!!) are also able to post their changes to the mailing list.
well, how do you tell a wiki user to ignore the wiki and look into a different docu? Gerd
participants (4)
-
Gerd Petermann -
GerdP
-
Henning Scholland -
WanMil