Check out the latest version of Routino: svn co http://routino.org/svn/trunk routino
Contents of /trunk/doc/html/readme.html
Parent Directory
|
Revision Log
Revision 1056 -
(show annotations)
(download)
(as text)
Sun Aug 12 13:32:00 2012 UTC (12 years, 7 months ago) by amb
File MIME type: text/html
File size: 10697 byte(s)
Sun Aug 12 13:32:00 2012 UTC (12 years, 7 months ago) by amb
File MIME type: text/html
File size: 10697 byte(s)
Merge the 2.3.1 branch extra changes back into trunk.
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 - readme |
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 : Software</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 : Software</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" title="Introduction"></a>Routino Introduction</h2> |
49 | |
50 | Routino is an application for finding a route between two points using the |
51 | dataset of topographical information collected by |
52 | <a class="ext" title="OpenStreetMap" href="http://www.openstreetmap.org/">http://www.OpenStreetMap.org</a>. |
53 | |
54 | <p> |
55 | |
56 | Starting from the raw OpenStreetMap data (in the form of the '.osm' XML files |
57 | available on the internet) a custom database is generated that contains the |
58 | information useful for routing. With this database and two points specified by |
59 | latitude and longitude an optimum route (either shortest or quickest) is |
60 | determined. The route is calculated for OpenStreetMap highways (roads, paths |
61 | etc) using one of the common forms of transport defined in OpenStreetMap (foot, |
62 | bicycle, horse, motorcar, motorbike etc). |
63 | |
64 | <p> |
65 | |
66 | When processing the OpenStreetMap data the types of highways are recorded and |
67 | these set default limits on the types of traffic allowed. More specific |
68 | information about permissions for different types of transport are also recorded |
69 | as are maximum speed limits. Further restrictions like one-way streets, weight, |
70 | height, width and length limits are also included where specified. Additionally |
71 | a set of properties of each highway are also recorded. The processing of the |
72 | input file is controlled by a configuration file which determines the |
73 | information that is used. |
74 | |
75 | <p> |
76 | |
77 | When calculating a route the type of transport to be used is taken into account |
78 | to ensure that the known restrictions are followed. Each of the different |
79 | highway types can further be allowed or disallowed depending on preferences. |
80 | For each type of highway a default speed limit is defined (although the actual |
81 | speed used will be the lowest of the default and any specified in the original |
82 | data). To make use of the information about restrictions the weight, height, |
83 | width and length of the transport can also be specified. Further preferences |
84 | about road properties (e.g. paved or not) can also be selected. The simplest |
85 | type of turn restrictions (those formed from an initial way, a node and a second |
86 | way) are also obeyed. |
87 | |
88 | <p> |
89 | |
90 | The result of calculating the route can be presented in several different ways. |
91 | An HTML file can be produced that contains a description of the route to take |
92 | with instructions for each of the important junctions. The contents of the file |
93 | are created based on a set of translations specified in a configuration file. |
94 | The route is also available in a |
95 | <a class="ext" title="GPX format" href="http://www.topografix.com/gpx.asp">GPX (GPS eXchange) XML format</a>. |
96 | format file containing either every point and highway segment (a track file) or |
97 | just a waypoint and translated instructions for the important junctions (a route |
98 | file). |
99 | Additionally there are two plain text files that contain all data points or just |
100 | the important ones (intended for debugging and further processing). |
101 | |
102 | <p> |
103 | |
104 | One of the design aims of Routino was to make the software are flexible as |
105 | possible in selecting routing preferences but also have a sensible set of |
106 | default values. Another design aim was that finding the optimum route should be |
107 | very fast and most of the speed increases come from the carefully chosen and |
108 | optimised data format. |
109 | |
110 | |
111 | <h2><a name="H_1_2"></a>Disclaimer</h2> |
112 | |
113 | The route that is calculated by this software is only as good as the input data. |
114 | |
115 | <p> |
116 | |
117 | Routino comes with ABSOLUTELY NO WARRANTY for the software itself or the route |
118 | that is calculated by it. |
119 | |
120 | |
121 | <h2><a name="H_1_3"></a>Demonstration</h2> |
122 | |
123 | A live demonstration of the router for the UK is available on the internet: |
124 | <br> |
125 | <a title="Routino demo" href="http://www.routino.org/uk/">http://www.routino.org/uk/</a> |
126 | |
127 | <p> |
128 | |
129 | The source code download available below also includes a set of files that can |
130 | be used to create your own interactive map. |
131 | |
132 | <p> |
133 | |
134 | The interactive map is made possible by use of the OpenLayers Javascript |
135 | library from <a class="ext" href="http://www.openlayers.org" title="OpenLayers">http://www.openlayers.org/</a>. |
136 | |
137 | |
138 | <h2><a name="H_1_4"></a>Documentation</h2> |
139 | |
140 | A full set of |
141 | <a href="index.html" title="Documentation">documentation</a> |
142 | is available that describes how to install and use the programs as well as |
143 | what should go in the configuration files and how it works. |
144 | |
145 | |
146 | <h2><a name="H_1_5"></a>Status</h2> |
147 | |
148 | Version 1.0 of Routino was released on 8th April 2009. |
149 | <br> |
150 | Version 1.1 of Routino was released on 13th June 2009. |
151 | <br> |
152 | Version 1.2 of Routino was released on 21st October 2009. |
153 | <br> |
154 | Version 1.3 of Routino was released on 21st January 2010. |
155 | <br> |
156 | Version 1.4 of Routino was released on 31st May 2010. |
157 | <br> |
158 | Version 1.4.1 of Routino was released on 10th July 2010. |
159 | <br> |
160 | Version 1.5 of Routino was released on 30th October 2010. |
161 | <br> |
162 | Version 1.5.1 of Routino was released on 13th November 2010. |
163 | <br> |
164 | Version 2.0 of Routino was released on 30th May 2011. |
165 | <br> |
166 | Version 2.0.1 of Routino was released on 7th June 2011. |
167 | <br> |
168 | Version 2.0.2 of Routino was released on 26th June 2011. |
169 | <br> |
170 | Version 2.0.3 of Routino was released on 4th August 2011. |
171 | <br> |
172 | Version 2.1 of Routino was released on 3rd October 2011. |
173 | <br> |
174 | Version 2.1.1 of Routino was released on 23rd October 2011. |
175 | <br> |
176 | Version 2.1.2 of Routino was released on 12th November 2011. |
177 | <br> |
178 | Version 2.2 of Routino was released on 3rd March 2012. |
179 | <br> |
180 | Version 2.3 of Routino was released on 21st July 2012. |
181 | <br> |
182 | Version 2.3.1 of Routino was released on 11th August 2012. |
183 | |
184 | <p> |
185 | |
186 | The full version history is available in the NEWS file. |
187 | |
188 | |
189 | <h3><a name="H_1_5_1" title="Changes"></a>Changes in Versions 2.3 and 2.3.1</h3> |
190 | |
191 | In version 2.3.1: |
192 | |
193 | <dl> |
194 | <dt>Bug fixes: |
195 | <dd>Create marker-XXX-grey.png icon which gets used before Javascript removes it. |
196 | <br>Provide full set of 99 marker icons instead of just 19. |
197 | <br>Add more limit icons (0.0-0.9, 20.0-40.0 and 161-200). |
198 | <br>Fix router web page problem with placing initial marker (coords not updated). |
199 | <br>Hide waypoints so that they are not visible when Javascript adds them to HTML. |
200 | <br>Fix web page font problems by choosing an explicit font pixel-size in the CSS. |
201 | <br>Fix potential crash in XML files containing lots of key/value pairs in a tag. |
202 | |
203 | <dt>Web pages (router): |
204 | <dd>Unused waypoints show as blank rather than 0,0. |
205 | <br>Add a button to insert a waypoint to close the loop. |
206 | <br>Write the command line and execution time to the log file. |
207 | </dl> |
208 | |
209 | In version 2.3: |
210 | |
211 | <dl> |
212 | <dt>Bug fixes: |
213 | <dd>Handle OSM files that contain changesets (don't raise an error). |
214 | <br>Force bicyle/foot routes to allow bicycle/foot transport. |
215 | <br>Fix problem running CGIs on Macs (md5 program name). |
216 | <br>Fix bug with pruning straight highways (uninitialised data). |
217 | <br>Fix bug with XML parsing error log (could miss some unrecognised tags). |
218 | |
219 | <dt>Web pages (all): |
220 | <dd>Make compatible with OpenLayers v2.12 (but don't change the install script). |
221 | <br>Make all HTML files standards compliant. |
222 | <br>Allow the HTML files to parse the query string instead of using a CGI. |
223 | <br>Move all user-editable parameters to paths.pl and mapprops.js. |
224 | |
225 | <dt>Web pages (router): |
226 | <dd>Add a button to put a marker at the current location (Javascript geolocation). |
227 | <br>Add a button to centre the map on a given marker. |
228 | <br>Automatically insert the waypoints in the HTML from the JavaScript. |
229 | <br>Added a German language router web page translation. |
230 | <br>Add buttons to switch between lat/long and placename with Nominatim lookups. |
231 | |
232 | <dt>Web pages (visualiser): |
233 | <dd>Allow plotting segments of each highway type. |
234 | <br>Allow plotting segments accessible to each transport type. |
235 | |
236 | <dt>planetsplitter: |
237 | <dd>Add a new '--logtime' option that prints the elapsed time of each step. |
238 | <br>Make the sort functions multi-threaded (run-time option). |
239 | <br>Improve the XML parsing speed slightly. |
240 | </dl> |
241 | |
242 | <p> |
243 | <b>Note:</b> Existing mapprops.js and paths.pl files need to be updated to |
244 | include new items for this version. |
245 | |
246 | <p> |
247 | <b>Note:</b> Existing OpenLayers installations must be updated if they were |
248 | installed with older Routino provided script (the old OpenLayers.js will not |
249 | work). |
250 | |
251 | <p> |
252 | <b>Note:</b> The CGI scripts customrouter.cgi and customvisualiser.cgi are |
253 | deprecated and will be removed in the next version. |
254 | |
255 | <p> |
256 | <b>Note:</b> The noscript.cgi and noscript.html web pages are deprecated and |
257 | will be removed in the next version. |
258 | |
259 | |
260 | <h3><a name="H_1_5_2"></a>License</h3> |
261 | |
262 | This program is free software: you can redistribute it and/or modify it under |
263 | the terms of the |
264 | <a class="ext" title="Affero GPLv3" href="http://www.fsf.org/licensing/licenses/agpl-3.0.html">GNU Affero General Public License</a> |
265 | as published by the Free Software Foundation; either version 3 of the License, |
266 | or (at your option) any later version. |
267 | |
268 | <p> |
269 | |
270 | It is important to note that for this program I have decided to use the |
271 | <em>Affero GPLv3</em> instead of just using the GPL. This license adds |
272 | additional requirements to anybody who provides a networked service using this |
273 | software. |
274 | |
275 | |
276 | <h3><a name="H_1_5_3"></a>Copyright</h3> |
277 | |
278 | Routino is copyright Andrew M. Bishop 2008-2012. |
279 | |
280 | |
281 | <h2><a name="H_1_6"></a>Download</h2> |
282 | |
283 | The <a title="Download directory" href="http://www.routino.org/download/">download directory</a> |
284 | contains the latest version of the source code. |
285 | |
286 | |
287 | </div> |
288 | |
289 | <!-- Content End --> |
290 | |
291 | <!-- Footer Start --> |
292 | |
293 | <div class="footer" align="center"> |
294 | <hr> |
295 | |
296 | <address> |
297 | © Andrew M. Bishop = <amb "at" gedanken.demon.co.uk> |
298 | </address> |
299 | |
300 | </div> |
301 | |
302 | <!-- Footer End --> |
303 | |
304 | </BODY> |
305 | |
306 | </HTML> |