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:
http://www.mkgmap.org.uk/doc/pdf/style-manual.pdf
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.
Index: doc/styles/files.txt
===================================================================
--- doc/styles/files.txt (revisión: 2450)
+++ doc/styles/files.txt (copia de trabajo)
@@ -12,16 +12,16 @@
are explained in <<style-packaging,making a style package>>.
== Files ==
-This files are read in the order that they are listed here. In general files that are read first take priority over files read later.
+These files are read in the order that they are listed here. In general, files that are read first take priority over files read later.
The only one of these files that is actually required is the +version+
-file as that is used to recognise the style.
+file, as that is used to recognise the style.
At least one of the +points+, +lines+ or +polygons+ files must be present
or else the resulting maps will be empty.
=== Top level folder ===
Choose a short name for your style, it should be one word or a couple of words joined by an underscore or hyphen. This is how people will refer to the style when it is finished.
Create a directory or folder with that name. Then you must create one or
-more files in this directory as detailed below. Only the _version_ file is required.
+more files in this directory as detailed below. Only the +version+ file is required.
== The version file
This file _must_ exist as it is used to recognise a valid style.
@@ -50,8 +50,8 @@
description:: A longer description of your style.
-base-style:: Do not use anymore. This is was used to base a style on
-another one. However it is bug prone and behaves in a way that is not
+base-style:: Do not use anymore. This was used to base a style on
+another one. However, it is bug prone and behaves in a way that is not
intuitive without a good understanding of how things work.
The preferred way to do this is to use the include mechanism.
@@ -59,7 +59,7 @@
====
Here is an example based on the +info+ file from the default style.
You can see it uses both equal and colon as separators, normally you
-would just pick one and use it consistently but it doesn't make any
+would just pick one and use it consistently, but it doesn't make any
difference which one you use.
The description is written over several lines surrounded in curly
brackets.
@@ -67,7 +67,7 @@
----
#
# This file contains information about the style.
-#
+#
summary: The default style
@@ -87,7 +87,7 @@
Only command line options that affect the style will have any effect.
The current list is +name-tag-list+, +levels+ and +extra-used-tags+.
-It is advisable to set up the levels that you want as the default is not
+It is advisable to set up the levels that you want, as the default is not
suitable for all kinds of maps and may change in the future. Ideally,
you should set the same levels as are used in your style files. For
example, if your style files use levels 12,16,20,22,23,24 then it's a
@@ -104,6 +104,8 @@
== The points file
This files contains a set of rules for converting
OSM nodes to Garmin POIs (restaurants, bars, ATMs etc).
+It can also contain rules for some kind of OSM nodes that may
+affect routing behavior, for example barriers, traffic_calming, traffic_signals, etc.
If this file is not present or empty then there will be no POI's in the
final map.
@@ -112,12 +114,12 @@
Like all other files, a hash symbol '#' introduces a comment.
== The lines file
-This file contains a set of rules for converting OSM ways to Garmin lines (roads, rivers, barriers etc).
+This file contains a set of rules for converting OSM ways to Garmin lines (roads, rivers, barriers, etc).
The syntax of the file is described in the <<RULES,style rules section>>.
== The polygons file
This file contains a set of rules for converting polygons to Garmin
-areas (fields, buildings, residential areas etc).
+areas (fields, buildings, residential areas, etc).
The syntax of the file is described in the <<RULES,style rules section>>.
== The relations file
@@ -127,11 +129,11 @@
Instead it is used to modify the ways or nodes that are contained in the
relation.
-So for example if the relation represents a route, then you might add one
+So for example, if the relation represents a route, then you might add one
or more tags to all the ways that make up the route so that they can be
processed in the +lines+ file specially.
-The syntax of the file is also described in the <<RULES,style rules section>>
+The syntax of the file is also described in the <<RULES,style rules section>>,
but the rules can only have an action part, they must not have a type
description part.
@@ -150,7 +152,7 @@
0x123: 0x02, 0x23
----
-Then set the TYP file contain arrows for code 0x23.
+Then set the TYP file contain arrows for code 0x23.
Note that only the first way in the overlays file is routable.
////
Index: doc/styles/style-manual.txt
===================================================================
--- doc/styles/style-manual.txt (revisión: 2450)
+++ doc/styles/style-manual.txt (copia de trabajo)
@@ -21,7 +21,7 @@
Garmin map and which Garmin symbols are used.
There are a few styles built into mkgmap, but
-as there are many different purposes a map may used for, the default
+as there are many different purposes a map may be used for, the default
styles in mkgmap will not be ideal for everyone, so
you can create and use styles external to mkgmap.
@@ -40,8 +40,8 @@
starting with a Polish format file, there is no style involved as the
garmin types are already fully specified in the input file.
-For general information about the Open Street Map project see the
-link:http://wiki.openstreetmap.org[Open Street Map wiki].
+For general information about the OpenStreetMap project see the
+link:http://wiki.openstreetmap.org[OpenStreetMap wiki].
:leveloffset: 1
_______________________________________________
mkgmap-dev mailing list
[email protected]
http://lists.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
