diff options
Diffstat (limited to 'docs/configuration/index.rst')
| -rw-r--r-- | docs/configuration/index.rst | 152 |
1 files changed, 50 insertions, 102 deletions
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]] |