diff options
author | jkoan <jkoan@gmx.de> | 2019-10-24 19:07:29 +0200 |
---|---|---|
committer | jkoan <jkoan@users.noreply.github.com> | 2019-10-28 11:45:46 +0100 |
commit | 0b0a073e5f4197120dccf2a8097f4f10388fafd0 (patch) | |
tree | 09b82d73efa75915f28f2aebc049d4492417701a /docs | |
parent | b99187ee4d8336b4c237d1be805110d41d22a14d (diff) | |
download | navit-0b0a073e5f4197120dccf2a8097f4f10388fafd0.tar.gz |
fix:doc:First set of style-fixes for reStructuredText/Read the Docs
Diffstat (limited to 'docs')
-rw-r--r-- | docs/basic_configuration.rst | 16 | ||||
-rw-r--r-- | docs/configuration/advanced.rst | 3 | ||||
-rw-r--r-- | docs/configuration/display.rst | 19 | ||||
-rw-r--r-- | docs/configuration/general.rst | 27 | ||||
-rw-r--r-- | docs/configuration/index.rst | 152 | ||||
-rw-r--r-- | docs/configuration/layout.rst | 40 | ||||
-rw-r--r-- | docs/configuration/vehicle.rst | 41 | ||||
-rw-r--r-- | docs/development/android_development.rst | 16 | ||||
-rw-r--r-- | docs/development/linux_development.rst | 31 | ||||
-rw-r--r-- | docs/development/programming_guidelines.rst | 2 | ||||
-rw-r--r-- | docs/development/wince_development.rst | 22 | ||||
-rw-r--r-- | docs/development/windows_development.rst | 24 | ||||
-rw-r--r-- | docs/index.rst | 4 | ||||
-rw-r--r-- | docs/maps.rst | 1 | ||||
-rw-r--r-- | docs/navit.png | bin | 367957 -> 367917 bytes | |||
-rw-r--r-- | docs/osm.rst | 42 |
16 files changed, 202 insertions, 238 deletions
diff --git a/docs/basic_configuration.rst b/docs/basic_configuration.rst index 250a6686f..5fa20f6e3 100644 --- a/docs/basic_configuration.rst +++ b/docs/basic_configuration.rst @@ -1,10 +1,11 @@ There are much more options, see [[configuration]]. +*********** Preparation -=========== +*********** Get a supported map package --------------------------- -Navit can use different :doc:`maps` formats, including free :ref:`OpenStreetMap` data. In order to use one of these maps, download a map of your desired area and store it into a local folder (such as navit/maps or /usr/share/navit/maps). +Navit can use different :doc:`maps` formats, including free `OpenStreetMap` data. In order to use one of these maps, download a map of your desired area and store it into a local folder (such as navit/maps or /usr/share/navit/maps). Install TTS ----------- @@ -28,8 +29,9 @@ Most GPS receiver will output the position in [[NMEA]] format, which can be used The output should give you steady NMEA position updates. You can feed this information into **gpsd** / **xgps** or **QLandkarte** to see a graphical representation of your position and to check whether the output corresponds to your current position. -Configuring -=========== +*************** +Getting started +*************** Currently Navit doesn't provide a graphical tool to change settings, so you have to do the changes manually using a texteditor. Please open your current **navit.xml** file and do the following steps: @@ -43,7 +45,7 @@ On Navit's very first startup, it needs a **center** to look at on the map. By d <navit center="4808 N 1134 E" /> -See furthermore: [[Configuration]] +See furthermore: :doc:`configuration/index` Setup GPS @@ -52,9 +54,9 @@ Add the GPS connection .. code-block:: xml - <vehicle name="My" enabled="yes" source="file://dev/ttyS0"/ active="1"/> + <vehicle name="My" enabled="yes" source="file://dev/ttyS0" active="1"/> -See furthermore: [[Configuration]] +See furthermore: :doc:`configuration/index` Enable Map diff --git a/docs/configuration/advanced.rst b/docs/configuration/advanced.rst index 68066af03..8c97dce16 100644 --- a/docs/configuration/advanced.rst +++ b/docs/configuration/advanced.rst @@ -1,5 +1,6 @@ Advanced Options ================ + The rest of this webpage is meant for advanced/power users who'd like to fiddle a little more under-the-hood. The average user can safely ignore this section! Speech @@ -32,7 +33,7 @@ espeak ~~~~~~ .. code-block:: xml - <speech type="cmdline" data="espeak -s 150 -v english_rp %s"/> + <speech type="cmdline" data="espeak -s 150 -v english_rp %s"/> Will use espeak instead, for those who want Navit to speak to them in English, at 150 words per minute. The ''%s'' is filled in by Navit when sent to the speech synthesis software (with something like "Turn left" or whatever is appropriate at the time). If you need more features, you should use an external wrapper script which can contain anything supported by your shell (see [[Translations]]). diff --git a/docs/configuration/display.rst b/docs/configuration/display.rst index f822d053b..9202ae6f6 100644 --- a/docs/configuration/display.rst +++ b/docs/configuration/display.rst @@ -1,5 +1,5 @@ Display Options ---------------- +=============== The Navit display is highly customisable and consists of the following components * Graphics driver (appropriate engine for your system, to draw everything) @@ -31,9 +31,10 @@ They can be activated and configured as following: .. code-block:: xml - <graphics type="gtk_drawing_area"/> + <graphics type="gtk_drawing_area" /> + -As mentioned, it's usually best to leave this as whatever the default is within your :xml:`navit.xml`, and only mess around with it if you know what you are doing, or have been told to by one of the developers. +As mentioned, it's usually best to leave this as whatever the default is within your `navit.xml`, and only mess around with it if you know what you are doing, or have been told to by one of the developers. Graphical User Interface ------------------------ @@ -56,11 +57,11 @@ There are some options available for the ``gui`` tag which are used by all the G * **pitch** - The pitch value to pitch the map to when selecting 3D mode from the menus. * **dimensions** - w="1024" h="600" -The following example uses the :xml:`internal` GUI, and starts Navit up in fullscreen mode, and will pitch the map to 35 degrees when 3D mode is selected from the menu. Note that to start Navit in 3D mode by default, [[#Initial 3D pitch|change the :xml:`pitch` value in the :xml:`navit` tag]]: +The following example uses the `internal` GUI, and starts Navit up in fullscreen mode, and will pitch the map to 35 degrees when 3D mode is selected from the menu. Note that to start Navit in 3D mode by default, [[#Initial 3D pitch|change the `pitch` value in the `navit` tag]]: .. code-block:: xml - <gui type="internal" enabled="yes" fullscreen="1" pitch="35"> + <gui type="internal" enabled="yes" fullscreen="1" pitch="35"> Internal GUI ~~~~~~~~~~~~ @@ -68,7 +69,7 @@ The first GUI is embedded in Navit core and is primarily aimed at [[touchscreen] .. code-block:: xml - <gui type="internal" enabled="yes"> + <gui type="internal" enabled="yes"> Options ^^^^^^^ @@ -84,7 +85,7 @@ An example ``gui`` tag using the previous options is shown below: .. code-block:: xml - <gui type="internal" enabled="yes" font_size="250" icon_xs="48" icon_s="48" icon_l="64"> + <gui type="internal" enabled="yes" font_size="250" icon_xs="48" icon_s="48" icon_l="64"> More options are discussed on the [[Internal Gui]] and the [[Configuration/Full_list_of_options|full list of options]]. @@ -94,7 +95,7 @@ The second GUI is called **gtk**, and is most useful for those users who wish to .. code-block:: xml - <gui type="gtk" enabled="yes" ... /> + <gui type="gtk" enabled="yes" /> Options @@ -108,4 +109,4 @@ A number of options specific to the ``gtk`` GUI are available. These include: .. code-block:: xml - <gui type="gtk" enabled="yes" menubar="1" toolbar="1" statusbar="1"/> + <gui type="gtk" enabled="yes" menubar="1" toolbar="1" statusbar="1"/> diff --git a/docs/configuration/general.rst b/docs/configuration/general.rst index 2ad2874d7..34b201d61 100644 --- a/docs/configuration/general.rst +++ b/docs/configuration/general.rst @@ -1,23 +1,22 @@ -==General Options== +General Options +=============== Settings which affect Navit's general behaviour are located within the ``<navit .. >`` tag. In a default installation, this is found on line 31 of ``navit.xml``. By default, the ``navit`` tag is set as follows: .. code-block:: xml -<source lang="xml"> - <navit center="4808 N 1134 E" zoom="256" tracking="1" orientation="-1" recent_dest="10"> -</source> + <navit center="4808 N 1134 E" zoom="256" tracking="1" orientation="-1" recent_dest="10"> + Some common attributes are discussed below. For more advanced features, see [[Configuration/Full_list_of_options | the full list of options]]. -===Initial map position=== +Initial map position +-------------------- On Navit's very first startup, it needs a **center** to look at on the map. By default this is set to Munich in Germany, which is conveniently covered by the sample map created on installation. .. code-block:: xml -<source lang="xml"> - center="11.5666 48.1333" -</source> + center="11.5666 48.1333" Coordinates can be written in different formats; see [[Coordinate_format]] for the full list. To determine a specific latitude and longitude for your location you can use http://itouchmap.com/latlong.html. @@ -45,7 +44,8 @@ or to orient North: Orienting the map North whilst in [[3D]] mode will provide visually confusing results, and is not recommended. When in 3D mode, it's best to have the map oriented in the direction of travel. -===Autozoom=== +Autozoom +-------- Navit has the ability to **autozoom** the map in or out dependent upon your speed. autozoom_active="1" @@ -54,7 +54,8 @@ To de-activate autozoom: autozoom_active="0" -===3D pitch=== +3D pitch +-------- Navit has the capability to display either a 2D map (bird's eye perspective) or a [[3D]] map (some amount of tilt looking to the horizon). Navit's default configuration is to startup in the 2D perspective but it is possible to specify that Navit start with a 3D perspective. The amount of tilt is specified by setting the value of <tt>pitch</tt>. The **pitch** value defines default camera tilting, with a value from 0 to 359. Note that usable values lie between 0 and 90 where 0 is bird's eye perspective looking down and 90 is human perspective looking forward. Also note that values closer to 90 will slow down map drawing, because the line of sight gets longer and longer and more objects are seen. @@ -63,14 +64,16 @@ For example, the following added to the <tt>navit</tt> tag will force Navit to s pitch="30" -===Imperial units=== +Imperial units +-------------- By default, Navit use the metric system of measurements when displaying or announcing distances, speeds etc. However, you can configure Navit to display and announce these values in imperial units. Simply add an <tt>imperial</tt> attribute to the Navit tag, and set its value to 1, as shown below: imperial="1" Speeds should now be displayed in units of miles-per-hour, whilst distances are converted to miles (large distances) and feet (small distances). -===Default layout=== +Default layout +-------------- When no specific layout has been specified by the user, navit uses a default layout to draw maps. The <tt>default_layout</tt> attribute of the navit tag allows to specify which layout to use as default; diff --git a/docs/configuration/index.rst b/docs/configuration/index.rst index 38504d067..93a4e8b52 100644 --- a/docs/configuration/index.rst +++ b/docs/configuration/index.rst @@ -1,3 +1,9 @@ +.. _configuration: + +************* +Configuration +************* + Navit is highly modular and customizable. This page aims to point out the most common options which a first-time user may want to change - power users may want to consult [[Configuration/Full_list_of_options | the full list of options]]. It is also possible to edit the navit.xml file for your Android device under Windows and Linux (Debian/Ubuntu derivates) with a third party application called [[NavitConfigurator]]. @@ -7,137 +13,79 @@ The XML configuration file is splitted into sections within a hierarchy: .. code-block:: xml -<source lang="xml"> -<config> - <plugins></plugins> - <navit> - <osd></osd> - <vehicle></vehicle> - <vehicleprofile></vehicleprofile> - <mapset></mapset> - <layout></layout> - </navit> -</config> -</source> - -Navit comes **preshipped** with a default ``navit.xml`` together with ``navit_layout_*.xml`` files that are stored at various locations (depending on your system). For Linux-like OSes: -* in ``~/.navit/``: e.g: ``/home/myusername/.navit/navit.xml`` (This is probably to best place to customize your settings!) -* in ``/usr/share/navit`` or ``/etc/navit`` - -Navit will apply settings in the following order: -* in the current directory (used on Windows) -* location supplied as first argument on the command line, e.g.: ``navit /home/myusername/navittestconfig.xml`` (Used mainly for development) -* in the current directory as ``navit.xml.local`` (Used mainly for development) - -{{note -|In any case, you have to **adapt settings** to your system!<br> This includes especially GPS, map provider and vehicle: [[Basic configuration]] -}} + <config> + <plugins></plugins> + <navit> + <osd></osd> + <vehicle></vehicle> + <vehicleprofile></vehicleprofile> + <mapset></mapset> + <layout></layout> + </navit> + </config> -=Configurable Sections= -<div style="margin-bottom:8px;"> -{| cellpadding=3 cellspacing=1 +Navit comes **preshipped** with a default ``navit.xml`` together with ``navit_layout_*.xml`` files that are stored at various locations (depending on your system). -<!-- GENERAL --> -| width="33%" valign="top" style="background:#FFFFFF; border:2px solid #478cff;" | -{| style="width:100%; vertical-align:top; background:#FFFFFF;" -! style="padding:2px" | <h2 style="margin:3px; background:#478cff; font-size:120%; font-weight:bold; border:1px solid #478cff; text-align:left; color:#fff; padding:0.2em 0.4em;">General</h2> -|- -| style="margin:2px; padding:10px;" | +For Linux-like OSes: + * in ``~/.navit/``: e.g: ``/home/myusername/.navit/navit.xml`` (This is probably to best place to customize your settings!) + * in ``/usr/share/navit`` or ``/etc/navit`` -Common options such as units, position, zoom and map orientation, ... be configured in this section. +Navit will apply settings in the following order: + * in the current directory (used on Windows) + * location supplied as first argument on the command line, e.g.: ``navit /home/myusername/navittestconfig.xml`` (Used mainly for development) + * in the current directory as ``navit.xml.local`` (Used mainly for development) -[[Configuration/General_Options| General options.]] +{{note|In any case, you have to **adapt settings** to your system!<br> This includes especially GPS, map provider and vehicle: [[Basic configuration]]}} -|} +********************* +Configurable Sections +********************* -| style="border:1px solid transparent;" | +General +''''''' +Common options such as units, position, zoom and map orientation, ... be configured in this section. -| width="33%" valign="top" style="background:#FFFFFF; border:2px solid #48be1f; margin-top:50px;" | -<!-- DISPLAY --> -{| style="width:100%; vertical-align:top; background:#FFFFFF;" -|- -! style="padding:2px" | <h2 style="margin:3px; background:#48be1f; font-size:120%; font-weight:bold; border:1px solid #48be1f; text-align:left; color:#fff; padding:0.2em 0.4em;">Display</h2> -|- -| style="margin:2px; padding:10px;" | +.. include:: general.rst +Display +''''''' A large number of display properties can be configured, including desktop or touchscreen-optimised GUIs, on-screen display items and complete control over menu items. -[[Configuration/Display_Options| Display options.]] - -|} - -| style="border:1px solid transparent;" | - - -<!-- VEHICLE --> -| width="33%" valign="top" style="background:#FFFFFF; border:2px solid #e79e00;" | -{| style="width:100%; vertical-align:top; background:#FFFFFF;" -! style="padding:2px" | <h2 style="margin:3px; background:#e79e00; font-size:120%; font-weight:bold; border:0px solid #e79e00; text-align:left; color:#fff; padding:0.2em 0.4em;">Vehicle</h2> -|- -| style="margin:2px; padding:10px;" | +.. include:: display.rst +Vehicle +''''''' A number of vehicles can be defined within Navit, depending upon the device and/or operating system in use. Vehicle profiles for routing (eg: car, pedestrian, bicycle...) are also completely configurable. -[[Configuration/Vehicle_Options| Vehicle options.]] - -|} -|} -</div> - -<div style="margin-bottom:8px;"> -{| cellpadding=3 cellspacing=1 - -<!-- MAPS --> -| width="33%" valign="top" style="background:#FFFFFF; border:2px solid #ec7312;" | -{| style="width:100%; vertical-align:top; background:#FFFFFF;" -! style="padding:2px" | <h2 style="margin:3px; background:#ec7312; font-size:120%; font-weight:bold; border:1px solid #ec7312; text-align:left; color:#fff; padding:0.2em 0.4em;">Maps</h2> -|- -| style="margin:2px; padding:10px;" | +.. include:: vehicle.rst +Maps +'''' You can use maps from a variety of sources, any number of maps can be configured and enabled at any one time. -[[Configuration/Maps_Options| Maps options.]] -|} +Layout +'''''' +Maps are displayed according to the rules defined in the layout. All aspects of the layout are configurable, from POI icons to colours for a particular type of highway. + +For all versions shipped after nov 2018, layout XML configuration is stored in dedicated XML files called with the prefix ´´navit_layout_´´ (one file per layout definition). -| style="border:1px solid transparent;" | +.. include:: layout.rst -<!-- LAYOUT --> -| width="33%" valign="top" style="background:#FFFFFF; border:2px solid #b30800;" | -{| style="width:100%; vertical-align:top; background:#FFFFFF;" -! style="padding:2px" | <h2 style="margin:3px; background:#b30800; font-size:120%; font-weight:bold; border:1px solid #b30800; text-align:left; color:#fff; padding:0.2em 0.4em;">Layout</h2> -|- -| style="margin:2px; padding:10px;" | +Advanced +'''''''' +There are many more options, including debugging, specific plugins, speech announcements, trip logging, ... -Maps are displayed according to the rules defined in the layout. All aspects of the layout are configurable, from POI icons to colours for a particular type of highway. +.. include:: advanced.rst -For all versions shipped after nov 2018, layout XML configuration is stored in dedicated XML files called with the prefix **navit_layout_** (one file per layout definition). -[[Configuration/Layout_Options| Layout options.]] -|} -| style="border:1px solid transparent;" | -<!-- ADVANCED --> -| width="33%" valign="top" style="background:#FFFFFF; border:2px solid #992667;" | -{| style="width:100%; vertical-align:top; background:#FFFFFF;" -! style="padding:2px" | <h2 style="margin:3px; background:#992667; font-size:120%; font-weight:bold; border:1px solid #992667; text-align:left; color:#fff; padding:0.2em 0.4em;">Advanced</h2> -|- -| style="margin:2px; padding:10px;" | -There are many more options, including debugging, specific plugins, speech announcements, trip logging, ... -[[Configuration/Advanced_Options| Advanced options.]] -|} -|} -</div> -<!-- Following line disables table of contents --> -__NOTOC__ -[[Category:Customizing]] -[[Category:Configuration]] diff --git a/docs/configuration/layout.rst b/docs/configuration/layout.rst index 31a41366d..f1dc0552c 100644 --- a/docs/configuration/layout.rst +++ b/docs/configuration/layout.rst @@ -1,15 +1,17 @@ -==Layout Options== -===Layouts=== +Layout Options +============== +Layouts +------- A layout defines how to **render a map**. Layouts are fully customisable, from the road colours and widths to size and type of icons to display for specific POIs. The layout is also where the **cursor** (i.e. the shape which shows where you are) is defined.<br> A number of user-generated layouts and cursor definitions are available at [[Layout]]. -===Defining layers=== +Defining layers +--------------- A layout consist of one cursor and one or more **layers** which are each a set of rules on how and when to draw certain items. Those rules are called **itemgra**. The layers are rendered one by one in the order they appear in the XML config file, as are the items in each layer. If you can't see an item make sure there is not another one hiding it. If your item is hidden, you can move your item further down in the layout section of the file. .. code-block:: xml -<source lang="xml"> <layout name="Demo layout" color="#ffefb7" font="Liberation Sans" active="1"> <cursor w="26" h="26"> <layer name="layer_1"> @@ -19,8 +21,6 @@ A layout consist of one cursor and one or more **layers** which are each a set o </itemgra> </layer> <layout> -</source> - Here the available options: * item_types: Comma separated list of items (see navit/item.h for definitions) @@ -31,39 +31,41 @@ Here the available options: For infos about map icons, see [[Icons]] -===Overriding default (shipped) layouts=== +Overriding default (shipped) layouts +------------------------------------ When the XML config file is parsed, layouts are taken in the order they come, and a layout with an already existing name overrides a previous definition. The default (shipped) navit.xml includes first system-wide navit_layout_*.xml files then the user-specific navit_layout_*.xml files, so the system-wide navit_layout_*.xml files can be overiden by adding a user-specific navit-layout_*.xml containing the same **name** attribute. Copying the default **navit.xml** file to the user-specific location will still use the default shipped layout files, but copying one or several layout files as well to the user-specific location (and modifying them) allow to override these specific layouts. -===Note on the default layout used by navit=== +Note on the default layout used by navit +---------------------------------------- When no layout has been specifically selected by the user (for example at first startup), navit will use the default layout specified (see [[Configuration/General_Options#Default_layout|the related section to know how to configure this]]). -===Using a layer in multiple layouts=== +Using a layer in multiple layouts +--------------------------------- Sometimes, multiple layouts can use the same layer. For example, a reduced layout for a cleaner map may use the same layers as the regular layout, just not all of them. To use a layer in multiple layouts, it can be referenced using the **ref** attribute. In place of the regular layer definition, use an empty tag with only the attributes ''name'' and ''ref'': -<source lang="xml"> -<layer name="Found items" order="0-"> +.. code-block:: xml + + <layer name="Found items" order="0-"> <itemgra item_types="found_item"> <circle color="#008080" radius="24" width="2" text_size="12"/> </itemgra> -</layer> -[...] -<layout name="Demo layout"> + </layer> + [...] + <layout name="Demo layout"> [...] <layer name="Found items for demo layout" ref="Found items" /> [...] -</layout> -<layout name="Demo layout reduced"> + </layout> + <layout name="Demo layout reduced"> [...] <layer name="Found items" ref="Found items" /> [...] -</layout> - -</source> + </layout> Note that the layer you want to reuse must be placed ''outside'' the layout. Layers defined inside a layout cannot be reused in this way. diff --git a/docs/configuration/vehicle.rst b/docs/configuration/vehicle.rst index 3d1769b9f..ee456fb37 100644 --- a/docs/configuration/vehicle.rst +++ b/docs/configuration/vehicle.rst @@ -1,4 +1,5 @@ -==Vehicle Options== +Vehicle Options +=============== It's important to understand the separate but linked Navit concepts of a **vehicle** and [[Vehicleprofile| **vehicleprofile**]] element. A vehicle defines the source of positional data (suchas a USB GPS device), and how to present that data to the user on the map, where the vehicleprofile defines all aspects of routing. A simple vehicle definition looks like this: @@ -6,9 +7,7 @@ A simple vehicle definition looks like this: .. code-block:: xml -<source lang="xml"> - <vehicle name="My" enabled="yes" source="file://dev/ttyS0"/ active="1"/> -</source> + <vehicle name="My" enabled="yes" source="file://dev/ttyS0" active="1"/> Here some of the available options: @@ -25,7 +24,8 @@ Obsolete options: * **animate**: If set to 1, the cursor will be animated as a moving dotted line, to make it easier to see. --> -===GPS=== +GPS +--- Most essential detail is the gps source, that need to be adapted to your local setup. @@ -48,7 +48,7 @@ Linux: * source="file:/dev/ttyS0" - serial GPS connected to the first serial port (you may need to add the correct baudrate eg.: freerunner source="file:/dev/ttySAC1" baudrate="9600") * source="gpsd_dbus:" - via dbus, position reported by gpsd -**Network based:**<br> +**Network based:** If you want to connect multiple tools to your GPS, you need an multiplexer tool, as gpsd or gypsy. * source="gpsd://host[:port]" - gpsd://localhost, the default one, will try to connect to gpsd on localhost * source="socket:ipaddr:post" - socket connection (expects nmea stream) @@ -62,16 +62,15 @@ If you want to connect multiple tools to your GPS, you need an multiplexer tool, * source="demo://" : to use the demo vehicle. Set your Position and Destination, and vehicle will follow the calculated route. Useful if you have no nmea data source. * source="null://" : no GPS at all -===Logging tracks=== +Logging tracks +-------------- To record your trip , you can add a sub-instance "log" to the vehicle. It is possible to add multiple logs. .. code-block:: xml -<source lang="xml"> <log type="gpx" data="track_%Y%m%d%i.gpx" flush_size="1048576" flush_time="900" /> <log type="nmea" data="track_%Y%m%d%i.nmea" flush_size="1048576" flush_time="900" /> -</source> This will give a log file named YearMonthDaySequencenumber.gpx/.nmea which will be kept in memory and flushed to disk when it is 1048576 bytes large or the oldest data is older than 900 seconds. @@ -81,13 +80,13 @@ To display your track for more than one hour, you must use [[binfile]] to create .. code-block:: xml -<source lang="xml"> <log type="binfile" data="track.bin" flush_size="0"/> -</source> + For customizing what is stored, see [[GPX]] -===Vehicleprofile=== +Vehicleprofile +-------------- [[Vehicleprofile | Profiles to add in the navit.xml]] <br/> <!-- this is tricky, here we need a step by step introduction--> @@ -96,16 +95,14 @@ Defines the behaviour of the routing and are usually linked to a vehicle section .. code-block:: xml -<source lang="xml"> -<vehicleprofile name="bike" flags="0x40000000" flags_forward_mask="0x40000000" flags_reverse_mask="0x40000000" maxspeed_handling="1" route_mode="0"> - <roadprofile item_types="path,track_ground" speed="12" route_weight="5"> - </roadprofile> - <roadprofile item_types="track_gravelled,track_paved,cycleway,street_service,street_parking_lane,street_0,street_1_city,living_street,street_2_city,street_1_land,street_2_land,street_3_city" speed="25" route_weight="15"> - </roadprofile> - <roadprofile item_types="roundabout" speed="20" route_weight="10"/> - <roadprofile item_types="ferry" speed="40" route_weight="40"/> - </vehicleprofile> -</source> + <vehicleprofile name="bike" flags="0x40000000" flags_forward_mask="0x40000000" flags_reverse_mask="0x40000000" maxspeed_handling="1" route_mode="0"> + <roadprofile item_types="path,track_ground" speed="12" route_weight="5"> + </roadprofile> + <roadprofile item_types="track_gravelled,track_paved,cycleway,street_service,street_parking_lane,street_0,street_1_city,living_street,street_2_city,street_1_land,street_2_land,street_3_city" speed="25" route_weight="15"> + </roadprofile> + <roadprofile item_types="roundabout" speed="20" route_weight="10"/> + <roadprofile item_types="ferry" speed="40" route_weight="40"/> + </vehicleprofile> For details on the flags, see [[Vehicle profile flags]]. The speeds are in km/h. diff --git a/docs/development/android_development.rst b/docs/development/android_development.rst index 722d7eb82..783a29e91 100644 --- a/docs/development/android_development.rst +++ b/docs/development/android_development.rst @@ -25,9 +25,9 @@ For Android * Download the Android `SDK <http://dl.google.com/android/android-sdk_r18-linux.tgz>` and `NDK <http://dl.google.com/android/ndk/android-ndk-r8-linux-x86.tar.bz2>` * Unzip the SDK and NDK to a directory of your choice. The following instructions assume that the SDK and NDK have been unzipped to `~/src`. * Ensure that the following paths are on your PATH environment variable: - `path-to-sdk/tools` - `path-to-sdk/platform-tools` - `path-to-ndk/toolchains/arm-linux-androideabi-4.4.3/prebuilt/linux-x86/bin` + `path-to-sdk/tools` + `path-to-sdk/platform-tools` + `path-to-ndk/toolchains/arm-linux-androideabi-4.4.3/prebuilt/linux-x86/bin` * On Ubuntu you can accomplish this using the following command (assuming the SDK and NDK have been unzipped to `~/src`): .. code-block:: bash @@ -63,15 +63,15 @@ With cmake cd ~/src mkdir android-build - * Optional: Add a `SOURCE_PATH` environment variable to your system, pointing to the directory in which you checked out a copy of Navit. You can leave out this step, but make sure you change `$SOURCE_PATH` in the next steps to the actual path of the directory. `export SOURCE_PATH=~/src/navit` - * Step into the build directory: `cd ~/src/android-build` - * Run CMake (ensure that you're in the build directory when you do this!): +* Optional: Add a `SOURCE_PATH` environment variable to your system, pointing to the directory in which you checked out a copy of Navit. You can leave out this step, but make sure you change `$SOURCE_PATH` in the next steps to the actual path of the directory. `export SOURCE_PATH=~/src/navit` +* Step into the build directory: `cd ~/src/android-build` +* Run CMake (ensure that you're in the build directory when you do this!): .. code-block:: bash cmake -DCMAKE_TOOLCHAIN_FILE=$SOURCE_PATH/Toolchain/arm-eabi.cmake -DCACHE_SIZE="(20*1024*1024)" -DAVOID_FLOAT=1 -DANDROID_PERMISSIONS="CAMERA" -DANDROID_API_VERSION=8 -DXSLT_PROCESSOR=/usr/bin/saxonb-xslt $SOURCE_PATH - * Build the apk package: +* Build the apk package: .. code-block:: bash @@ -137,7 +137,7 @@ So far, two issues have been observed with the build: * Building `vehicle/gpsd` and `map/garmin` fails on Android. As a workaround, edit `CMakeLists.txt` `, inserting the following two lines in the `if(ANDROID)` block (around line 710): -.. code-block:: C +.. code-block:: set_with_reason(vehicle/gpsd "Android detected" FALSE) set_with_reason(map/garmin "Android detected" FALSE) diff --git a/docs/development/linux_development.rst b/docs/development/linux_development.rst index 20e613acd..e9802ea31 100644 --- a/docs/development/linux_development.rst +++ b/docs/development/linux_development.rst @@ -49,7 +49,7 @@ You can also try the ebuild in the overlay : [sunrise overlay](http://www.gentoo based on the svn to have the latest version of navit. Debian / Ubuntu dependencies -------------------- +---------------------------- It compiles flawlessly on a Lenny (5.0) or later and on `Ubuntu 12.04 LTS` (Precise Pangolin) or later, once all dependencies installed. @@ -59,23 +59,24 @@ Absolute minimum requirements: .. code-block:: bash - gcc cmake zlib1g-dev libpng12-dev libgtk2.0-dev librsvg2-bin + gcc cmake zlib1g-dev libpng12-dev libgtk2.0-dev librsvg2-bin Note that not all these packages are strictly required (for example, maptool can be built without installing GTK+), but this is the smallest practical set of packages if you want to run Navit. - * Translations for the user interface: `gettext` - * Maptool: `protobuf-c-compiler libprotobuf-c-dev` - * GTK+ is included in minimum requirements. `libimlib2-dev` is needed to enable draw_image_warp function which, in turn - allows to use raster maps as discussed in [track #1285](http://trac.navit-project.org/ticket/1285) - * SDL: `libsdl-image1.2-dev libdevil-dev libglc-dev freeglut3-dev libxmu-dev libfribidi-dev` - * OpenGL graphics: `libglc-dev freeglut3-dev libgl1-mesa-dev libxft-dev libglib2.0-dev libfreeimage-dev` - * QT: `libqt4-dev` (This package will pull in all the required packages as dependencies.) - * gpsd: `gpsd gpsd-clients libgps-dev` (optional, but certainly nice to have) - * espeak: `espeak` (optional) - * speechd: `libspeechd-dev` (optional, you are better off with using espeak) - * dbus: `libdbus-glib-1-dev` (optional, you most likely don't need this.) - * python: `python-dev` (optional, you most likely don't need this.) - * saxon: `libsaxonb-java` (only required for android) + + * Translations for the user interface: `gettext` + * Maptool: `protobuf-c-compiler libprotobuf-c-dev` + * GTK+ is included in minimum requirements. `libimlib2-dev` is needed to enable draw_image_warp function which, in turn + allows to use raster maps as discussed in [track #1285](http://trac.navit-project.org/ticket/1285) + * SDL: `libsdl-image1.2-dev libdevil-dev libglc-dev freeglut3-dev libxmu-dev libfribidi-dev` + * OpenGL graphics: `libglc-dev freeglut3-dev libgl1-mesa-dev libxft-dev libglib2.0-dev libfreeimage-dev` + * QT: `libqt4-dev` (This package will pull in all the required packages as dependencies.) + * gpsd: `gpsd gpsd-clients libgps-dev` (optional, but certainly nice to have) + * espeak: `espeak` (optional) + * speechd: `libspeechd-dev` (optional, you are better off with using espeak) + * dbus: `libdbus-glib-1-dev` (optional, you most likely don't need this.) + * python: `python-dev` (optional, you most likely don't need this.) + * saxon: `libsaxonb-java` (only required for android) Everything in one command: diff --git a/docs/development/programming_guidelines.rst b/docs/development/programming_guidelines.rst index 0232697d8..3aecabcf7 100644 --- a/docs/development/programming_guidelines.rst +++ b/docs/development/programming_guidelines.rst @@ -89,7 +89,7 @@ use struct mystruct m={0,}; - * Use `/*` and `*/` for comments instead of `//` +* Use `/*` and `*/` for comments instead of `//` .. note:: diff --git a/docs/development/wince_development.rst b/docs/development/wince_development.rst index d08fbe8ae..423139460 100644 --- a/docs/development/wince_development.rst +++ b/docs/development/wince_development.rst @@ -4,13 +4,13 @@ WinCE Development This is a tutorial for Navit on WinCE/WinMobile. If want just want to download a cab file see [[WinCE]]. -This page explains how to build Navit for WinCE/WinMobile with `cegcc <http://cegcc.sourceforge.net>`_. +This page explains how to build Navit for WinCE/WinMobile with `cegcc <http://cegcc.sourceforge.net>`. In November 2009 versions compiled using arm-cegcc-gcc (both revision 1214 and release 0.59.1) had problems (threw exception_datatype_misalignment and caused access violations). Using the variant arm-mingw32ce of CeGCC 0.59.1 it was possible to build a working executable which can be debugged. -The automatic builds from the subversion repository seem to use an adjusted? version arm-wince-mingw32ce (see `build logs <http://download.navit-project.org/logs/navit/wince/svn>`_). +The automatic builds from the subversion repository seem to use an adjusted? version arm-wince-mingw32ce (see `build logs <http://download.navit-project.org/logs/navit/wince/svn>`). Building using arm-mingw32ce ============================ @@ -81,7 +81,7 @@ Building using arm-cegcc Building cegcc -------------- -Set the install path to where you want to install `cegcc <http://cegcc.sourceforge.net cegcc>`_: +Set the install path to where you want to install `cegcc <http://cegcc.sourceforge.net cegcc>`: .. code-block:: bash @@ -144,7 +144,7 @@ The current versions of these libs don't need many changes, but they all don't k | -openstep* | -oskit* | -conix* | -pw32* | -nonstopux* \ zlib -'''' +^^^^ .. code-block:: bash @@ -157,7 +157,7 @@ zlib make install libiconv -'''''''' +^^^^^^^^ .. code-block:: bash @@ -171,7 +171,7 @@ libiconv make install gettext -''''''' +^^^^^^^ workaround for `plural-eval.h:50: error: expected '=', ',', ';', 'asm' or '__attribute__' before 'sigfpe_exit'` extend gettext-tools/src/plural-eval.h line 32 to `#if defined _MSC_VER || defined __MINGW32__ || defined __CEGCC__` @@ -189,7 +189,7 @@ dito for gettext-tools/gnulib-lib/wait-process.c line 31 make install libpng -'''''' +^^^^^^ .. code-block:: bash @@ -202,9 +202,9 @@ libpng make install libtiff -''''''' +^^^^^^^ -.. code-block:: bash +.. code-block:: libtool: link: CURRENT `' must be a nonnegative integer @@ -220,9 +220,9 @@ libtiff make install glib -'''' +^^^^ -.. code-block:: bash +.. code-block:: gatomic.c:570: Error: no such instruction: `swp %eax,%eax,[%esi]' diff --git a/docs/development/windows_development.rst b/docs/development/windows_development.rst index 511f261c1..1c5248605 100644 --- a/docs/development/windows_development.rst +++ b/docs/development/windows_development.rst @@ -189,19 +189,19 @@ Downloads --------- In order to compile the win32 version of Navit, you need the following software development tools - * GTK+ toolkit for win32 from `SourceForgeDownload: Glade/GTK+ <http://sourceforge.net/project/showfiles.php?group_id=98754>`_ (select gtk+-win32-devel) + * GTK+ toolkit for win32 from `SourceForgeDownload: Glade/GTK+ <http://sourceforge.net/project/showfiles.php?group_id=98754>` (select gtk+-win32-devel) * MinGW from `SourceForgeDownload: MinGW <http://sourceforge.net/project/showfiles.php?group_id=2435>`_ (select Automated MinGW installer) - * MSYS from `SourceForgeDownload: MSYS Base System <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=2496>`_ - * msysCORE from `SourceForgeDownload: MSYS Base System <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=24963>`_ - * diffutils from `SourceForgeDownload: MSYS Base System <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=24963>`_ - * autoconf from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>`_ - * autogen from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>`_ - * automake from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>`_ - * gettext from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>`_ - * libtool from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>`_ - * libiconv from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/downloads/mingw/MinGW/libiconv>`_ - -Probably the easiest way to obtain and install all the MSYS packages is to follow the instructions `here <http://www.mingw.org/wiki/msys>`_ + * MSYS from `SourceForgeDownload: MSYS Base System <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=2496>` + * msysCORE from `SourceForgeDownload: MSYS Base System <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=24963>` + * diffutils from `SourceForgeDownload: MSYS Base System <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=24963>` + * autoconf from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>` + * autogen from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>` + * automake from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>` + * gettext from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>` + * libtool from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>` + * libiconv from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/downloads/mingw/MinGW/libiconv>` + +Probably the easiest way to obtain and install all the MSYS packages is to follow the instructions `here <http://www.mingw.org/wiki/msys>` For speech support, one option is to use the "cmdline" speech type (refer to [[Configuration]]) and a utility such as a Windows port of `Say <http://krolik.net/wsvn/wsvn/public/Say%2B%2B/>`_ diff --git a/docs/index.rst b/docs/index.rst index 4c4f4f5db..9a5600a46 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,6 @@ +################### Navit's User Manual -=================== +################### This document is the official User Manual for `Navit`__, the OpenSource vector based navigation software. @@ -29,6 +30,7 @@ Navit is highly customizable, from map layouts and on-screen display to the deta basic_configuration maps + configuration/index .. Indices and tables diff --git a/docs/maps.rst b/docs/maps.rst index ff5b18c2f..66e1e5e0e 100644 --- a/docs/maps.rst +++ b/docs/maps.rst @@ -1,4 +1,5 @@ .. _maps: + Maps ==== diff --git a/docs/navit.png b/docs/navit.png Binary files differindex 81f3239d6..242aed8e4 100644 --- a/docs/navit.png +++ b/docs/navit.png diff --git a/docs/osm.rst b/docs/osm.rst index 12766d0d2..107cbf85f 100644 --- a/docs/osm.rst +++ b/docs/osm.rst @@ -1,21 +1,24 @@ -.. _OpenStreetMap: OpenStreetMap ------------- -`OpenStreetMap <http://www.openstreetmap.org/>`_ is a free editable map of the whole world. It is made by people like you. OpenStreetMap allows you to view, edit and use geographical data in a collaborative way from anywhere on Earth. Maps from OpenStreetMap can be used in Navit. +`OpenStreetMap <http://www.openstreetmap.org/>` is a free editable map of the whole world. It is made by people like you. OpenStreetMap allows you to view, edit and use geographical data in a collaborative way from anywhere on Earth. Maps from OpenStreetMap can be used in Navit. + Quick Start ~~~~~~~~~~~ * Go to `Navit Planet Extractor <http://maps.navit-project.org/>`_ -* Zoom in and select the area that you are interested in. Use the 'Map Controls' on the right to switch between 'Navigation' and 'Select' modes. or use preselected areas: - * `Germany <http://maps.navit-project.org/api/map/?bbox=5.185546875,46.845703125,15.46875,55.634765625>`_ - * `France <http://maps.navit-project.org/api/map/?bbox=-5.44921875,42.01171875,8.437500000000002,51.6796875>`_ - * `BeNeLux <http://maps.navit-project.org/api/map/?bbox=2.08740234375,48.8671875,7.778320312500001,54.51416015625>`_ - * `Spain/Portugal <http://maps.navit-project.org/api/map/?bbox=-11.0302734375,34.87060546875,4.614257812500003,44.40673828125>`_ - * `Italy <http://maps.navit-project.org/api/map/?bbox=6.52587890625,36.38671875,18.96240234375,47.197265625>`_ - * `Entire planet <http://maps.navit-project.org/planet.bin>`_ -* Hit '''Get Map!''' +* Zoom in and select the area that you are interested in. Use the 'Map Controls' on the right to switch between 'Navigation' and 'Select' modes. or use +* preselected areas: + + * `Germany <http://maps.navit-project.org/api/map/?bbox=5.185546875,46.845703125,15.46875,55.634765625>`_ + * `France <http://maps.navit-project.org/api/map/?bbox=-5.44921875,42.01171875,8.437500000000002,51.6796875>`_ + * `BeNeLux <http://maps.navit-project.org/api/map/?bbox=2.08740234375,48.8671875,7.778320312500001,54.51416015625>`_ + * `Spain/Portugal <http://maps.navit-project.org/api/map/?bbox=-11.0302734375,34.87060546875,4.614257812500003,44.40673828125>`_ + * `Italy <http://maps.navit-project.org/api/map/?bbox=6.52587890625,36.38671875,18.96240234375,47.197265625>`_ + * `Entire planet <http://maps.navit-project.org/planet.bin>`_ + +* Hit "Get Map!" * Move the downloaded map to the directory of your choice, and add it to the active the mapset (see [[Configuration]]) in navit.xml with a line similar to the following: .. code-block:: xml @@ -38,7 +41,7 @@ Topographic Maps ~~~~~~~~~~~~~~~~ Navit will display elevation/height lines but the required data is not included in most OSM derived maps. -Navit compatible maps with height lines can be created by feeding the output of `Phyghtmap <http://wiki.openstreetmap.org/wiki/Phyghtmap>`_ to Navit's maptool. Alternatively the SRTM data can be downloaded in osm.xml format http://geoweb.hft-stuttgart.de/SRTM/srtm_as_osm/, avoiding the Phygtmap step. The information can be either merged with OSM derived maps or used in a separate layer. +Navit compatible maps with height lines can be created by feeding the output of `Phyghtmap <http://wiki.openstreetmap.org/wiki/Phyghtmap>` to Navit's maptool. Alternatively the SRTM data can be downloaded in osm.xml format http://geoweb.hft-stuttgart.de/SRTM/srtm_as_osm/, avoiding the Phygtmap step. The information can be either merged with OSM derived maps or used in a separate layer. Many Garmin type maps such as http://www.wanderreitkarte.de/garmin_de.php also have the height lines information but routing will not work with them. @@ -50,14 +53,16 @@ Download your own OSM data ^^^^^^^^^^^^^^^^^^^^^^^^^^ OSM data can be downloaded from a variety of sources. OpenStreetMap XML Data files are regular textfiles, easily editable in any text editor. OpenStreetMap Protobuf Data files are binary files, which take up less space (so are quicker to download and process) but are not editable. -* '''OpenStreetMap XML Data''' - * `Geofabrik <http://download.geofabrik.de/osm/>`_ provides pre-processed OpenStreetMap XML Data files of almost all countries, and all continents. This method is probably the easiest way of downloading OpenStreetMap XML Data for an entire country or continent. Note that the OSM files are bzipped - * `planet.openstreetmap.org <http://planet.openstreetmap.org>`_ hosts the complete data set (the whole world). You can use `Osmosis <http://wiki.openstreetmap.org/index.php/Osmosis>`_ to cut it into smaller chunks. - * `OpenStreetMap ReadOnly (XAPI) <http://wiki.openstreetmap.org/wiki/Xapi>`_ The API allows to get the data of a specific bounding box, so that download managers can be used. For example: - wget -O map.osm "http://xapi.openstreetmap.org/api/0.6/map?bbox=11.4,48.7,11.6,48.9" - * [http://www.openstreetmap.org/export OpenStreetMap (visual)] allows you to select a small rectangular area and download the selection as OpenStreetMap XML Data. +* OpenStreetMap XML Data + + * `Geofabrik <http://download.geofabrik.de/osm/>`_ provides pre-processed OpenStreetMap XML Data files of almost all countries, and all continents. This method is probably the easiest way of downloading OpenStreetMap XML Data for an entire country or continent. Note that the OSM files are bzipped + * `planet.openstreetmap.org <http://planet.openstreetmap.org>`_ hosts the complete data set (the whole world). You can use `Osmosis <http://wiki.openstreetmap.org/index.php/Osmosis>`_ to cut it into smaller chunks. + * `OpenStreetMap ReadOnly (XAPI) <http://wiki.openstreetmap.org/wiki/Xapi>`_ The API allows to get the data of a specific bounding box, so that download managers can be used. For example: + wget -O map.osm "http://xapi.openstreetmap.org/api/0.6/map?bbox=11.4,48.7,11.6,48.9" + * `OpenStreetMap (visual) <http://www.openstreetmap.org/export>`_ allows you to select a small rectangular area and download the selection as OpenStreetMap XML Data. + * '''OpenStreetMap Protobuf Data''' - * [http://download.geofabrik.de/osm/ Geofabrik] provides pre-processed OpenStreetMap Protobuf Data files of almost all countries, and all continents. + * [http://download.geofabrik.de/osm/ Geofabrik] provides pre-processed OpenStreetMap Protobuf Data files of almost all countries, and all continents. Convert OSM data to Navit binfile ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -112,6 +117,7 @@ Tips * To enable a map you have downloaded refer [[OpenStreetMap#Adding_an_OSM_map_to_your_mapset| adding OSM map to navit.xml]] * If you don't see any map data in Navit (assuming your map is properly specified in navit.xml) using the Internal GUI click anywhere on the screen to bring up the menu. Click on "Actions" and then "Town". Type in the name of a town that should be within your map data. Select your town from the list that appears. This will bring up a sub-menu where you can click "View On Map". Note that if you have a GPS receiver you can also just wait till you get a satellite lock. * To avoid changing navit.xml if you update your maps and the maps have different file names use the wildcard (\*.bin) in your navit.xml file. For example: + .. code-block:: xml <map type="binfile" enabled="yes" data="/media/mmc2/maps/*.bin"/> |