Imported Upstream version 1.5
[routino] / doc / html / tagging.html
index 5af6812..8565511 100644 (file)
@@ -75,9 +75,23 @@ are recognised as being affirmative and any other value is ignored.
 
 <h3><a name="H_1_2_1" title="Nodes"></a>Node Tags And Attributes</h3>
 
-None of the node tags are used but the node attributes <em>id</em>, <em>latitude</em>
-and <em>longitude</em> of the node.  The id atribute is required to associate the
-node with the ways and the position attributes are required to locate the node.
+The node attributes <em>id</em>, <em>latitude</em> and <em>longitude</em> are
+used.  The id atribute is required to associate the node with the ways and the
+position attributes are required to locate the node.
+
+
+<h4><a name="H_1_2_1_1" title="transport tags"></a>Transport Specific Tags</h4>
+
+One tag is recognised for each of the different modes of transport: <em>foot</em>,
+<em>horse</em>, <em>bicycle</em>, <em>wheelchair</em>, <em>moped</em>,
+<em>motorbike</em>, <em>motorcar</em>, <em>goods</em>, <em>hgv</em>
+and <em>psv</em>.  These indicate whether the specific type of transport is
+allowed to pass through the node or not.
+
+<p>
+
+By default for nodes all types of transport are allowed to pass through a node
+and specific tags must be used to remove the permissions for the transport.
 
 
 <h3><a name="H_1_2_2" title="Ways"></a>Way Tags And Attributes</h3>
@@ -133,6 +147,11 @@ One tag is recognised for each of the different modes of transport: <em>foot</em
 and <em>psv</em>.  These indicate whether the specific type of transport is
 allowed on the highway or not.
 
+<p>
+
+By default for ways no types of transport are allowed to pass along a highway
+and specific tags must be used to add the permissions for the transport.
+
 
 <h4><a name="H_1_2_2_3" title="name"></a>The name Tag</h4>
 
@@ -182,13 +201,29 @@ The <em>tunnel</em> tag is used to identify whether a highway is a tunnel and
 therefore set one of the available properties.
 
 
-<h4><a name="H_1_2_2_10" title="oneway"></a>The oneway Tag</h4>
+<h4><a name="H_1_2_2_10" title="footroute"></a>The footroute Tag</h4>
+
+The <em>footroute</em> tag is used to identify whether a highway is part of a
+walking route and therefore set one of the available properties.  This is not a
+standard OSM tag and is normally added to the individual highways by looking for
+route relations that are designated for foot access.
+
+
+<h4><a name="H_1_2_2_11" title="bicycleroute"></a>The bicycleroute Tag</h4>
+
+The <em>bicycleroute</em> tag is used to identify whether a highway is part of a
+bicycle route and therefore set one of the available properties.  This is not a
+standard OSM tag and is normally added to the individual highways by looking for
+route relations that are designated for bicycle access.
+
+
+<h4><a name="H_1_2_2_12" title="oneway"></a>The oneway Tag</h4>
 
 The <em>oneway</em> tag is used to specify that traffic is only allowed to
 travel in one direction.
 
 
-<h4><a name="H_1_2_2_11" title="maxspeed"></a>The maxspeed Tag</h4>
+<h4><a name="H_1_2_2_13" title="maxspeed"></a>The maxspeed Tag</h4>
 
 The <em>maxspeed</em> tag is used to specify the maximum speed limit on the
 highway; this is always measured in km/hr in OpenStreetMap data.  If the tag
@@ -196,42 +231,56 @@ value contains "mph" then it is assumed to be a value in those units and
 converted to km/hr.
 
 
-<h4><a name="H_1_2_2_12" title="maxweight"></a>The maxweight Tag</h4>
+<h4><a name="H_1_2_2_14" title="maxweight"></a>The maxweight Tag</h4>
 
 The <em>maxweight</em> tag is used to specify the maximum weight of any traffic
-on the way.  In other words this must be set to the heaviest weight allowed on
-the way (for example a bridge) in tonnes.  If the tag value contains "kg" then
-it is assumed that the value is in these units and converted to tonnes.
+on the highway.  In other words this must be set to the heaviest weight allowed
+on the highway (for example a bridge) in tonnes.  If the tag value contains "kg"
+then it is assumed that the value is in these units and converted to tonnes.
 
 
-<h4><a name="H_1_2_2_13" title="maxheight"></a>The maxheight Tag</h4>
+<h4><a name="H_1_2_2_15" title="maxheight"></a>The maxheight Tag</h4>
 
 The <em>maxheight</em> tag is used to specify the maximum height of any traffic
-on the way.  In other words this must be set to the lowest height of anything
-above the way (like a bridge) in metres.  If the tag value contains a
-measurement in feet or feet and inches then attempts are made to convert this to
-metres.
+on the highway.  In other words this must be set to the lowest height of
+anything above the highway (like a bridge) in metres.  If the tag value contains
+a measurement in feet or feet and inches then attempts are made to convert this
+to metres.
 
 
-<h4><a name="H_1_2_2_14" title="maxwidth"></a>The maxwidth Tag</h4>
+<h4><a name="H_1_2_2_16" title="maxwidth"></a>The maxwidth Tag</h4>
 
 The <em>maxwidth</em> tag is used to specify the maximum width of any traffic on
-the way.  This must be set to the minimum width of the contraints at the wayside
-in metres.  If the tag value contains a measurement in feet or feet and inches
-then attempts are made to convert this to metres.
+the highway.  This must be set to the minimum width of the contraints at the
+wayside in metres.  If the tag value contains a measurement in feet or feet and
+inches then attempts are made to convert this to metres.
 
 
-<h4><a name="H_1_2_2_15" title="maxlength"></a>The maxlength Tag</h4>
+<h4><a name="H_1_2_2_17" title="maxlength"></a>The maxlength Tag</h4>
 
 The <em>maxlength</em> tag is used to specify the maximum length of any traffic
-on the way (usually from a traffic sign) in metres.  If the tag value contains a
-measurement in feet or feet and inches then attempts are made to convert this to
-metres.
+on the highway (usually from a traffic sign) in metres.  If the tag value
+contains a measurement in feet or feet and inches then attempts are made to
+convert this to metres.
 
 
 <h3><a name="H_1_2_3" title="Relations"></a>Relation Tags And Attributes</h3>
 
-Currently no relation tags or attributes are used.
+The tags from the relations are used to associate more properties with the
+highways that are part of that relation.  The <em>id</em> attribute is used so
+that relations that are members of other relations can be identified.
+
+
+<h4><a name="H_1_2_3_1" title="footroute"></a>The footroute Tag</h4>
+
+The <em>footroute</em> tag is used to identify whether a relation defines a
+walking route and therefore should be applied to the individual member highways.
+
+
+<h4><a name="H_1_2_3_2" title="bicycleroute"></a>The bicycleroute Tag</h4>
+
+The <em>bicycleroute</em> tag is used to identify whether a relation defines a
+bicycle route and therefore should be applied to the individual member highways.
 
 
 <h2><a name="H_1_3" title="Tag Transformations"></a>Tag Transformations</h2>
@@ -243,7 +292,106 @@ sequence and this section of the document is arranged in the same order.
 
 <h3><a name="H_1_3_1" title="Nodes"></a>Node Tag Transformations</h3>
 
-No transformations are applicable since no node tags are recognised.
+<h4><a name="H_1_3_1_1" title="Barrier Defaults"></a>Barrier Defaults</h4>
+
+The first part of the tag transformations is to decide on defaults for each type
+of node.  This uses the <em>barrier</em> tag in the OSM file and converts it into
+a default set of disallowed transport types.
+
+<p>
+
+<table>
+  <caption>Transport types through different barrier types</caption>
+  <tr>
+    <th class="left">Barrier
+    <th class="center">foot
+    <th class="center">horse
+    <th class="center">bicycle
+    <th class="center">wheelchair
+    <th class="center">moped
+    <th class="center">motorbike
+    <th class="center">motorcar
+    <th class="center">goods
+    <th class="center">hgv
+    <th class="center">psv
+  <tr>
+    <td class="left">bollard
+    <td class="center">yes
+    <td class="center">yes
+    <td class="center">yes
+    <td class="center">yes
+    <td class="center">yes
+    <td class="center">yes
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+  <tr>
+    <td class="left">kissing_gate
+    <td class="center">yes
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+  <tr>
+    <td class="left">stile
+    <td class="center">yes
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+  <tr>
+    <td class="left">turnstile
+    <td class="center">yes
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+    <td class="center">no
+</table>
+
+<h4><a name="H_1_3_1_2" title="Generic access"></a>Generic Access Permissions</h4>
+
+The <em>access</em> tag is used to specify the default access restrictions
+through the node.  If the tag value is <em>no</em> or <em>private</em> then all
+transport types are denied access (later tag transformation rules may add
+specific transport types back again).
+
+
+<h4><a name="H_1_3_1_3" title="Other access"></a>Other Access Permissions</h4>
+
+A tag named <em>vehicle</em> means any of the <em>bicycle</em>, <em>moped</em>,
+<em>motorbike</em>, <em>motorcar</em>, <em>goods</em>, <em>hgv</em>
+and <em>psv</em> transport types.  A tag named <em>motor_vehicle</em> is
+transformed to mean any vehicle except a <em>bicycle</em>.
+
+
+<h4><a name="H_1_3_1_4" title="Specific access"></a>Specific Access Permissions</h4>
+
+The final part of the access permissions is to use the specific transport type
+tags.
+
+<p>
+
+One tag is recognised for each of the different modes of transport: <em>foot</em>,
+<em>horse</em>, <em>bicycle</em>, <em>wheelchair</em>, <em>moped</em>,
+<em>motorbike</em>, <em>motorcar</em>, <em>goods</em>, <em>hgv</em>
+and <em>psv</em>.  These indicate whether the specific type of transport is
+allowed through the node or not.
 
 
 <h3><a name="H_1_3_2" title="Ways"></a>Way Tag Transformations</h3>
@@ -252,9 +400,9 @@ No transformations are applicable since no node tags are recognised.
 <h4><a name="H_1_3_2_1" title="Highway Defaults"></a>Highway Defaults</h4>
 
 The first part of the tag transformations is to decide on defaults for each type
-of highway.  This uses the highway tag in the OSM file and maps it into one of
-the highway tags that are recognised by Routino, defining the default allowed
-transport types and adding a number of properties.
+of highway.  This uses the <em>highway</em> tag in the OSM file and maps it into
+one of the <em>highway</em> tags that are recognised by Routino, defining the
+default allowed transport types and adding a number of properties.
 
 <p>
 
@@ -542,7 +690,7 @@ highway type.
 <h4><a name="H_1_3_2_2" title="Generic access"></a>Generic Access Permissions</h4>
 
 The <em>access</em> tag is used to specify the default access restrictions on
-the way.  If the tag value is "no" or "private" then all transport types are
+the highway.  If the tag value is "no" or "private" then all transport types are
 denied access (later tag transformation rules may add specific transport types
 back again).
 
@@ -634,7 +782,46 @@ the output.
 
 <h3><a name="H_1_3_3" title="Relations"></a>Relation Tag Transformations</h3>
 
-No transformations are applicable since no relation tags are recognised.
+<h4><a name="H_1_3_3_1" title="Routes"></a>Routes</h4>
+
+The <em>route</em> tag can be used to determine whether a relation is part of a
+walking of bicycle route so that the footroute and bicycleroute properties can
+be applied to the highways that make up that relation.
+
+<p>
+
+The tag transformations that are applied for route relations are defined in the
+table below.
+
+<p>
+
+<table>
+  <caption>Route properties from different route types</caption>
+  <tr>
+    <th class="center">Relation Tag
+    <th class="center">footroute Property
+    <th class="center">bicycleroute Property
+  <tr>
+    <td class="center">foot
+    <td class="center">yes
+    <td class="center">no
+  <tr>
+    <td class="center">walking
+    <td class="center">yes
+    <td class="center">no
+  <tr>
+    <td class="center">hiking
+    <td class="center">yes
+    <td class="center">no
+  <tr>
+    <td class="center">bicycle
+    <td class="center">no
+    <td class="center">yes
+  <tr>
+    <td class="center">bicycle;foot or foot;bicycle
+    <td class="center">yes
+    <td class="center">yes
+</table>
 
 </div>