git.maemo.org Git - routino/blob - doc/OUTPUT.txt

   1                               Routino : Output
   2                               ================
   3
   4
   5    There are three different formats of output from the router, HTML, GPX
   6    (GPS eXchange) XML format and plain text with a total of five possible
   7    output files:
   8      * HTML route instructions for each interesting junction.
   9      * GPX track file containing every node.
  10      * GPX route file with waypoints at interesting junctions.
  11      * Plain text description with the interesting junctions.
  12      * Plain text file with every node.
  13
  14    The "interesting junctions" referred to above are junctions where the
  15    route changes to a different type of highway, more than two highways of
  16    the same type meet, or where the route meets but does not take a more
  17    major highway. When the route follows a major road this definition
  18    eliminates all junctions with minor roads.
  19
  20    The output files are written to the current directory and are named
  21    depending on the selection of shortest or quickest route. For the
  22    shortest route the file names are "shortest.html",
  23    "shortest-track.gpx", "shortest-route.gpx", "shortest.txt" and
  24    "shortest-all.txt", for the quickest route the names are
  25    "quickest.html", "quickest-track.gpx", "quickest-route.gpx",
  26    "quickest.txt" and "quickest-all.txt".
  27
  28    The HTML file and GPX files are written out according to the selected
  29    language using the translations contained in the translations.xml
  30    configuration file.
  31
  32
  33 HTML Route Instructions
  34 -----------------------
  35
  36    The HTML route instructions file contains one line for each of the
  37    interesting junctions in the route and one line for the highway that
  38    connects them.
  39
  40    An example HTML file output is below (some parts are missing, for
  41    example the style definitions):
  42
  43 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  44 <HTML>
  45 <!-- Creator : Routino - http://www.routino.org/ -->
  46 <!-- Source : Based on OpenStreetMap data from http://www.openstreetmap.org/ -->
  47 <!-- License : http://creativecommons.org/licenses/by-sa/2.0/ -->
  48 <HEAD>
  49 <TITLE>Shortest Route</TITLE>
  50 ...
  51 </HEAD>
  52 <BODY>
  53 <H1>Shortest Route</H1>
  54 <table>
  55 <tr class='c'><td class='l'><td class='r'>51.524677 -0.127896
  56 <tr class='n'><td class='l'>Start:<td class='r'>At <span class='w'>Waypoint</span>, head <span class='b'>South-East</span>
  57
  58 <tr class='s'><td class='l'>Follow:<td class='r'><span class='h'>Russell Square</span> for <span class='d'>0.391 km, 0.5 min</span> [<span class='j'>0.4 km, 0 minutes</span>]
  59 ...
  60 <tr class='t'><td class='l'>Total:<td class='r'><span class='j'>6.3 km, 5 minutes</span>
  61 <tr><td class='l'>Stop:<td class='r'><span class='w'>Waypoint</span>
  62 </table>
  63 </BODY>
  64 </HTML>
  65
  66    The coordinates are included in the file but are not visible because of
  67    the style definitions.
  68
  69
  70 GPX Track File
  71 --------------
  72
  73    The GPX track file contains a track with all of the individual nodes
  74    that the route passes through.
  75
  76    An example GPX track file output is below:
  77
  78 <?xml version="1.0" encoding="UTF-8"?>
  79 <gpx version="1.1" creator="Routino" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  80                                      xmlns="http://www.topografix.com/GPX/1/1"
  81                                      xsi:schemaLocation="http://www.topografix.com/GPX/1/1 http://www.topografix.com/GPX/1/1/gpx.xsd">
  82 <metadata>
  83 <desc>Creator : Routino - http://www.routino.org/</desc>
  84 <copyright author="Based on OpenStreetMap data from http://www.openstreetmap.org/">
  85 <license>http://creativecommons.org/licenses/by-sa/2.0/</license>
  86 </copyright>
  87 </metadata>
  88 <trk>
  89 <name>Shortest route</name>
  90 <desc>Shortest route between 'start' and 'finish' waypoints</desc>
  91 <trkpt lat="51.524677" lon="-0.127896"/>
  92 <trkpt lat="51.523830" lon="-0.126993"/>
  93 ...
  94 <trkpt lat="51.478353" lon="-0.103561"/>
  95 <trkpt lat="51.478244" lon="-0.103652"/>
  96 </trkseg>
  97 </trk>
  98 </gpx>
  99
 100
 101 GPX Route File
 102 --------------
 103
 104    The GPX route file contains a route (ordered set of waypoints) with all
 105    of the interesting junctions that the route passes through.
 106
 107    An example GPX route file output is below:
 108
 109 <?xml version="1.0" encoding="UTF-8"?>
 110 <gpx version="1.1" creator="Routino" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 111                                      xmlns="http://www.topografix.com/GPX/1/1"
 112                                      xsi:schemaLocation="http://www.topografix.com/GPX/1/1 http://www.topografix.com/GPX/1/1/gpx.xsd">
 113 <metadata>
 114 <desc>Creator : Routino - http://www.routino.org/</desc>
 115 <copyright author="Based on OpenStreetMap data from http://www.openstreetmap.org/">
 116 <license>http://creativecommons.org/licenses/by-sa/2.0/</license>
 117 </copyright>
 118 </metadata>
 119 <rte>
 120 <name>Shortest route</name>
 121 <desc>Shortest route between 'start' and 'finish' waypoints</desc>
 122 <rtept lat="51.524677" lon="-0.127896"><name>START</name>
 123 <desc>South-East on 'Russell Square' for 0.391 km, 0.5 min</desc></rtept>
 124 <rtept lat="51.521815" lon="-0.124577"><name>TRIP001</name>
 125 <desc>South-East on 'Russell Square' for 0.055 km, 0.1 min</desc></rtept>
 126 ...
 127 <rtept lat="51.478244" lon="-0.103652"><name>FINISH</name>
 128 <desc>Total Journey 6.3 km, 5 minutes</desc></rtept>
 129 </rte>
 130 </gpx>
 131
 132
 133 Text File
 134 ---------
 135
 136    The text file format contains one entry for all of the interesting
 137    junctions in the route and is intended to be easy to interpret.
 138
 139    An example text file output is below:
 140
 141 # Creator : Routino - http://www.routino.org/
 142 # Source : Based on OpenStreetMap data from http://www.openstreetmap.org/
 143 # License : http://creativecommons.org/licenses/by-sa/2.0/
 144 #
 145 #Latitude       Longitude       Section         Section         Total     Total           Point   Turn    Bearing Highway
 146 #                               Distance        Duration        Distance  Duration        Type
 147  51.524677        -0.127896      0.000 km        0.0 min          0.0 km   0 min        Waypt            +3
 148  51.521815        -0.124577      0.391 km        0.5 min          0.4 km   0 min        Junct    +0      +3     Russell Square
 149 ...
 150  51.478353        -0.103561      0.598 km        0.4 min          6.2 km   5 min        Junct    +2      -3     Camberwell New Road (A202)
 151  51.478244        -0.103652      0.013 km        0.0 min          6.3 km   5 min        Waypt                   Vassall Road
 152
 153    The text file output contains a header (indicated by the lines starting
 154    with '#') and then one line for each junction. Each line contains the
 155    information for the route up to that point and the direction to go
 156    next. For each of the lines the individual fields contain the
 157    following:
 158
 159    Latitude - Location of the point (degrees)
 160
 161    Longitude - Location of the point (degrees)
 162
 163    Section Distance - The distance travelled on the section of the journey
 164    that ends at this point (defined on this line).
 165
 166    Section Duration - The duration of travel on the section of the journey
 167    that ends at this point (defined on this line).
 168
 169    Total Distance - The total distance travelled up to this point.
 170
 171    Total Duration - The total duration of travel up to this point.
 172
 173    Point Type - The type of point; either a waypoint Waypt or junction
 174    Junct.
 175
 176    Turn - The direction to turn at this point (missing for the first point
 177    since the journey has not started yet and the last point because it has
 178    finished). This can take one of nine values between -4 and +4 defined
 179    by: 0 = Straight, +2 = Right, -2 = Left and +/-4 = Reverse.
 180
 181    Bearing - The direction to head at this point (missing for the last point
 182    since the journey has finished). This can take one of nine values
 183    between -4 and +4 defined by: 0 = North, +2 = East, -2 = West and +/-4
 184    = South.
 185
 186    Highway - The name (or description) of the highway to follow (missing on
 187    the first line).
 188
 189    The individual items are separated by tabs but some of the items
 190    contain spaces as well.
 191
 192
 193 All Nodes Text File
 194 -------------------
 195
 196    The all nodes text file format contains one entry for each of the nodes
 197    on the route.
 198
 199    An example all nodes text file output is below:
 200
 201 # Creator : Routino - http://www.routino.org/
 202 # Source : Based on OpenStreetMap data from http://www.openstreetmap.org/
 203 # License : http://creativecommons.org/licenses/by-sa/2.0/
 204 #
 205 #Latitude       Longitude           Node        Type    Segment Segment Total  Total   Speed   Bearing Highway
 206 #                                                       Dist    Durat'n Dist   Durat'n
 207  51.524677        -0.127896      7485978*       Waypt   0.000    0.00    0.00  0.0
 208  51.523830        -0.126993      7485047*       Junct   0.113    0.14    0.11  0.1    96      146    Woburn Place
 209 ...
 210  51.478353        -0.103561      7576939*       Junct   0.104    0.07    6.25  5.0    96      126    Camberwell New Road (A202)
 211  51.478244        -0.103652      7581605        Waypt   0.013    0.01    6.26  5.0    64      207    Vassall Road
 212
 213    The all nodes text file output is similar to the text file output
 214    except that a line is printed for each of the nodes rather than just
 215    the interesting junctions. For each of the lines the individual fields
 216    contain the following:
 217
 218    Latitude - Location of the point in degrees.
 219
 220    Longitude - Location of the point in degrees.
 221
 222    Node - The internal node number and an indicator "*" if the node is a
 223    super-node.
 224
 225    Type - The type of point; a waypoint Waypt, junction Junct, change of
 226    highway Change or intermediate node Inter.
 227
 228    Segment Distance - The distance travelled on the segment defined on this
 229    line.
 230
 231    Segment Duration - The duration of travel on the segment defined on this
 232    line.
 233
 234    Total Distance - The total distance travelled up to this point.
 235
 236    Total Duration - The total duration of travel up to this point.
 237
 238    Speed - The speed of travel on the segment defined on this line (missing
 239    on the first line).
 240
 241    Bearing - The direction that the segment defined on this line travels in
 242    degrees (missing on the first line).
 243
 244    Highway - The name (or description) of the highway segment (missing on
 245    the first line).
 246
 247
 248 --------
 249
 250 Copyright 2008-2010 Andrew M. Bishop.