documentation improvement patch

classic Classic list List threaded Threaded
26 messages Options
12
Reply | Threaded
Open this post in threaded view
|

documentation improvement patch

Mike Baggaley
Hi Gerd, I have attached a patch to improve the documentation of the command
line. I did it some time ago and had forgotten about it, but the discussion
on whether to change default options prompted me to come back to it. The
change is purely to the documentation, no code changes.

Please review and if it meets with your approval, commit.

Thanks,
Mike

_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev

doc.patch (9K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

Henning Scholland
Hi,
Maybe it is a good idea to introduce some switch like 'just create a simple map'='for Garmin device and BaseCamp' , where mkgmap is always doing, what is currently best practice and new people get easily a map eg. for copying to their Garmin device or Basecamp or MapSource.
So he don't need to worry an index is missing...

All the existing users still can keep their scripts with their specific settings.

Henning
On 11 Feb 2019, at 02:12, Mike Baggaley <[hidden email]> wrote:
Hi Gerd, I have attached a patch to improve the documentation of the command
line. I did it some time ago and had forgotten about it, but the discussion
on whether to change default options prompted me to come back to it. The
change is purely to the documentation, no code changes.

Please review and if it meets with your approval, commit.

Thanks,
Mike


mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev

_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

Gerd Petermann
I think we can create a file in examples called maybe good-options.cfg which contains options like
route
index
housenumbers
gmapi
gmapsupp
nsis
...  (to be defined)

Do we really need more?





________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Henning Scholland <[hidden email]>
Gesendet: Montag, 11. Februar 2019 10:10
An: Development list for mkgmap
Betreff: Re: [mkgmap-dev] documentation improvement patch

Hi,
Maybe it is a good idea to introduce some switch like 'just create a simple map'='for Garmin device and BaseCamp' , where mkgmap is always doing, what is currently best practice and new people get easily a map eg. for copying to their Garmin device or Basecamp or MapSource.
So he don't need to worry an index is missing...

All the existing users still can keep their scripts with their specific settings.

Henning
On 11 Feb 2019, at 02:12, Mike Baggaley <[hidden email]<mailto:[hidden email]>> wrote:

Hi Gerd, I have attached a patch to improve the documentation of the command
line. I did it some time ago and had forgotten about it, but the discussion
on whether to change default options prompted me to come back to it. The
change is purely to the documentation, no code changes.

Please review and if it meets with your approval, commit.

Thanks,
Mike

________________________________

mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

nwillink
Great idea

I think a sea option particularly in the UK, Greece etc would be useful

Possibly drive left/right ?

Nick

On 11/02/2019 09:50, Gerd Petermann wrote:

> I think we can create a file in examples called maybe good-options.cfg which contains options like
> route
> index
> housenumbers
> gmapi
> gmapsupp
> nsis
> ...  (to be defined)
>
> Do we really need more?
>
>
>
>
>
> ________________________________________
> Von: mkgmap-dev <[hidden email]> im Auftrag von Henning Scholland <[hidden email]>
> Gesendet: Montag, 11. Februar 2019 10:10
> An: Development list for mkgmap
> Betreff: Re: [mkgmap-dev] documentation improvement patch
>
> Hi,
> Maybe it is a good idea to introduce some switch like 'just create a simple map'='for Garmin device and BaseCamp' , where mkgmap is always doing, what is currently best practice and new people get easily a map eg. for copying to their Garmin device or Basecamp or MapSource.
> So he don't need to worry an index is missing...
>
> All the existing users still can keep their scripts with their specific settings.
>
> Henning
> On 11 Feb 2019, at 02:12, Mike Baggaley <[hidden email]<mailto:[hidden email]>> wrote:
>
> Hi Gerd, I have attached a patch to improve the documentation of the command
> line. I did it some time ago and had forgotten about it, but the discussion
> on whether to change default options prompted me to come back to it. The
> change is purely to the documentation, no code changes.
>
> Please review and if it meets with your approval, commit.
>
> Thanks,
> Mike
>
> ________________________________
>
> mkgmap-dev mailing list
> [hidden email]
> http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
> _______________________________________________
> mkgmap-dev mailing list
> [hidden email]
> http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

Gerd Petermann
Hi Nick,

the sea and bounds options are problem cases as they require further files.
Since drive-on=detect depends on the bounds this is even more complex.

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von osm@pinns <[hidden email]>
Gesendet: Montag, 11. Februar 2019 10:54
An: [hidden email]
Betreff: Re: [mkgmap-dev] documentation improvement patch

Great idea

I think a sea option particularly in the UK, Greece etc would be useful

Possibly drive left/right ?

Nick

On 11/02/2019 09:50, Gerd Petermann wrote:

> I think we can create a file in examples called maybe good-options.cfg which contains options like
> route
> index
> housenumbers
> gmapi
> gmapsupp
> nsis
> ...  (to be defined)
>
> Do we really need more?
>
>
>
>
>
> ________________________________________
> Von: mkgmap-dev <[hidden email]> im Auftrag von Henning Scholland <[hidden email]>
> Gesendet: Montag, 11. Februar 2019 10:10
> An: Development list for mkgmap
> Betreff: Re: [mkgmap-dev] documentation improvement patch
>
> Hi,
> Maybe it is a good idea to introduce some switch like 'just create a simple map'='for Garmin device and BaseCamp' , where mkgmap is always doing, what is currently best practice and new people get easily a map eg. for copying to their Garmin device or Basecamp or MapSource.
> So he don't need to worry an index is missing...
>
> All the existing users still can keep their scripts with their specific settings.
>
> Henning
> On 11 Feb 2019, at 02:12, Mike Baggaley <[hidden email]<mailto:[hidden email]>> wrote:
>
> Hi Gerd, I have attached a patch to improve the documentation of the command
> line. I did it some time ago and had forgotten about it, but the discussion
> on whether to change default options prompted me to come back to it. The
> change is purely to the documentation, no code changes.
>
> Please review and if it meets with your approval, commit.
>
> Thanks,
> Mike
>
> ________________________________
>
> mkgmap-dev mailing list
> [hidden email]
> http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
> _______________________________________________
> mkgmap-dev mailing list
> [hidden email]
> http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

muralito
key driving_side=left is tagged in UK boundary https://www.openstreetmap.org/relation/62149

----- Mensaje original -----
De: "Gerd Petermann" <[hidden email]>
Para: "osm@pinns" <[hidden email]>, "mkgmap-dev" <[hidden email]>
Enviados: Lunes, 11 de Febrero 2019 7:06:51
Asunto: Re: [mkgmap-dev] documentation improvement patch

Hi Nick,

the sea and bounds options are problem cases as they require further files.
Since drive-on=detect depends on the bounds this is even more complex.

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von osm@pinns <[hidden email]>
Gesendet: Montag, 11. Februar 2019 10:54
An: [hidden email]
Betreff: Re: [mkgmap-dev] documentation improvement patch

Great idea

I think a sea option particularly in the UK, Greece etc would be useful

Possibly drive left/right ?

Nick

On 11/02/2019 09:50, Gerd Petermann wrote:

> I think we can create a file in examples called maybe good-options.cfg which contains options like
> route
> index
> housenumbers
> gmapi
> gmapsupp
> nsis
> ...  (to be defined)
>
> Do we really need more?
>
>
>
>
>
> ________________________________________
> Von: mkgmap-dev <[hidden email]> im Auftrag von Henning Scholland <[hidden email]>
> Gesendet: Montag, 11. Februar 2019 10:10
> An: Development list for mkgmap
> Betreff: Re: [mkgmap-dev] documentation improvement patch
>
> Hi,
> Maybe it is a good idea to introduce some switch like 'just create a simple map'='for Garmin device and BaseCamp' , where mkgmap is always doing, what is currently best practice and new people get easily a map eg. for copying to their Garmin device or Basecamp or MapSource.
> So he don't need to worry an index is missing...
>
> All the existing users still can keep their scripts with their specific settings.
>
> Henning
> On 11 Feb 2019, at 02:12, Mike Baggaley <[hidden email]<mailto:[hidden email]>> wrote:
>
> Hi Gerd, I have attached a patch to improve the documentation of the command
> line. I did it some time ago and had forgotten about it, but the discussion
> on whether to change default options prompted me to come back to it. The
> change is purely to the documentation, no code changes.
>
> Please review and if it meets with your approval, commit.
>
> Thanks,
> Mike
>
> ________________________________
>
> mkgmap-dev mailing list
> [hidden email]
> http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
> _______________________________________________
> mkgmap-dev mailing list
> [hidden email]
> http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev


_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

Gerd Petermann
Hi muralito,

not sure what you mean by that. What I wanted to say is that you need a working location hook which requires the bounds.zip to be able to use the information in LocatorConfig.xml which finally contains the information about lefthand/righthand traffic for all countries.

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von [hidden email] <[hidden email]>
Gesendet: Montag, 11. Februar 2019 16:33
An: mkgmap-dev
Betreff: Re: [mkgmap-dev] documentation improvement patch

key driving_side=left is tagged in UK boundary https://www.openstreetmap.org/relation/62149

----- Mensaje original -----
De: "Gerd Petermann" <[hidden email]>
Para: "osm@pinns" <[hidden email]>, "mkgmap-dev" <[hidden email]>
Enviados: Lunes, 11 de Febrero 2019 7:06:51
Asunto: Re: [mkgmap-dev] documentation improvement patch

Hi Nick,

the sea and bounds options are problem cases as they require further files.
Since drive-on=detect depends on the bounds this is even more complex.

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von osm@pinns <[hidden email]>
Gesendet: Montag, 11. Februar 2019 10:54
An: [hidden email]
Betreff: Re: [mkgmap-dev] documentation improvement patch

Great idea

I think a sea option particularly in the UK, Greece etc would be useful

Possibly drive left/right ?

Nick

On 11/02/2019 09:50, Gerd Petermann wrote:

> I think we can create a file in examples called maybe good-options.cfg which contains options like
> route
> index
> housenumbers
> gmapi
> gmapsupp
> nsis
> ...  (to be defined)
>
> Do we really need more?
>
>
>
>
>
> ________________________________________
> Von: mkgmap-dev <[hidden email]> im Auftrag von Henning Scholland <[hidden email]>
> Gesendet: Montag, 11. Februar 2019 10:10
> An: Development list for mkgmap
> Betreff: Re: [mkgmap-dev] documentation improvement patch
>
> Hi,
> Maybe it is a good idea to introduce some switch like 'just create a simple map'='for Garmin device and BaseCamp' , where mkgmap is always doing, what is currently best practice and new people get easily a map eg. for copying to their Garmin device or Basecamp or MapSource.
> So he don't need to worry an index is missing...
>
> All the existing users still can keep their scripts with their specific settings.
>
> Henning
> On 11 Feb 2019, at 02:12, Mike Baggaley <[hidden email]<mailto:[hidden email]>> wrote:
>
> Hi Gerd, I have attached a patch to improve the documentation of the command
> line. I did it some time ago and had forgotten about it, but the discussion
> on whether to change default options prompted me to come back to it. The
> change is purely to the documentation, no code changes.
>
> Please review and if it meets with your approval, commit.
>
> Thanks,
> Mike
>
> ________________________________
>
> mkgmap-dev mailing list
> [hidden email]
> http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
> _______________________________________________
> mkgmap-dev mailing list
> [hidden email]
> http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev


_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

muralito
Hi Gerd,

It was a draft that shouldn't had left my computer. :-(
Sorry.

Anyway, shouldn't the information be verified for inconsistencies between OSM's driving_side tag and the file LocatorConfig.xml?

M.

----- Mensaje original -----
De: "Gerd Petermann" <[hidden email]>
Para: "muralito" <[hidden email]>, "mkgmap-dev" <[hidden email]>
Enviados: Lunes, 11 de Febrero 2019 12:39:39
Asunto: AW: documentation improvement patch

Hi muralito,

not sure what you mean by that. What I wanted to say is that you need a working location hook which requires the bounds.zip to be able to use the information in LocatorConfig.xml which finally contains the information about lefthand/righthand traffic for all countries.

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von [hidden email] <[hidden email]>
Gesendet: Montag, 11. Februar 2019 16:33
An: mkgmap-dev
Betreff: Re: [mkgmap-dev] documentation improvement patch

key driving_side=left is tagged in UK boundary https://www.openstreetmap.org/relation/62149

----- Mensaje original -----
De: "Gerd Petermann" <[hidden email]>
Para: "osm@pinns" <[hidden email]>, "mkgmap-dev" <[hidden email]>
Enviados: Lunes, 11 de Febrero 2019 7:06:51
Asunto: Re: [mkgmap-dev] documentation improvement patch

Hi Nick,

the sea and bounds options are problem cases as they require further files.
Since drive-on=detect depends on the bounds this is even more complex.

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von osm@pinns <[hidden email]>
Gesendet: Montag, 11. Februar 2019 10:54
An: [hidden email]
Betreff: Re: [mkgmap-dev] documentation improvement patch

Great idea

I think a sea option particularly in the UK, Greece etc would be useful

Possibly drive left/right ?

Nick

On 11/02/2019 09:50, Gerd Petermann wrote:

> I think we can create a file in examples called maybe good-options.cfg which contains options like
> route
> index
> housenumbers
> gmapi
> gmapsupp
> nsis
> ...  (to be defined)
>
> Do we really need more?
>
>
>
>
>
> ________________________________________
> Von: mkgmap-dev <[hidden email]> im Auftrag von Henning Scholland <[hidden email]>
> Gesendet: Montag, 11. Februar 2019 10:10
> An: Development list for mkgmap
> Betreff: Re: [mkgmap-dev] documentation improvement patch
>
> Hi,
> Maybe it is a good idea to introduce some switch like 'just create a simple map'='for Garmin device and BaseCamp' , where mkgmap is always doing, what is currently best practice and new people get easily a map eg. for copying to their Garmin device or Basecamp or MapSource.
> So he don't need to worry an index is missing...
>
> All the existing users still can keep their scripts with their specific settings.
>
> Henning
> On 11 Feb 2019, at 02:12, Mike Baggaley <[hidden email]<mailto:[hidden email]>> wrote:
>
> Hi Gerd, I have attached a patch to improve the documentation of the command
> line. I did it some time ago and had forgotten about it, but the discussion
> on whether to change default options prompted me to come back to it. The
> change is purely to the documentation, no code changes.
>
> Please review and if it meets with your approval, commit.
>
> Thanks,
> Mike
>
> ________________________________
>
> mkgmap-dev mailing list
> [hidden email]
> http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
> _______________________________________________
> mkgmap-dev mailing list
> [hidden email]
> http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev


_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev


_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

Gerd Petermann
Hi Muralito,

I am not aware of problems with the information in LocatorConfig.xml. My understanding is that this changes rather seldom.
Do you think about additional code in the methods which compute the bounds file? This is typically the only situation where mkgmap "sees"
complete boundaries.

Gerd

________________________________________
Von: [hidden email] <[hidden email]>
Gesendet: Montag, 11. Februar 2019 16:58
An: Gerd Petermann
Cc: mkgmap-dev
Betreff: Re: AW: documentation improvement patch

Hi Gerd,

It was a draft that shouldn't had left my computer. :-(
Sorry.

Anyway, shouldn't the information be verified for inconsistencies between OSM's driving_side tag and the file LocatorConfig.xml?

M.

----- Mensaje original -----
De: "Gerd Petermann" <[hidden email]>
Para: "muralito" <[hidden email]>, "mkgmap-dev" <[hidden email]>
Enviados: Lunes, 11 de Febrero 2019 12:39:39
Asunto: AW: documentation improvement patch

Hi muralito,

not sure what you mean by that. What I wanted to say is that you need a working location hook which requires the bounds.zip to be able to use the information in LocatorConfig.xml which finally contains the information about lefthand/righthand traffic for all countries.

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von [hidden email] <[hidden email]>
Gesendet: Montag, 11. Februar 2019 16:33
An: mkgmap-dev
Betreff: Re: [mkgmap-dev] documentation improvement patch

key driving_side=left is tagged in UK boundary https://www.openstreetmap.org/relation/62149

----- Mensaje original -----
De: "Gerd Petermann" <[hidden email]>
Para: "osm@pinns" <[hidden email]>, "mkgmap-dev" <[hidden email]>
Enviados: Lunes, 11 de Febrero 2019 7:06:51
Asunto: Re: [mkgmap-dev] documentation improvement patch

Hi Nick,

the sea and bounds options are problem cases as they require further files.
Since drive-on=detect depends on the bounds this is even more complex.

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von osm@pinns <[hidden email]>
Gesendet: Montag, 11. Februar 2019 10:54
An: [hidden email]
Betreff: Re: [mkgmap-dev] documentation improvement patch

Great idea

I think a sea option particularly in the UK, Greece etc would be useful

Possibly drive left/right ?

Nick

On 11/02/2019 09:50, Gerd Petermann wrote:

> I think we can create a file in examples called maybe good-options.cfg which contains options like
> route
> index
> housenumbers
> gmapi
> gmapsupp
> nsis
> ...  (to be defined)
>
> Do we really need more?
>
>
>
>
>
> ________________________________________
> Von: mkgmap-dev <[hidden email]> im Auftrag von Henning Scholland <[hidden email]>
> Gesendet: Montag, 11. Februar 2019 10:10
> An: Development list for mkgmap
> Betreff: Re: [mkgmap-dev] documentation improvement patch
>
> Hi,
> Maybe it is a good idea to introduce some switch like 'just create a simple map'='for Garmin device and BaseCamp' , where mkgmap is always doing, what is currently best practice and new people get easily a map eg. for copying to their Garmin device or Basecamp or MapSource.
> So he don't need to worry an index is missing...
>
> All the existing users still can keep their scripts with their specific settings.
>
> Henning
> On 11 Feb 2019, at 02:12, Mike Baggaley <[hidden email]<mailto:[hidden email]>> wrote:
>
> Hi Gerd, I have attached a patch to improve the documentation of the command
> line. I did it some time ago and had forgotten about it, but the discussion
> on whether to change default options prompted me to come back to it. The
> change is purely to the documentation, no code changes.
>
> Please review and if it meets with your approval, commit.
>
> Thanks,
> Mike
>
> ________________________________
>
> mkgmap-dev mailing list
> [hidden email]
> http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
> _______________________________________________
> mkgmap-dev mailing list
> [hidden email]
> http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev


_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev


_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

Henning Scholland
In reply to this post by Gerd Petermann
Hi Gerd,
I think it's quite similar to my idea. Just I was thinking to have one option to summarise the option file, you were suggesting. As option file is more easy to implement, I think its better to go your way first.
The only advantage of my approach is that we later on can change the options if best practice is changed and user don't need to update any option file

Henning

On 11 Feb 2019, at 17:50, Gerd Petermann <[hidden email]> wrote:
I think we can create a file in examples called maybe good-options.cfg which contains options like
route
index
housenumbers
gmapi
gmapsupp
nsis
... (to be defined)

Do we really need more?







Von: mkgmap-dev <[hidden email]> im Auftrag von Henning Scholland <[hidden email]>
Gesendet: Montag, 11. Februar 2019 10:10
An: Development list for mkgmap
Betreff: Re: [mkgmap-dev] documentation improvement patch

Hi,
Maybe it is a good idea to introduce some switch like 'just create a simple map'='for Garmin device and BaseCamp' , where mkgmap is always doing, what is currently best practice and new people get easily a map eg. for copying to their Garmin device or Basecamp or MapSource.
So he don't need to worry an index is missing...

All the existing users still can keep their scripts with their specific settings.

Henning
On 11 Feb 2019, at 02:12, Mike Baggaley <[hidden email]<mailto:[hidden email]>> wrote:

Hi Gerd, I have attached a patch to improve the documentation of the command
line. I did it some time ago and had forgotten about it, but the discussion
on whether to change default options prompted me to come back to it. The
change is purely to the documentation, no code changes.

Please review and if it meets with your approval, commit.

Thanks,
Mike




mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev


_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

Gerd Petermann
In reply to this post by Mike Baggaley
Hi Mike,

sorry for the late response. I like most of the patch but the introdution stops with
"The configuration contains lines in the form"

I guess that was the reason why you didn't post it in the past. Maybe just
like to the wiki page: https://wiki.openstreetmap.org/wiki/Mkgmap/dev ?

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike Baggaley <[hidden email]>
Gesendet: Sonntag, 10. Februar 2019 19:12
An: 'Development list for mkgmap'
Betreff: [mkgmap-dev] documentation improvement patch

Hi Gerd, I have attached a patch to improve the documentation of the command
line. I did it some time ago and had forgotten about it, but the discussion
on whether to change default options prompted me to come back to it. The
change is purely to the documentation, no code changes.

Please review and if it meets with your approval, commit.

Thanks,
Mike
_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

Mike Baggaley
Hi Gerd, I think you are right. I must have stopped and left it at the point
where I needed the logging configuration details. Please find attached an
updated patch.

Note I am not quite clear of the symbols used to format the documentation
(or why we need to manually generate two almost identical copies instead of
deriving one from the other). Can you point me to web pages that describe
the two formats?

Cheers,
Mike

-----Original Message-----
From: Gerd Petermann [mailto:[hidden email]]
Sent: 13 February 2019 13:46
To: Development list for mkgmap <[hidden email]>
Subject: Re: [mkgmap-dev] documentation improvement patch

Hi Mike,

sorry for the late response. I like most of the patch but the introdution
stops with
"The configuration contains lines in the form"

I guess that was the reason why you didn't post it in the past. Maybe just
like to the wiki page: https://wiki.openstreetmap.org/wiki/Mkgmap/dev ?

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike
Baggaley <[hidden email]>
Gesendet: Sonntag, 10. Februar 2019 19:12
An: 'Development list for mkgmap'
Betreff: [mkgmap-dev] documentation improvement patch

Hi Gerd, I have attached a patch to improve the documentation of the command
line. I did it some time ago and had forgotten about it, but the discussion
on whether to change default options prompted me to come back to it. The
change is purely to the documentation, no code changes.

Please review and if it meets with your approval, commit.

Thanks,
Mike


_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev

doc-v2.patch (11K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

Gerd Petermann
Hi Mike,

I'd also prefer to have only one source for both files. Note that resources\help\en\options is not only documentation,
it is also parsed by mkgmap to build a list of known options.
I have no idea about the tools which are used, see scripts\options_to_doc.py for details.

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike Baggaley <[hidden email]>
Gesendet: Freitag, 22. Februar 2019 08:58
An: 'Development list for mkgmap'
Betreff: Re: [mkgmap-dev] documentation improvement patch

Hi Gerd, I think you are right. I must have stopped and left it at the point
where I needed the logging configuration details. Please find attached an
updated patch.

Note I am not quite clear of the symbols used to format the documentation
(or why we need to manually generate two almost identical copies instead of
deriving one from the other). Can you point me to web pages that describe
the two formats?

Cheers,
Mike

-----Original Message-----
From: Gerd Petermann [mailto:[hidden email]]
Sent: 13 February 2019 13:46
To: Development list for mkgmap <[hidden email]>
Subject: Re: [mkgmap-dev] documentation improvement patch

Hi Mike,

sorry for the late response. I like most of the patch but the introdution
stops with
"The configuration contains lines in the form"

I guess that was the reason why you didn't post it in the past. Maybe just
like to the wiki page: https://wiki.openstreetmap.org/wiki/Mkgmap/dev ?

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike
Baggaley <[hidden email]>
Gesendet: Sonntag, 10. Februar 2019 19:12
An: 'Development list for mkgmap'
Betreff: [mkgmap-dev] documentation improvement patch

Hi Gerd, I have attached a patch to improve the documentation of the command
line. I did it some time ago and had forgotten about it, but the discussion
on whether to change default options prompted me to come back to it. The
change is purely to the documentation, no code changes.

Please review and if it meets with your approval, commit.

Thanks,
Mike

_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

Mike Baggaley
HI Gerd,

Thanks for the pointer to the script. That explains the handling of the
options file. Having looked more closely at the doc folder, I realise that
the background section I added would be better in the index.txt file rather
than options.txt and options. I gather that the txt files in the doc folder
are used to generate the HTML on the web site. Can you point me to the
process for building the HTML? Is there some reason why we use this text
format rather than creating them directly as HTML? I'll have a look to see
whether the options.txt file or web page could be built directly from the
options file. Having run mkgmap with --help=options, I see that there are
quite a few overflowing lines. I'll also fix those. Note I am moving house
on Thursday, so may be a little busy!

Cheers,
Mike

-----Original Message-----
From: Gerd Petermann [mailto:[hidden email]]
Sent: 22 February 2019 11:21
To: Mike Baggaley <[hidden email]>; Development list for mkgmap
<[hidden email]>
Subject: Re: [mkgmap-dev] documentation improvement patch

Hi Mike,

I'd also prefer to have only one source for both files. Note that
resources\help\en\options is not only documentation,
it is also parsed by mkgmap to build a list of known options.
I have no idea about the tools which are used, see scripts\options_to_doc.py
for details.

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike
Baggaley <[hidden email]>
Gesendet: Freitag, 22. Februar 2019 08:58
An: 'Development list for mkgmap'
Betreff: Re: [mkgmap-dev] documentation improvement patch

Hi Gerd, I think you are right. I must have stopped and left it at the point
where I needed the logging configuration details. Please find attached an
updated patch.

Note I am not quite clear of the symbols used to format the documentation
(or why we need to manually generate two almost identical copies instead of
deriving one from the other). Can you point me to web pages that describe
the two formats?

Cheers,
Mike

-----Original Message-----
From: Gerd Petermann [mailto:[hidden email]]
Sent: 13 February 2019 13:46
To: Development list for mkgmap <[hidden email]>
Subject: Re: [mkgmap-dev] documentation improvement patch

Hi Mike,

sorry for the late response. I like most of the patch but the introdution
stops with
"The configuration contains lines in the form"

I guess that was the reason why you didn't post it in the past. Maybe just
like to the wiki page: https://wiki.openstreetmap.org/wiki/Mkgmap/dev ?

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike
Baggaley <[hidden email]>
Gesendet: Sonntag, 10. Februar 2019 19:12
An: 'Development list for mkgmap'
Betreff: [mkgmap-dev] documentation improvement patch

Hi Gerd, I have attached a patch to improve the documentation of the command
line. I did it some time ago and had forgotten about it, but the discussion
on whether to change default options prompted me to come back to it. The
change is purely to the documentation, no code changes.

Please review and if it meets with your approval, commit.

Thanks,
Mike



_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

Gerd Petermann
Hi Mike,

I don't know anything about processes building html on the server. This is all managed by Steve and I am more or less a simple user when it comes to html ;)

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike Baggaley <[hidden email]>
Gesendet: Freitag, 22. Februar 2019 21:04
An: 'Development list for mkgmap'
Betreff: Re: [mkgmap-dev] documentation improvement patch

HI Gerd,

Thanks for the pointer to the script. That explains the handling of the
options file. Having looked more closely at the doc folder, I realise that
the background section I added would be better in the index.txt file rather
than options.txt and options. I gather that the txt files in the doc folder
are used to generate the HTML on the web site. Can you point me to the
process for building the HTML? Is there some reason why we use this text
format rather than creating them directly as HTML? I'll have a look to see
whether the options.txt file or web page could be built directly from the
options file. Having run mkgmap with --help=options, I see that there are
quite a few overflowing lines. I'll also fix those. Note I am moving house
on Thursday, so may be a little busy!

Cheers,
Mike

-----Original Message-----
From: Gerd Petermann [mailto:[hidden email]]
Sent: 22 February 2019 11:21
To: Mike Baggaley <[hidden email]>; Development list for mkgmap
<[hidden email]>
Subject: Re: [mkgmap-dev] documentation improvement patch

Hi Mike,

I'd also prefer to have only one source for both files. Note that
resources\help\en\options is not only documentation,
it is also parsed by mkgmap to build a list of known options.
I have no idea about the tools which are used, see scripts\options_to_doc.py
for details.

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike
Baggaley <[hidden email]>
Gesendet: Freitag, 22. Februar 2019 08:58
An: 'Development list for mkgmap'
Betreff: Re: [mkgmap-dev] documentation improvement patch

Hi Gerd, I think you are right. I must have stopped and left it at the point
where I needed the logging configuration details. Please find attached an
updated patch.

Note I am not quite clear of the symbols used to format the documentation
(or why we need to manually generate two almost identical copies instead of
deriving one from the other). Can you point me to web pages that describe
the two formats?

Cheers,
Mike

-----Original Message-----
From: Gerd Petermann [mailto:[hidden email]]
Sent: 13 February 2019 13:46
To: Development list for mkgmap <[hidden email]>
Subject: Re: [mkgmap-dev] documentation improvement patch

Hi Mike,

sorry for the late response. I like most of the patch but the introdution
stops with
"The configuration contains lines in the form"

I guess that was the reason why you didn't post it in the past. Maybe just
like to the wiki page: https://wiki.openstreetmap.org/wiki/Mkgmap/dev ?

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike
Baggaley <[hidden email]>
Gesendet: Sonntag, 10. Februar 2019 19:12
An: 'Development list for mkgmap'
Betreff: [mkgmap-dev] documentation improvement patch

Hi Gerd, I have attached a patch to improve the documentation of the command
line. I did it some time ago and had forgotten about it, but the discussion
on whether to change default options prompted me to come back to it. The
change is purely to the documentation, no code changes.

Please review and if it meets with your approval, commit.

Thanks,
Mike



_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

Mike Baggaley
In reply to this post by Mike Baggaley
Hi Gerd, please find attached a new patch. This moves the background info to
index.txt, amends the positions of new lines, so that lines don't overflow
when viewed in a standard 80 character command window (except one I have
intentionally allowed to overflow as it is better that way), and added some
simple java code to generate the options file from options.txt.  The
attached  options file has been generated. Hope this looks OK.

Cheers,
Mike

-----Original Message-----
From: Mike Baggaley [mailto:[hidden email]]
Sent: 22 February 2019 20:04
To: 'Development list for mkgmap' <[hidden email]>
Subject: Re: [mkgmap-dev] documentation improvement patch

HI Gerd,

Thanks for the pointer to the script. That explains the handling of the
options file. Having looked more closely at the doc folder, I realise that
the background section I added would be better in the index.txt file rather
than options.txt and options. I gather that the txt files in the doc folder
are used to generate the HTML on the web site. Can you point me to the
process for building the HTML? Is there some reason why we use this text
format rather than creating them directly as HTML? I'll have a look to see
whether the options.txt file or web page could be built directly from the
options file. Having run mkgmap with --help=options, I see that there are
quite a few overflowing lines. I'll also fix those. Note I am moving house
on Thursday, so may be a little busy!

Cheers,
Mike

-----Original Message-----
From: Gerd Petermann [mailto:[hidden email]]
Sent: 22 February 2019 11:21
To: Mike Baggaley <[hidden email]>; Development list for mkgmap
<[hidden email]>
Subject: Re: [mkgmap-dev] documentation improvement patch

Hi Mike,

I'd also prefer to have only one source for both files. Note that
resources\help\en\options is not only documentation,
it is also parsed by mkgmap to build a list of known options.
I have no idea about the tools which are used, see scripts\options_to_doc.py
for details.

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike
Baggaley <[hidden email]>
Gesendet: Freitag, 22. Februar 2019 08:58
An: 'Development list for mkgmap'
Betreff: Re: [mkgmap-dev] documentation improvement patch

Hi Gerd, I think you are right. I must have stopped and left it at the point
where I needed the logging configuration details. Please find attached an
updated patch.

Note I am not quite clear of the symbols used to format the documentation
(or why we need to manually generate two almost identical copies instead of
deriving one from the other). Can you point me to web pages that describe
the two formats?

Cheers,
Mike

-----Original Message-----
From: Gerd Petermann [mailto:[hidden email]]
Sent: 13 February 2019 13:46
To: Development list for mkgmap <[hidden email]>
Subject: Re: [mkgmap-dev] documentation improvement patch

Hi Mike,

sorry for the late response. I like most of the patch but the introdution
stops with
"The configuration contains lines in the form"

I guess that was the reason why you didn't post it in the past. Maybe just
like to the wiki page: https://wiki.openstreetmap.org/wiki/Mkgmap/dev ?

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike
Baggaley <[hidden email]>
Gesendet: Sonntag, 10. Februar 2019 19:12
An: 'Development list for mkgmap'
Betreff: [mkgmap-dev] documentation improvement patch

Hi Gerd, I have attached a patch to improve the documentation of the command
line. I did it some time ago and had forgotten about it, but the discussion
on whether to change default options prompted me to come back to it. The
change is purely to the documentation, no code changes.

Please review and if it meets with your approval, commit.

Thanks,
Mike





_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev

doc-v3.patch (180K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

Gerd Petermann
Hi Mike,

please review: I tried to apply your patch now but I have problems:
D:\m>svn patch f:\dwnload\temp\doc-v3.patch
U         doc\index.txt
U         doc\options.txt
A         options
A         options\buildoptions
A         options\buildoptions\main.java
G         options\buildoptions\main.java
>         hunk @@ -0,0 +1,64 @@ already applied
G         options\buildoptions\main.java
>         hunk @@ -0,0 +1,64 @@ already applied
U         resources\help\en\options

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike Baggaley <[hidden email]>
Gesendet: Samstag, 23. Februar 2019 15:15
An: 'Development list for mkgmap'
Betreff: Re: [mkgmap-dev] documentation improvement patch

Hi Gerd, please find attached a new patch. This moves the background info to
index.txt, amends the positions of new lines, so that lines don't overflow
when viewed in a standard 80 character command window (except one I have
intentionally allowed to overflow as it is better that way), and added some
simple java code to generate the options file from options.txt.  The
attached  options file has been generated. Hope this looks OK.

Cheers,
Mike

-----Original Message-----
From: Mike Baggaley [mailto:[hidden email]]
Sent: 22 February 2019 20:04
To: 'Development list for mkgmap' <[hidden email]>
Subject: Re: [mkgmap-dev] documentation improvement patch

HI Gerd,

Thanks for the pointer to the script. That explains the handling of the
options file. Having looked more closely at the doc folder, I realise that
the background section I added would be better in the index.txt file rather
than options.txt and options. I gather that the txt files in the doc folder
are used to generate the HTML on the web site. Can you point me to the
process for building the HTML? Is there some reason why we use this text
format rather than creating them directly as HTML? I'll have a look to see
whether the options.txt file or web page could be built directly from the
options file. Having run mkgmap with --help=options, I see that there are
quite a few overflowing lines. I'll also fix those. Note I am moving house
on Thursday, so may be a little busy!

Cheers,
Mike

-----Original Message-----
From: Gerd Petermann [mailto:[hidden email]]
Sent: 22 February 2019 11:21
To: Mike Baggaley <[hidden email]>; Development list for mkgmap
<[hidden email]>
Subject: Re: [mkgmap-dev] documentation improvement patch

Hi Mike,

I'd also prefer to have only one source for both files. Note that
resources\help\en\options is not only documentation,
it is also parsed by mkgmap to build a list of known options.
I have no idea about the tools which are used, see scripts\options_to_doc.py
for details.

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike
Baggaley <[hidden email]>
Gesendet: Freitag, 22. Februar 2019 08:58
An: 'Development list for mkgmap'
Betreff: Re: [mkgmap-dev] documentation improvement patch

Hi Gerd, I think you are right. I must have stopped and left it at the point
where I needed the logging configuration details. Please find attached an
updated patch.

Note I am not quite clear of the symbols used to format the documentation
(or why we need to manually generate two almost identical copies instead of
deriving one from the other). Can you point me to web pages that describe
the two formats?

Cheers,
Mike

-----Original Message-----
From: Gerd Petermann [mailto:[hidden email]]
Sent: 13 February 2019 13:46
To: Development list for mkgmap <[hidden email]>
Subject: Re: [mkgmap-dev] documentation improvement patch

Hi Mike,

sorry for the late response. I like most of the patch but the introdution
stops with
"The configuration contains lines in the form"

I guess that was the reason why you didn't post it in the past. Maybe just
like to the wiki page: https://wiki.openstreetmap.org/wiki/Mkgmap/dev ?

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike
Baggaley <[hidden email]>
Gesendet: Sonntag, 10. Februar 2019 19:12
An: 'Development list for mkgmap'
Betreff: [mkgmap-dev] documentation improvement patch

Hi Gerd, I have attached a patch to improve the documentation of the command
line. I did it some time ago and had forgotten about it, but the discussion
on whether to change default options prompted me to come back to it. The
change is purely to the documentation, no code changes.

Please review and if it meets with your approval, commit.

Thanks,
Mike




_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

Mike Baggaley
Hi Gerd, apologies for the delay - we moved house the day you sent the email
below and it got forgotten about as I had no Internet access from my PC for
some weeks.

There seems to be a bug in the patch creation program I am using
(TortoiseSVN), as it has specified the same update three times. There are
three additions, two of which are folders and one file. It seems to have
created the same update for each of those three, hence the two failures.

I have updated the options files to the latest versions before re-running
buildoptions and rebuilding the patch without asking it to create the
folders. The patch has only one update in it this time, so hopefully will be
OK.

Note the buildoptions program has hard coded relative paths to the options
files, so the working directory needs to be the mkgmap root folder.

Please let me know how you get on.

Cheers,
Mike

-----Original Message-----
From: Gerd Petermann [mailto:[hidden email]]
Sent: 28 February 2019 06:52
To: Mike Baggaley <[hidden email]>; Development list for mkgmap
<[hidden email]>
Subject: AW: [mkgmap-dev] documentation improvement patch

Hi Mike,

please review: I tried to apply your patch now but I have problems:
D:\m>svn patch f:\dwnload\temp\doc-v3.patch
U         doc\index.txt
U         doc\options.txt
A         options
A         options\buildoptions
A         options\buildoptions\main.java
G         options\buildoptions\main.java
>         hunk @@ -0,0 +1,64 @@ already applied
G         options\buildoptions\main.java
>         hunk @@ -0,0 +1,64 @@ already applied
U         resources\help\en\options

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike
Baggaley <[hidden email]>
Gesendet: Samstag, 23. Februar 2019 15:15
An: 'Development list for mkgmap'
Betreff: Re: [mkgmap-dev] documentation improvement patch

Hi Gerd, please find attached a new patch. This moves the background info to
index.txt, amends the positions of new lines, so that lines don't overflow
when viewed in a standard 80 character command window (except one I have
intentionally allowed to overflow as it is better that way), and added some
simple java code to generate the options file from options.txt.  The
attached  options file has been generated. Hope this looks OK.

Cheers,
Mike

-----Original Message-----
From: Mike Baggaley [mailto:[hidden email]]
Sent: 22 February 2019 20:04
To: 'Development list for mkgmap' <[hidden email]>
Subject: Re: [mkgmap-dev] documentation improvement patch

HI Gerd,

Thanks for the pointer to the script. That explains the handling of the
options file. Having looked more closely at the doc folder, I realise that
the background section I added would be better in the index.txt file rather
than options.txt and options. I gather that the txt files in the doc folder
are used to generate the HTML on the web site. Can you point me to the
process for building the HTML? Is there some reason why we use this text
format rather than creating them directly as HTML? I'll have a look to see
whether the options.txt file or web page could be built directly from the
options file. Having run mkgmap with --help=options, I see that there are
quite a few overflowing lines. I'll also fix those. Note I am moving house
on Thursday, so may be a little busy!

Cheers,
Mike

-----Original Message-----
From: Gerd Petermann [mailto:[hidden email]]
Sent: 22 February 2019 11:21
To: Mike Baggaley <[hidden email]>; Development list for mkgmap
<[hidden email]>
Subject: Re: [mkgmap-dev] documentation improvement patch

Hi Mike,

I'd also prefer to have only one source for both files. Note that
resources\help\en\options is not only documentation,
it is also parsed by mkgmap to build a list of known options.
I have no idea about the tools which are used, see scripts\options_to_doc.py
for details.

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike
Baggaley <[hidden email]>
Gesendet: Freitag, 22. Februar 2019 08:58
An: 'Development list for mkgmap'
Betreff: Re: [mkgmap-dev] documentation improvement patch

Hi Gerd, I think you are right. I must have stopped and left it at the point
where I needed the logging configuration details. Please find attached an
updated patch.

Note I am not quite clear of the symbols used to format the documentation
(or why we need to manually generate two almost identical copies instead of
deriving one from the other). Can you point me to web pages that describe
the two formats?

Cheers,
Mike

-----Original Message-----
From: Gerd Petermann [mailto:[hidden email]]
Sent: 13 February 2019 13:46
To: Development list for mkgmap <[hidden email]>
Subject: Re: [mkgmap-dev] documentation improvement patch

Hi Mike,

sorry for the late response. I like most of the patch but the introdution
stops with
"The configuration contains lines in the form"

I guess that was the reason why you didn't post it in the past. Maybe just
like to the wiki page: https://wiki.openstreetmap.org/wiki/Mkgmap/dev ?

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike
Baggaley <[hidden email]>
Gesendet: Sonntag, 10. Februar 2019 19:12
An: 'Development list for mkgmap'
Betreff: [mkgmap-dev] documentation improvement patch

Hi Gerd, I have attached a patch to improve the documentation of the command
line. I did it some time ago and had forgotten about it, but the discussion
on whether to change default options prompted me to come back to it. The
change is purely to the documentation, no code changes.

Please review and if it meets with your approval, commit.

Thanks,
Mike





_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev

doc-v4.patch (189K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

Gerd Petermann
Hi Mike,

thanks for the work. The patch applies fine now.
I don't understand some of the reformatting in options.txt.  I think they were not intended.
See for example --split-name-index: Blanks at the beginning of the lines and
"See also option road-name-config." is no longer on a separate line.

It seems I am to stupid to run the java program on my machine :(
Please desribe the steps to compile and run it.

Looking at the source it seems you want to force max. 80 characters on one line in the options.txt file so that the
buildoptions program doesn't have to reformat paragraphs?
This looks like a complicated work flow when I edit options.txt:
Edit, save, run buildoptions program, check if it complains about lines longer than 80 characters, edit again ...
I think the java code should be able to detect a paragraph and split it into pieces?

Gerd


________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike Baggaley <[hidden email]>
Gesendet: Sonntag, 29. Dezember 2019 15:15
An: 'Development list for mkgmap'
Betreff: Re: [mkgmap-dev] documentation improvement patch

Hi Gerd, apologies for the delay - we moved house the day you sent the email
below and it got forgotten about as I had no Internet access from my PC for
some weeks.

There seems to be a bug in the patch creation program I am using
(TortoiseSVN), as it has specified the same update three times. There are
three additions, two of which are folders and one file. It seems to have
created the same update for each of those three, hence the two failures.

I have updated the options files to the latest versions before re-running
buildoptions and rebuilding the patch without asking it to create the
folders. The patch has only one update in it this time, so hopefully will be
OK.

Note the buildoptions program has hard coded relative paths to the options
files, so the working directory needs to be the mkgmap root folder.

Please let me know how you get on.

Cheers,
Mike

-----Original Message-----
From: Gerd Petermann [mailto:[hidden email]]
Sent: 28 February 2019 06:52
To: Mike Baggaley <[hidden email]>; Development list for mkgmap
<[hidden email]>
Subject: AW: [mkgmap-dev] documentation improvement patch

Hi Mike,

please review: I tried to apply your patch now but I have problems:
D:\m>svn patch f:\dwnload\temp\doc-v3.patch
U         doc\index.txt
U         doc\options.txt
A         options
A         options\buildoptions
A         options\buildoptions\main.java
G         options\buildoptions\main.java
>         hunk @@ -0,0 +1,64 @@ already applied
G         options\buildoptions\main.java
>         hunk @@ -0,0 +1,64 @@ already applied
U         resources\help\en\options

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike
Baggaley <[hidden email]>
Gesendet: Samstag, 23. Februar 2019 15:15
An: 'Development list for mkgmap'
Betreff: Re: [mkgmap-dev] documentation improvement patch

Hi Gerd, please find attached a new patch. This moves the background info to
index.txt, amends the positions of new lines, so that lines don't overflow
when viewed in a standard 80 character command window (except one I have
intentionally allowed to overflow as it is better that way), and added some
simple java code to generate the options file from options.txt.  The
attached  options file has been generated. Hope this looks OK.

Cheers,
Mike

-----Original Message-----
From: Mike Baggaley [mailto:[hidden email]]
Sent: 22 February 2019 20:04
To: 'Development list for mkgmap' <[hidden email]>
Subject: Re: [mkgmap-dev] documentation improvement patch

HI Gerd,

Thanks for the pointer to the script. That explains the handling of the
options file. Having looked more closely at the doc folder, I realise that
the background section I added would be better in the index.txt file rather
than options.txt and options. I gather that the txt files in the doc folder
are used to generate the HTML on the web site. Can you point me to the
process for building the HTML? Is there some reason why we use this text
format rather than creating them directly as HTML? I'll have a look to see
whether the options.txt file or web page could be built directly from the
options file. Having run mkgmap with --help=options, I see that there are
quite a few overflowing lines. I'll also fix those. Note I am moving house
on Thursday, so may be a little busy!

Cheers,
Mike

-----Original Message-----
From: Gerd Petermann [mailto:[hidden email]]
Sent: 22 February 2019 11:21
To: Mike Baggaley <[hidden email]>; Development list for mkgmap
<[hidden email]>
Subject: Re: [mkgmap-dev] documentation improvement patch

Hi Mike,

I'd also prefer to have only one source for both files. Note that
resources\help\en\options is not only documentation,
it is also parsed by mkgmap to build a list of known options.
I have no idea about the tools which are used, see scripts\options_to_doc.py
for details.

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike
Baggaley <[hidden email]>
Gesendet: Freitag, 22. Februar 2019 08:58
An: 'Development list for mkgmap'
Betreff: Re: [mkgmap-dev] documentation improvement patch

Hi Gerd, I think you are right. I must have stopped and left it at the point
where I needed the logging configuration details. Please find attached an
updated patch.

Note I am not quite clear of the symbols used to format the documentation
(or why we need to manually generate two almost identical copies instead of
deriving one from the other). Can you point me to web pages that describe
the two formats?

Cheers,
Mike

-----Original Message-----
From: Gerd Petermann [mailto:[hidden email]]
Sent: 13 February 2019 13:46
To: Development list for mkgmap <[hidden email]>
Subject: Re: [mkgmap-dev] documentation improvement patch

Hi Mike,

sorry for the late response. I like most of the patch but the introdution
stops with
"The configuration contains lines in the form"

I guess that was the reason why you didn't post it in the past. Maybe just
like to the wiki page: https://wiki.openstreetmap.org/wiki/Mkgmap/dev ?

Gerd

________________________________________
Von: mkgmap-dev <[hidden email]> im Auftrag von Mike
Baggaley <[hidden email]>
Gesendet: Sonntag, 10. Februar 2019 19:12
An: 'Development list for mkgmap'
Betreff: [mkgmap-dev] documentation improvement patch

Hi Gerd, I have attached a patch to improve the documentation of the command
line. I did it some time ago and had forgotten about it, but the discussion
on whether to change default options prompted me to come back to it. The
change is purely to the documentation, no code changes.

Please review and if it meets with your approval, commit.

Thanks,
Mike




_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
Reply | Threaded
Open this post in threaded view
|

Re: documentation improvement patch

Mike Baggaley
Hi Gerd, it looks like I inadvertently indented one section of the file
which caused the blanks. I have reworked the program so that it now has a
very basic understanding of paragraphs and can do the line length limiting
itself. It only has a very basic understanding of HTML (just ,<p>, <pre> and
</pre> and only when on a line by themselves). I have reverted my manual
chopping up of lines in options.txt, so there are now far fewer changes
(though I have fixed a few more typos) so it's much easier to see what is
going on (still lots of changes in the generated options file of course). I
have chopped out a number of <p> tags in options.txt for consistency - there
were some places where it was used before a new option and some where it was
not. Looking at the existing web page, you can see a small difference in
spacing between the two cases.  I just run the buildoptions program from
within my Eclipse Java environment. You can compile and run it by following
the following steps assuming you have a command prompt with its working
directory set to the mkgmap root directory:

cd options
javac buildoptions\main.java
java buildoptions.main

Note that so that the above works, I have changed the hard coded paths to
the input and output files to be relative to the options folder, so if
running from Eclipse, you need to set the working directory to
${workspace_loc:mkgmap/options} instead of using the default.

Cheers,
Mike

-----Original Message-----
From: Gerd Petermann [mailto:[hidden email]]
Sent: 30 December 2019 09:40
To: Mike Baggaley <[hidden email]>; 'Development list for mkgmap'
<[hidden email]>
Subject: AW: [mkgmap-dev] documentation improvement patch

Hi Mike,

thanks for the work. The patch applies fine now.
I don't understand some of the reformatting in options.txt.  I think they
were not intended.
See for example --split-name-index: Blanks at the beginning of the lines and
"See also option road-name-config." is no longer on a separate line.

It seems I am to stupid to run the java program on my machine :(
Please desribe the steps to compile and run it.

Looking at the source it seems you want to force max. 80 characters on one
line in the options.txt file so that the
buildoptions program doesn't have to reformat paragraphs?
This looks like a complicated work flow when I edit options.txt:
Edit, save, run buildoptions program, check if it complains about lines
longer than 80 characters, edit again ...
I think the java code should be able to detect a paragraph and split it into
pieces?

Gerd




_______________________________________________
mkgmap-dev mailing list
[hidden email]
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev

doc-v5.patch (195K) Download Attachment
12