Check out the latest version of Routino: svn co http://routino.org/svn/trunk routino
Contents of /trunk/doc/html/output.html
Parent Directory
| 
Revision Log
Revision 1076 -
(show annotations)
(download)
(as text)
Tue Sep 25 18:21:00 2012 UTC (12 years, 6 months ago) by amb
File MIME type: text/html
File size: 16324 byte(s)
Tue Sep 25 18:21:00 2012 UTC (12 years, 6 months ago) by amb
File MIME type: text/html
File size: 16324 byte(s)
Change the example output now that the copyright notice has changed, the final turn is no longer missed and minor junctions are formatted differently in the all text format.
| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| 2 | <HTML> |
| 3 | |
| 4 | <!-- |
| 5 | Routino documentation - output |
| 6 | |
| 7 | Part of the Routino routing software. |
| 8 | |
| 9 | This file Copyright 2008-2012 Andrew M. Bishop |
| 10 | |
| 11 | This program is free software: you can redistribute it and/or modify |
| 12 | it under the terms of the GNU Affero General Public License as published by |
| 13 | the Free Software Foundation, either version 3 of the License, or |
| 14 | (at your option) any later version. |
| 15 | |
| 16 | This program is distributed in the hope that it will be useful, |
| 17 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 19 | GNU Affero General Public License for more details. |
| 20 | |
| 21 | You should have received a copy of the GNU Affero General Public License |
| 22 | along with this program. If not, see http://www.gnu.org/licenses/. |
| 23 | --> |
| 24 | |
| 25 | <HEAD> |
| 26 | <TITLE>Routino : Output</TITLE> |
| 27 | <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 28 | <LINK href="style.css" type="text/css" rel="stylesheet"> |
| 29 | </HEAD> |
| 30 | |
| 31 | <BODY> |
| 32 | |
| 33 | <!-- Header Start --> |
| 34 | |
| 35 | <div class="header" align="center"> |
| 36 | |
| 37 | <h1>Routino : Output</h1> |
| 38 | |
| 39 | <hr> |
| 40 | </div> |
| 41 | |
| 42 | <!-- Header End --> |
| 43 | |
| 44 | <!-- Content Start --> |
| 45 | |
| 46 | <div class="content"> |
| 47 | |
| 48 | <h2><a name="H_1_1"></a>Router Output</h2> |
| 49 | |
| 50 | There are three different formats of output from the router, HTML, |
| 51 | <a class="ext" title="GPX format" href="http://www.topografix.com/gpx.asp">GPX (GPS eXchange) XML format</a> |
| 52 | and plain text with a total of five possible output files: |
| 53 | <ul> |
| 54 | <li>HTML route instructions for each interesting junction. |
| 55 | <li>GPX track file containing every node. |
| 56 | <li>GPX route file with waypoints at interesting junctions. |
| 57 | <li>Plain text description with the interesting junctions. |
| 58 | <li>Plain text file with every node. |
| 59 | </ul> |
| 60 | |
| 61 | The "interesting junctions" referred to above are junctions where the route |
| 62 | changes to a different type of highway, more than two highways of the same type |
| 63 | meet, or where the route meets but does not take a more major highway. When the |
| 64 | route follows a major road this definition eliminates all junctions with minor |
| 65 | roads. |
| 66 | |
| 67 | <p> |
| 68 | |
| 69 | The output files are written to the current directory and are named depending on |
| 70 | the selection of shortest or quickest route. For the shortest route the file |
| 71 | names are "shortest.html", "shortest-track.gpx", "shortest-route.gpx", |
| 72 | "shortest.txt" and "shortest-all.txt", for the quickest route the names are |
| 73 | "quickest.html", "quickest-track.gpx", "quickest-route.gpx", "quickest.txt" and |
| 74 | "quickest-all.txt". |
| 75 | |
| 76 | <p> |
| 77 | |
| 78 | The HTML file and GPX files are written out according to the selected language |
| 79 | using the translations contained in the translations.xml configuration file. |
| 80 | The text files contains untranslated header lines (in English) but the data is |
| 81 | translated. |
| 82 | |
| 83 | <!-- For reference the examples were produced from the following URL: |
| 84 | http://www.routino.org/uk/router.html?transport=motorcar;lon1=-0.12790;lat1=51.52468;lon2=-0.10365;lat2=51.47824 --> |
| 85 | |
| 86 | <h3><a name="H_1_1_1" title="HTML file"></a>HTML Route Instructions</h3> |
| 87 | |
| 88 | The HTML route instructions file contains one line for the description of each |
| 89 | of the interesting junctions in the route and one line for each of the highways |
| 90 | that connect them. The coordinates are also included in the file but are not |
| 91 | visible because of the style definitions. |
| 92 | |
| 93 | <p> |
| 94 | |
| 95 | An example HTML file output is below (some parts are missing, for example the |
| 96 | style definitions): |
| 97 | |
| 98 | <pre class="boxed"> |
| 99 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| 100 | <HTML> |
| 101 | <!-- Creator : Routino - http://www.routino.org/ --> |
| 102 | <!-- Source : Based on OpenStreetMap data from http://www.openstreetmap.org/ --> |
| 103 | <!-- License : http://www.openstreetmap.org/copyright --> |
| 104 | <HEAD> |
| 105 | <TITLE>Shortest Route</TITLE> |
| 106 | ... |
| 107 | </HEAD> |
| 108 | <BODY> |
| 109 | <H1>Shortest Route</H1> |
| 110 | <table> |
| 111 | <tr class='c'><td class='l'>1:<td class='r'>51.524658 -0.127877 |
| 112 | <tr class='n'><td class='l'>Start:<td class='r'>At <span class='w'>Waypoint</span>, head <span class='b'>South-East</span> |
| 113 | <tr class='s'><td class='l'>Follow:<td class='r'><span class='h'>Woburn Place (A4200)</span> for <span class='d'>0.251 km, 0.3 min</span> [<span class='j'>0.3 km, 0 minutes</span>] |
| 114 | <tr class='c'><td class='l'>2:<td class='r'>51.522811 -0.125781 |
| 115 | <tr class='n'><td class='l'>At:<td class='r'>Junction, go <span class='t'>Straight on</span> heading <span class='b'>South-East</span> |
| 116 | <tr class='s'><td class='l'>Follow:<td class='r'><span class='h'>Russell Square (A4200)</span> for <span class='d'>0.186 km, 0.2 min</span> [<span class='j'>0.4 km, 1 minutes</span>] |
| 117 | <tr class='c'><td class='l'>3:<td class='r'>51.521482 -0.124123 |
| 118 | <tr class='n'><td class='l'>At:<td class='r'>Junction, go <span class='t'>Straight on</span> heading <span class='b'>South-East</span> |
| 119 | <tr class='s'><td class='l'>Follow:<td class='r'><span class='h'>Southampton Row (A4200)</span> for <span class='d'>0.351 km, 0.4 min</span> [<span class='j'>0.8 km, 1 minutes</span>] |
| 120 | ... |
| 121 | <tr class='c'><td class='l'>21:<td class='r'>51.477678 -0.106792 |
| 122 | <tr class='n'><td class='l'>At:<td class='r'>Junction, go <span class='t'>Slight left</span> heading <span class='b'>South-East</span> |
| 123 | <tr class='s'><td class='l'>Follow:<td class='r'><span class='h'>Vassall Road</span> for <span class='d'>0.138 km, 0.2 min</span> [<span class='j'>6.3 km, 6 minutes</span>] |
| 124 | <tr class='c'><td class='l'>22:<td class='r'>51.478015 -0.104870 |
| 125 | <tr class='n'><td class='l'>At:<td class='r'>Junction, go <span class='t'>Straight on</span> heading <span class='b'>East</span> |
| 126 | <tr class='s'><td class='l'>Follow:<td class='r'><span class='h'>Vassall Road</span> for <span class='d'>0.087 km, 0.1 min</span> [<span class='j'>6.4 km, 6 minutes</span>] |
| 127 | <tr class='c'><td class='l'>23:<td class='r'>51.478244 -0.103651 |
| 128 | <tr class='n'><td class='l'>Stop:<td class='r'>At <span class='w'>Waypoint</span> |
| 129 | <tr class='t'><td class='l'>Total:<td class='r'><span class='j'>6.4 km, 6 minutes</span> |
| 130 | </table> |
| 131 | </BODY> |
| 132 | </HTML> |
| 133 | </pre> |
| 134 | |
| 135 | |
| 136 | <h3><a name="H_1_1_2" title="GPX track file"></a>GPX Track File</h3> |
| 137 | |
| 138 | The GPX track file contains a track with all of the individual nodes that the |
| 139 | route passes through. |
| 140 | |
| 141 | <p> |
| 142 | |
| 143 | An example GPX track file output is below: |
| 144 | |
| 145 | <pre class="boxed"> |
| 146 | <?xml version="1.0" encoding="UTF-8"?> |
| 147 | <gpx version="1.1" creator="Routino" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.topografix.com/GPX/1/1" xsi:schemaLocation="http://www.topografix.com/GPX/1/1 http://www.topografix.com/GPX/1/1/gpx.xsd"> |
| 148 | <metadata> |
| 149 | <desc>Creator : Routino - http://www.routino.org/</desc> |
| 150 | <copyright author="Based on OpenStreetMap data from http://www.openstreetmap.org/"> |
| 151 | <license>http://www.openstreetmap.org/copyright</license> |
| 152 | </copyright> |
| 153 | </metadata> |
| 154 | <trk> |
| 155 | <name>Shortest route</name> |
| 156 | <desc>Shortest route between 'start' and 'finish' waypoints</desc> |
| 157 | <trkpt lat="51.524658" lon="-0.127877"/> |
| 158 | <trkpt lat="51.523768" lon="-0.126918"/> |
| 159 | <trkpt lat="51.522811" lon="-0.125781"/> |
| 160 | ... |
| 161 | <trkpt lat="51.478015" lon="-0.104870"/> |
| 162 | <trkpt lat="51.478127" lon="-0.104174"/> |
| 163 | <trkpt lat="51.478244" lon="-0.103651"/> |
| 164 | </trkseg> |
| 165 | </trk> |
| 166 | </gpx> |
| 167 | </pre> |
| 168 | |
| 169 | |
| 170 | <h3><a name="H_1_1_3" title="GPX route file"></a>GPX Route File</h3> |
| 171 | |
| 172 | The GPX route file contains a route (ordered set of waypoints) with all of the |
| 173 | interesting junctions that the route passes through and a description of the |
| 174 | route to take from that point. |
| 175 | |
| 176 | <p> |
| 177 | |
| 178 | An example GPX route file output is below: |
| 179 | |
| 180 | <pre class="boxed"> |
| 181 | <?xml version="1.0" encoding="UTF-8"?> |
| 182 | <gpx version="1.1" creator="Routino" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.topografix.com/GPX/1/1" xsi:schemaLocation="http://www.topografix.com/GPX/1/1 http://www.topografix.com/GPX/1/1/gpx.xsd"> |
| 183 | <metadata> |
| 184 | <desc>Creator : Routino - http://www.routino.org/</desc> |
| 185 | <copyright author="Based on OpenStreetMap data from http://www.openstreetmap.org/"> |
| 186 | <license>http://www.openstreetmap.org/copyright</license> |
| 187 | </copyright> |
| 188 | </metadata> |
| 189 | <rte> |
| 190 | <name>Shortest route</name> |
| 191 | <desc>Shortest route between 'start' and 'finish' waypoints</desc> |
| 192 | <rtept lat="51.524658" lon="-0.127877"> |
| 193 | <name>START</name> |
| 194 | <desc>South-East on 'Woburn Place (A4200)' for 0.251 km, 0.3 min</desc> |
| 195 | </rtept> |
| 196 | <rtept lat="51.522811" lon="-0.125781"> |
| 197 | <name>TRIP001</name> |
| 198 | <desc>South-East on 'Russell Square (A4200)' for 0.186 km, 0.2 min</desc> |
| 199 | </rtept> |
| 200 | <rtept lat="51.521482" lon="-0.124123"> |
| 201 | <name>TRIP002</name> |
| 202 | <desc>South-East on 'Southampton Row (A4200)' for 0.351 km, 0.4 min</desc> |
| 203 | </rtept> |
| 204 | ... |
| 205 | <rtept lat="51.477678" lon="-0.106792"> |
| 206 | <name>TRIP020</name> |
| 207 | <desc>South-East on 'Vassall Road' for 0.138 km, 0.2 min</desc> |
| 208 | </rtept> |
| 209 | <rtept lat="51.478015" lon="-0.104870"> |
| 210 | <name>TRIP021</name> |
| 211 | <desc>East on 'Vassall Road' for 0.087 km, 0.1 min</desc> |
| 212 | </rtept> |
| 213 | <rtept lat="51.478244" lon="-0.103651"> |
| 214 | <name>FINISH</name> |
| 215 | <desc>Total Journey 6.4 km, 6 minutes</desc> |
| 216 | </rtept> |
| 217 | </rte> |
| 218 | </gpx> |
| 219 | </pre> |
| 220 | |
| 221 | |
| 222 | <h3><a name="H_1_1_4" title="Text file"></a>Text File</h3> |
| 223 | |
| 224 | The text file format contains one entry for all of the interesting junctions in |
| 225 | the route and is intended to be easy to interpret, for example for creating |
| 226 | other output formats. |
| 227 | |
| 228 | <p> |
| 229 | |
| 230 | An example text file output is below: |
| 231 | |
| 232 | <pre class="boxed"> |
| 233 | # Creator : Routino - http://www.routino.org/ |
| 234 | # Source : Based on OpenStreetMap data from http://www.openstreetmap.org/ |
| 235 | # License : http://www.openstreetmap.org/copyright |
| 236 | # |
| 237 | #Latitude Longitude Section Section Total Total Point Turn Bearing Highway |
| 238 | # Distance Duration Distance Duration Type |
| 239 | 51.524658 -0.127877 0.000 km 0.0 min 0.0 km 0 min Waypt +3 Woburn Place (A4200) |
| 240 | 51.522811 -0.125781 0.251 km 0.3 min 0.3 km 0 min Junct +0 +3 Russell Square (A4200) |
| 241 | 51.521482 -0.124123 0.186 km 0.2 min 0.4 km 1 min Junct +0 +3 Southampton Row (A4200) |
| 242 | ... |
| 243 | 51.477678 -0.106792 0.204 km 0.2 min 6.1 km 5 min Junct +0 +3 Vassall Road |
| 244 | 51.478015 -0.104870 0.138 km 0.2 min 6.3 km 6 min Junct +0 +2 Vassall Road |
| 245 | 51.478244 -0.103651 0.087 km 0.1 min 6.4 km 6 min Waypt |
| 246 | </pre> |
| 247 | |
| 248 | <p> |
| 249 | |
| 250 | The text file output contains a header (indicated by the lines starting with |
| 251 | '#') and then one line for each waypoint or junction. Each line contains the |
| 252 | information for the current node and the next segment to be followed. |
| 253 | |
| 254 | For each of the lines the individual fields contain the following: |
| 255 | |
| 256 | <table> |
| 257 | <tr> |
| 258 | <th>Item |
| 259 | <th class=left>Description |
| 260 | <tr> |
| 261 | <td>Latitude |
| 262 | <td>Location of the node (degrees) |
| 263 | <tr> |
| 264 | <td>Longitude |
| 265 | <td>Location of the node (degrees) |
| 266 | <tr> |
| 267 | <td>Section Distance |
| 268 | <td>The distance travelled on the section of the journey that ends at this |
| 269 | node. |
| 270 | <tr> |
| 271 | <td>Section Duration |
| 272 | <td>The duration of travel on the section of the journey that ends at this |
| 273 | node. |
| 274 | <tr> |
| 275 | <td>Total Distance |
| 276 | <td>The total distance travelled up to this point. |
| 277 | <tr> |
| 278 | <td>Total Duration |
| 279 | <td>The total duration of travel up to this point. |
| 280 | <tr> |
| 281 | <td>Point Type |
| 282 | <td>The type of point; either a waypoint <em>Waypt</em> or junction |
| 283 | <em>Junct</em>. |
| 284 | <tr> |
| 285 | <td>Turn |
| 286 | <td>The direction to turn at this point (missing for the first line since |
| 287 | the journey has not started yet and for the last line because it has |
| 288 | finished). This can take one of nine values between -4 and +4 defined by: |
| 289 | 0 = <em>Straight</em>, +2 = <em>Right</em>, -2 = <em>Left</em> and +/-4 |
| 290 | = <em>Reverse</em>. |
| 291 | <tr> |
| 292 | <td>Bearing |
| 293 | <td>The direction to head from this point (missing for the last line since |
| 294 | the journey has finished). This can take one of nine values between -4 |
| 295 | and +4 defined by: 0 = <em>North</em>, +2 = <em>East</em>, -2 |
| 296 | = <em>West</em> and +/-4 = <em>South</em>. |
| 297 | <tr> |
| 298 | <td>Highway |
| 299 | <td>The name (or description) of the highway to follow from this point |
| 300 | (missing on the last line since the journey has finished). |
| 301 | </table> |
| 302 | |
| 303 | <p> |
| 304 | |
| 305 | The individual items are separated by tabs but some of the items contain spaces |
| 306 | as well. |
| 307 | |
| 308 | |
| 309 | <h3><a name="H_1_1_5" title="All nodes text file"></a>All Nodes Text File</h3> |
| 310 | |
| 311 | The all nodes text file format contains one entry for each of the nodes on the |
| 312 | route. |
| 313 | |
| 314 | <p> |
| 315 | |
| 316 | An example all nodes text file output is below: |
| 317 | |
| 318 | <pre class="boxed"> |
| 319 | # Creator : Routino - http://www.routino.org/ |
| 320 | # Source : Based on OpenStreetMap data from http://www.openstreetmap.org/ |
| 321 | # License : http://www.openstreetmap.org/copyright |
| 322 | # |
| 323 | #Latitude Longitude Node Type Segment Segment Total Total Speed Bearing Highway |
| 324 | # Dist Durat'n Dist Durat'n |
| 325 | 51.524658 -0.127877 8439703* Waypt 0.000 0.00 0.00 0.0 |
| 326 | 51.523768 -0.126918 8439948* Junct- 0.119 0.15 0.12 0.1 96 146 Woburn Place (A4200) |
| 327 | 51.522811 -0.125781 8440207* Junct 0.132 0.17 0.25 0.3 96 143 Woburn Place (A4200) |
| 328 | ... |
| 329 | 51.478015 -0.104870 8529638* Change 0.138 0.17 6.26 5.6 48 74 Vassall Road |
| 330 | 51.478127 -0.104174 8529849* Junct- 0.049 0.04 6.31 5.7 64 75 Vassall Road |
| 331 | 51.478244 -0.103651 8530008 Waypt 0.038 0.04 6.35 5.7 64 70 Vassall Road |
| 332 | </pre> |
| 333 | |
| 334 | <p> |
| 335 | |
| 336 | The all nodes text file output contains a header (indicated by the lines |
| 337 | starting with '#') and then one line for each node and the segment that was used |
| 338 | to reach it. This file therefore contains exactly the same model as is used |
| 339 | internally to define a route (a series of results each of which is a node and |
| 340 | the segment leading to it). |
| 341 | |
| 342 | For each of the lines the individual fields contain the following: |
| 343 | |
| 344 | <table> |
| 345 | <tr> |
| 346 | <th>Item |
| 347 | <th class=left>Description |
| 348 | <tr> |
| 349 | <td>Latitude |
| 350 | <td>Location of the node in degrees. |
| 351 | <tr> |
| 352 | <td>Longitude |
| 353 | <td>Location of the node in degrees. |
| 354 | <tr> |
| 355 | <td>Node |
| 356 | <td>The internal node number and an indicator "*" if the node is a super-node. |
| 357 | <tr> |
| 358 | <td>Type |
| 359 | <td>The type of point; a waypoint <em>Waypt</em>, important |
| 360 | junction <em>Junct</em>, unimportant junction <em>Junct-</em>, change of |
| 361 | highway <em>Change</em> or intermediate node <em>Inter</em>. |
| 362 | <tr> |
| 363 | <td>Segment Distance |
| 364 | <td>The distance travelled on the segment defined on this line. |
| 365 | <tr> |
| 366 | <td>Segment Duration |
| 367 | <td>The duration of travel on the segment defined on this line. |
| 368 | <tr> |
| 369 | <td>Total Distance |
| 370 | <td>The total distance travelled up to this point. |
| 371 | <tr> |
| 372 | <td>Total Duration |
| 373 | <td>The total duration of travel up to this point. |
| 374 | <tr> |
| 375 | <td>Speed |
| 376 | <td>The speed of travel on the segment defined on this line (missing on the |
| 377 | first line). |
| 378 | <tr> |
| 379 | <td>Bearing |
| 380 | <td>The direction that the segment defined on this line travels in degrees |
| 381 | (missing on the first line). |
| 382 | <tr> |
| 383 | <td>Highway |
| 384 | <td>The name (or description) of the highway segment (missing on the first |
| 385 | line). |
| 386 | </table> |
| 387 | |
| 388 | |
| 389 | </div> |
| 390 | |
| 391 | <!-- Content End --> |
| 392 | |
| 393 | <!-- Footer Start --> |
| 394 | |
| 395 | <div class="footer" align="center"> |
| 396 | <hr> |
| 397 | |
| 398 | <address> |
| 399 | © Andrew M. Bishop = <amb "at" gedanken.demon.co.uk> |
| 400 | </address> |
| 401 | |
| 402 | </div> |
| 403 | |
| 404 | <!-- Footer End --> |
| 405 | |
| 406 | </BODY> |
| 407 | |
| 408 | </HTML> |