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.

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