trunk/doc/OUTPUT.txt

                              Routino : Output
                              ================


   There are three different formats of output from the router, HTML, GPX
   (GPS eXchange) XML format and plain text with a total of five possible
   output files:
     * HTML route instructions for each interesting junction.
     * GPX track file containing every node.
     * GPX route file with waypoints at interesting junctions.
     * Plain text description with the interesting junctions.
     * Plain text file with every node.

   The "interesting junctions" referred to above are junctions where the
   route changes to a different type of highway, more than two highways of
   the same type meet, or where the route meets but does not take a more
   major highway. When the route follows a major road this definition
   eliminates all junctions with minor roads.

   The output files are written to the current directory and are named
   depending on the selection of shortest or quickest route. For the
   shortest route the file names are "shortest.html",
   "shortest-track.gpx", "shortest-route.gpx", "shortest.txt" and
   "shortest-all.txt", for the quickest route the names are
   "quickest.html", "quickest-track.gpx", "quickest-route.gpx",
   "quickest.txt" and "quickest-all.txt".

   The HTML file and GPX files are written out according to the selected
   language using the translations contained in the translations.xml
   configuration file. The text files contain only the copyright section
   translated with the rest in English.


HTML Route Instructions
-----------------------

   The HTML route instructions file contains one line for each of the
   interesting junctions in the route and one line for the highway that
   connects them.

   An example HTML file output is below (some parts are missing, for
   example the style definitions):

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML>
<!-- Creator : Routino - http://www.routino.org/ -->
<!-- Source : Based on OpenStreetMap data from http://www.openstreetmap.org/ -->
<!-- License : http://creativecommons.org/licenses/by-sa/2.0/ -->
<HEAD>
<TITLE>Shortest Route</TITLE>
...
</HEAD>
<BODY>
<H1>Shortest Route</H1>
<table>
<tr class='c'><td class='l'><td class='r'>51.524677 -0.127896
<tr class='n'><td class='l'>Start:<td class='r'>At <span class='w'>Waypoint</span>, head <span class='b'>South-East</span>

<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>]
...
<tr class='t'><td class='l'>Total:<td class='r'><span class='j'>6.3 km, 5 minutes</span>
<tr><td class='l'>Stop:<td class='r'><span class='w'>Waypoint</span>
</table>
</BODY>
</HTML>

   The coordinates are included in the file but are not visible because of
   the style definitions.


GPX Track File
--------------

   The GPX track file contains a track with all of the individual nodes
   that the route passes through.

   An example GPX track file output is below:

<?xml version="1.0" encoding="UTF-8"?>
<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">
<metadata>
<desc>Creator : Routino - http://www.routino.org/</desc>
<copyright author="Based on OpenStreetMap data from http://www.openstreetmap.org/">
<license>http://creativecommons.org/licenses/by-sa/2.0/</license>
</copyright>
</metadata>
<trk>
<name>Shortest route</name>
<desc>Shortest route between 'start' and 'finish' waypoints</desc>
<trkpt lat="51.524677" lon="-0.127896"/>
<trkpt lat="51.523830" lon="-0.126993"/>
...
<trkpt lat="51.478353" lon="-0.103561"/>
<trkpt lat="51.478244" lon="-0.103652"/>
</trkseg>
</trk>
</gpx>


GPX Route File
--------------

   The GPX route file contains a route (ordered set of waypoints) with all
   of the interesting junctions that the route passes through.

   An example GPX route file output is below:

<?xml version="1.0" encoding="UTF-8"?>
<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">
<metadata>
<desc>Creator : Routino - http://www.routino.org/</desc>
<copyright author="Based on OpenStreetMap data from http://www.openstreetmap.org/">
<license>http://creativecommons.org/licenses/by-sa/2.0/</license>
</copyright>
</metadata>
<rte>
<name>Shortest route</name>
<desc>Shortest route between 'start' and 'finish' waypoints</desc>
<rtept lat="51.524677" lon="-0.127896"><name>START</name>
<desc>South-East on 'Russell Square' for 0.391 km, 0.5 min</desc></rtept>
<rtept lat="51.521815" lon="-0.124577"><name>TRIP001</name>
<desc>South-East on 'Russell Square' for 0.055 km, 0.1 min</desc></rtept>
...
<rtept lat="51.478244" lon="-0.103652"><name>FINISH</name>
<desc>Total Journey 6.3 km, 5 minutes</desc></rtept>
</rte>
</gpx>


Text File
---------

   The text file format contains one entry for all of the interesting
   junctions in the route and is intended to be easy to interpret.

   An example text file output is below:

# Creator : Routino - http://www.routino.org/
# Source : Based on OpenStreetMap data from http://www.openstreetmap.org/
# License : http://creativecommons.org/licenses/by-sa/2.0/
#
#Latitude       Longitude       Section         Section         Total     Total           Point   Turn    Bearing Highway
#                               Distance        Duration        Distance  Duration        Type
 51.524677        -0.127896      0.000 km        0.0 min          0.0 km   0 min        Waypt            +3
 51.521815        -0.124577      0.391 km        0.5 min          0.4 km   0 min        Junct    +0      +3     Russell Square
...
 51.478353        -0.103561      0.598 km        0.4 min          6.2 km   5 min        Junct    +2      -3     Camberwell New Road (A202)
 51.478244        -0.103652      0.013 km        0.0 min          6.3 km   5 min        Waypt                   Vassall Road

   The text file output contains a header (indicated by the lines starting
   with '#') and then one line for each junction. Each line contains the
   information for the route up to that point and the direction to go
   next. For each of the lines the individual fields contain the
   following:

   Latitude - Location of the point (degrees)

   Longitude - Location of the point (degrees)

   Section Distance - The distance travelled on the section of the journey
   that ends at this point (defined on this line).

   Section Duration - The duration of travel on the section of the journey
   that ends at this point (defined on this line).

   Total Distance - The total distance travelled up to this point.

   Total Duration - The total duration of travel up to this point.

   Point Type - The type of point; either a waypoint Waypt or junction
   Junct.

   Turn - The direction to turn at this point (missing for the first point
   since the journey has not started yet and the last point because it has
   finished). This can take one of nine values between -4 and +4 defined
   by: 0 = Straight, +2 = Right, -2 = Left and +/-4 = Reverse.

   Bearing - The direction to head at this point (missing for the last point
   since the journey has finished). This can take one of nine values
   between -4 and +4 defined by: 0 = North, +2 = East, -2 = West and +/-4
   = South.

   Highway - The name (or description) of the highway to follow (missing on
   the first line).

   The individual items are separated by tabs but some of the items
   contain spaces as well.


All Nodes Text File
-------------------

   The all nodes text file format contains one entry for each of the nodes
   on the route.

   An example all nodes text file output is below:

# Creator : Routino - http://www.routino.org/
# Source : Based on OpenStreetMap data from http://www.openstreetmap.org/
# License : http://creativecommons.org/licenses/by-sa/2.0/
#
#Latitude       Longitude           Node        Type    Segment Segment Total  Total   Speed   Bearing Highway
#                                                       Dist    Durat'n Dist   Durat'n
 51.524677        -0.127896      7485978*       Waypt   0.000    0.00    0.00  0.0
 51.523830        -0.126993      7485047*       Junct   0.113    0.14    0.11  0.1    96      146    Woburn Place
...
 51.478353        -0.103561      7576939*       Junct   0.104    0.07    6.25  5.0    96      126    Camberwell New Road (A202)
 51.478244        -0.103652      7581605        Waypt   0.013    0.01    6.26  5.0    64      207    Vassall Road

   The all nodes text file output is similar to the text file output
   except that a line is printed for each of the nodes rather than just
   the interesting junctions. For each of the lines the individual fields
   contain the following:

   Latitude - Location of the point in degrees.

   Longitude - Location of the point in degrees.

   Node - The internal node number and an indicator "*" if the node is a
   super-node.

   Type - The type of point; a waypoint Waypt, junction Junct, change of
   highway Change or intermediate node Inter.

   Segment Distance - The distance travelled on the segment defined on this
   line.

   Segment Duration - The duration of travel on the segment defined on this
   line.

   Total Distance - The total distance travelled up to this point.

   Total Duration - The total duration of travel up to this point.

   Speed - The speed of travel on the segment defined on this line (missing
   on the first line).

   Bearing - The direction that the segment defined on this line travels in
   degrees (missing on the first line).

   Highway - The name (or description) of the highway segment (missing on
   the first line).


--------

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