[mkgmap-dev] documentation improvement patch

Fri Feb 22 20:10:00 GMT 2019

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 <mkgmap-dev-bounces at lists.mkgmap.org.uk> im Auftrag von Mike Baggaley <mike at tvage.co.uk>
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: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

_______________________________________________
mkgmap-dev mailing list
mkgmap-dev at lists.mkgmap.org.uk
http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev