Hi The project needs a good set of documentation maintained along with the code that can be delivered as part of the distribution. We do have a reasonable amount of documentation with the built in help for all options, on the osm wiki and in the doc directory in the source. However it is scattered and there is no really clear place for a newcomer to start. So I think we need a tutorial document that takes you from "first map" and then gradually enhances it until you are in a position to build and distribute a complete map set. I have started on a separate document that will completely document the style system and language. The current drafts can be seen in pdf format here: http://www.mkgmap.org.uk/doc/pdf/style-manual.pdf So that shows the idea. I'll start on the tutorial, but I'm probably not the best person to write most of it, especially anything Windows related. So I will be looking for help with it. I would also like to collect some how-to type documents as well. I'm also going to start removing any out of date information in the mkgmap/doc directory too. ..Steve
Steve,
I have started on a separate document that will completely document the style system and language. The current drafts can be seen in pdf format here:
This is great! Exactly what is needed! There are a few style elements which I have come across in other people's files, which I don't think you have included yet: (xx|conv:m=>ft} {xx|subst:regexp1=>regexp2} {xx|def: } {echo "message"} Keep up the good work! I know from experience how hard it is to write a decent manual! Roger -- ------------------------------------------------------------------------ Roger Calvert ------------------------------------------------------------------------
Hi
There are a few style elements which I have come across in other people's files, which I don't think you have included yet:
(xx|conv:m=>ft} {xx|subst:regexp1=>regexp2} {xx|def: } {echo "message"}
Yes, that is a whole new section that needs writing about how variable filters work and to list them all with their arguments. Also the include directive, and there is a whole section on putting it all together to design a style which is only in draft state and not included in the pdf yet. ..Steve
El 12/01/13 23:57, Steve Ratcliffe escribió:
I have started on a separate document that will completely document the style system and language. The current drafts can be seen in pdf format here:
Good start point!
I'll start on the tutorial, but I'm probably not the best person to write most of it, especially anything Windows related. So I will be looking for help with it.
I have made some cosmetic changes to the first two files of the style doc, not great changes. See attached patch.
participants (3)
-
Carlos Dávila -
Roger Calvert -
Steve Ratcliffe