[mkgmap-dev] documentation improvement patch

Mon Dec 30 09:39:50 GMT 2019

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 <mkgmap-dev-bounces at lists.mkgmap.org.uk> im Auftrag von Mike Baggaley <mike at tvage.co.uk>
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:gpetermann_muenchen at hotmail.com]
Sent: 28 February 2019 06:52
To: Mike Baggaley <mike at tvage.co.uk>; Development list for mkgmap
<mkgmap-dev at lists.mkgmap.org.uk>
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 <mkgmap-dev-bounces at lists.mkgmap.org.uk> im Auftrag von Mike
Baggaley <mike at tvage.co.uk>
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:mike at tvage.co.uk]
Sent: 22 February 2019 20:04
To: 'Development list for mkgmap' <mkgmap-dev at lists.mkgmap.org.uk>
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:gpetermann_muenchen at hotmail.com]
Sent: 22 February 2019 11:21
To: Mike Baggaley <mike at tvage.co.uk>; Development list for mkgmap
<mkgmap-dev at lists.mkgmap.org.uk>
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 <mkgmap-dev-bounces at lists.mkgmap.org.uk> im Auftrag von Mike
Baggaley <mike at tvage.co.uk>
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:gpetermann_muenchen at hotmail.com]
Sent: 13 February 2019 13:46
To: Development list for mkgmap <mkgmap-dev at lists.mkgmap.org.uk>
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 <mkgmap-dev-bounces at lists.mkgmap.org.uk> im Auftrag von Mike
Baggaley <mike at tvage.co.uk>
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