Difference between revisions of "Internal GUI"

From Navit's Wiki
Jump to: navigation, search
(Map Point)
(Updating screenshots and wording of menu items.)
Line 25: Line 25:
 
[[Image:N810-OSD-Home.png|300px|thumb]]
 
[[Image:N810-OSD-Home.png|300px|thumb]]
 
When Navit is first started using the Internal GUI one should see (depending on the skin you have selected to use) something similar to the image to the right. The layout of the internal GUI is controlled by the OSD tags located in the navit.xml file. These tags should be located within the first 100 lines of the file. For information on how to modify the appearance of the OSD layout please reference this link. [[OSD|OSD Layout]]
 
When Navit is first started using the Internal GUI one should see (depending on the skin you have selected to use) something similar to the image to the right. The layout of the internal GUI is controlled by the OSD tags located in the navit.xml file. These tags should be located within the first 100 lines of the file. For information on how to modify the appearance of the OSD layout please reference this link. [[OSD|OSD Layout]]
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
 
==Main Menu==
 
==Main Menu==
Line 53: Line 64:
 
#[[Internal Gui#Town|Town]]
 
#[[Internal Gui#Town|Town]]
 
#Quit - Closes Navit
 
#Quit - Closes Navit
 
 
  
  
Line 79: Line 88:
 
* Add as Bookmark: Brings up a keyboard so a name can be entered for the bookmark. The point can then be easily recalled via the [[Internal GUI#Bookmarks| Bookmark]] menu.  
 
* Add as Bookmark: Brings up a keyboard so a name can be entered for the bookmark. The point can then be easily recalled via the [[Internal GUI#Bookmarks| Bookmark]] menu.  
 
* POIs: Brings up a list of all known POIs around the map point.  
 
* POIs: Brings up a list of all known POIs around the map point.  
 +
 +
 +
 +
 +
 +
=====POIs=====
 +
[[Image:InternalGUI-POIs.png|300px|thumb]]
 +
The POIs sub menu shows all of the POIs that are close to the location that was clicked on the map, with the distance to the POI shown in kilometres. At the top of the menu there are various filter options that allow for specifying the types of POIs to be displayed. The user can click on the POI and select to be routed to that location. Navit will create a route from the current position to the location of the POI selected.
 +
 +
 +
  
  
Line 88: Line 108:
  
  
=====POIs=====
 
[[Image:InternalGUI-POIs.png|300px|thumb]]
 
The POIs sub menu shows all of the POIs that are close to the location that was clicked on the map, with the distance to the POI shown in kilometres. At the top of the menu there are various filter options that allow for specifying the types of POIs to be displayed. The user can click on the POI and select to be routed to that location. Navit will create a route from the current position to the location of the POI selected.
 
  
 
====Vehicle Position====
 
====Vehicle Position====
Line 96: Line 113:
 
The vehicle icon brings up the Current Location sub menu. This sub menu allows for various actions to be taken for the GPS position of the device.
 
The vehicle icon brings up the Current Location sub menu. This sub menu allows for various actions to be taken for the GPS position of the device.
  
* Street Numbers: Item not functioning yet
+
* Set as Destination: Will generate a route to that location from either current GPS data or where vehicle position is manually set (see Vehicle Position).
* Set as Destination: Will generate a route to that location based off of either current GPS data or where vehicle position is manually set (see Vehicle Position).
 
 
* Set as Position: If no GPS data is available then you can specify your "current" location in order to have a route generated from that position to your desired destination.
 
* Set as Position: If no GPS data is available then you can specify your "current" location in order to have a route generated from that position to your desired destination.
* Add as Bookmark: Brings up a keyboard so a name can be entered for the bookmark. The point can then be easily pulled up in the book mark for usage.  
+
* Add as Bookmark: Brings up a keyboard so a name can be entered for the bookmark. The point can then be easily recalled via the [[Internal GUI#Bookmarks| Bookmark]] menu.  
* POIs: Brings up a list of all known POIs close to that point on the map.  
+
* POIs: Brings up a list of all known POIs around the map point.  
* View on Map: Refocuses the map to display the current "known" position based off of GPS data.
+
* View on Map: Re-pans the map to display the current "known" position based upon GPS data.
  
  
Line 110: Line 126:
 
====Town====
 
====Town====
 
[[Image:InternalGui-Town.png|300px|thumb]]
 
[[Image:InternalGui-Town.png|300px|thumb]]
The town icon allows for searching for different cities within your map set. Note that Navit attempts to auto complete the town name based off of names available in the mapset being used. On slow devices this can result in a slight pause as each character is typed in. Once a town is located and selected another sub menu will come up allowing for a street to be found within that town.  
+
The town icon allows for searching for different cities within your map set. Note that Navit attempts to auto complete the town name based upon names available in the mapset being used. On slow devices this can result in a slight pause as each character is typed in. Once a town is located and selected another sub menu will come up allowing for a street to be found within that town.
  
The icon in the upper left corner (just below the world icon) shows the current country that you would like to search in. To change the country just click on the icon and another menu will come up allowing you to type in the country you would like to search in. Note that this menu also attempts to auto complete as the user types in the name of a country.  
+
The icon in the upper left corner (just below the world icon) shows the current country which is being searched. To change the country just click on the icon and another menu will appear allowing you to select the country you would like to search in. Note that this menu also attempts to auto complete as the user types in the name of a country.  
  
 
Note that if you compiled Navit yourself there can be issues with the icons not being properly generated. This will result in no icon image at all. If you have this problem check your logs to see what is happening during compiling.
 
Note that if you compiled Navit yourself there can be issues with the icons not being properly generated. This will result in no icon image at all. If you have this problem check your logs to see what is happening during compiling.
  
 +
If you are having problems with search, please check [[OpenStreetMap#Problems_with_OSM_and_navit_or_navigation_in_general]].
  
  
  
  
 
 
====Quit====
 
Closes Navit.
 
  
 
===Settings===
 
===Settings===
 
[[Image:InternalGUI-Settings.png|300px|thumb]]
 
[[Image:InternalGUI-Settings.png|300px|thumb]]
The settings menu provides several sub menus to allow for certain aspects of how Navit operates to be modified. Note that at this time there is only a limited set of options that can be changed through these sub menus. In order to change settings not currently available in this sub-menu it is necessary to modify the navit.xml file. At some point in the future a more robust settings menu will be implemented that will allow for configuring Navit through a GUI instead of the navit.xml file.
+
The settings menu provides several sub menus to enable certain aspects of how Navit operates to be modified. Note that at this time there is only a limited set of options that can be changed through these sub menus. In order to change settings not currently available in this sub-menu it is necessary to modify the navit.xml file. At some point in the future a more robust settings menu will be implemented that will allow for configuring Navit through a GUI instead of the navit.xml file.
  
 
The sub menu items are:
 
The sub menu items are:
  
 
#[[Internal Gui#Display|Display]]
 
#[[Internal Gui#Display|Display]]
# [[Internal Gui#Maps|Maps]]
+
#[[Internal Gui#Maps|Maps]]
# [[Internal Gui#Vehicle|Vehicle]]
+
#[[Internal Gui#Vehicle|Vehicle]]
# [[Internal Gui#Rules|Rules]]
+
#[[Internal Gui#Rules|Rules]]
  
  
 
====Display====
 
====Display====
 
[[Image:InternalGUI-Display.png|300px|thumb]]
 
[[Image:InternalGUI-Display.png|300px|thumb]]
The display sub menu provides items to control various display items of Navit.
+
The display sub menu provides items to control various display features within Navit.
  
 
# [[Internal Gui#Layout|Layout]]
 
# [[Internal Gui#Layout|Layout]]
# [[Internal Gui#Window Mode|Window Mode]]
+
# [[Internal Gui#Window Mode|Fullscreen/Window Mode]]
 
# [[Internal Gui#3D|3D]]
 
# [[Internal Gui#3D|3D]]
 +
 +
 +
  
  
Line 156: Line 172:
 
=====Layout=====
 
=====Layout=====
 
[[Image:InternalGUI-Layout.png|300px|thumb]]
 
[[Image:InternalGUI-Layout.png|300px|thumb]]
Layout allows for different layout options specified in the navit.xml file to be shown on the map. Different layouts can be used for different reasons including allowing one to see other friends position (if their GPS data specified in the layout tag). Note that layout options MUST be enabled in the navit.xml file before they can be turned on or off in this menu. The three items in the screen shot below are layout options listed in the navit.xml file but are currently disabled in the navit.xml file.
+
Layout allows for different layouts specified in the navit.xml file to be shown on the map. Different layouts can be used for different reasons including allowing one to see other friends position (if their GPS data is specified in the layout tag). Note that layout options MUST be enabled in the navit.xml file before they can be turned on or off in this menu.
 +
 
 +
 
  
  
Line 169: Line 187:
  
 
=====Window Mode (Toggle)=====
 
=====Window Mode (Toggle)=====
Changes Navit from Windowed Mode to Full Screen and vice versa. Note that this can also be accomplished from the map itself using the "window" icon.
+
Changes Navit from windowed mode to fullscreen mode and vice versa.
  
 
=====3D (Toggle)=====
 
=====3D (Toggle)=====
 
This is a toggle button that enables / disables drawing the map in either a 2D mode or a 3D mode. Currently the only way to modify the "tilt" for the 3D mode is to modify the navit.xml file.
 
This is a toggle button that enables / disables drawing the map in either a 2D mode or a 3D mode. Currently the only way to modify the "tilt" for the 3D mode is to modify the navit.xml file.
 +
 +
 +
  
 
====Maps====
 
====Maps====
 
[[Image:InternalGUI-Maps.png |300px|thumb]]
 
[[Image:InternalGUI-Maps.png |300px|thumb]]
Displays the maps that are specified in the navit.xml file and allows for enabling/disabling those maps.
+
Displays the maps that are specified in the navit.xml file and allows for activating/de-activating those maps. Note that a map must be enabled in navit.xml before it will appear in this menu.
 +
 
 +
 
  
  
Line 196: Line 219:
 
Brings up a menu showing what GPS device is currently being used for the current vehicle. Tapping the GPS device name opens a menu with available routing profiles.
 
Brings up a menu showing what GPS device is currently being used for the current vehicle. Tapping the GPS device name opens a menu with available routing profiles.
  
====Rules====
 
[[Image:InternalGUI-Rules.png|300px|thumb]]
 
The rules menu provides for options that change how Navit behaves when there is a satellite lock. Note that some of these items are currently not function and must be changed in the navit.xml file.
 
  
  
Line 212: Line 232:
  
  
===Tools===
 
Currently a non functional menu item.
 
  
===Route===
 
[[Image:InternalGUI-Route.png|300px|thumb]]
 
The route icon brings up the route menu that will display the active route.
 
  
#[[Internal Gui#Route Description|Route Description]]
+
 
# [[Internal Gui#Height Profile|Height Profile]]
+
====Rules====
 +
[[Image:InternalGUI-Rules.png|300px|thumb]]
 +
The rules menu provides for options that change how Navit behaves when there is a satellite lock. Note that some of these items are currently not function and must be changed in the navit.xml file.
 +
 
 +
 
 +
 
  
  
Line 231: Line 251:
  
  
 +
===Tools===
 +
The tools menu allows the user to check what Locale Navit is set to.
  
====Route Description====
+
===Route===
[[Image:InternalGUI-RouteDescription.png|300px|thumb]]
+
[[Image:InternalGUI-Route.png|300px|thumb]]
The route description sub menu displays all of the directions for the currently calculated route.
+
The route icon brings up the route menu that will display the active route.
  
 +
#[[Internal Gui#Route Description|Route Description]]
 +
#Height Profile - currently not implemented.
  
  
Line 248: Line 272:
  
  
 +
====Route Description====
 +
[[Image:InternalGUI-RouteDescription.png|300px|thumb]]
 +
The route description sub menu displays all of the directions for the currently calculated route.
  
====Height Profile====
 
  
[[Category:Gui]]
+
[[Category:GUI]]

Revision as of 17:05, 9 January 2011

The Internal GUI is designed to be used on touch screen devices, but also work very well on other devices such as netbooks and laptops. It is under continual development and as such features are constantly being added and improved upon. If you think that a particular feature is missing or poorly implemented, come talk to us in the irc channel or open up a feature request on the trac system.


Configuring Internal GUI

Enabling Internal GUI

The Internal GUI is configured as the default GUI for Navit, so if you're reading this after a first install no further configuration is required.

If the configuration has changed since first install, the Internal GUI can be chosen by setting the type attribute in the <gui> tag.

<gui type="internal" enabled="yes">

Ensure that any other gui tags are disabled by setting their enabled attribute to "no".

Keyboard Preferences

Some options inside the Internal GUI menu require keyboard input - for example, Town search. By default, Navit provides a custom on-screen keyboard to enter text. If your device has it's own keyboard which you'd prefer to use, and you'd like to conserve some screen space then set the keyboard attribute to "false" inside the <gui> tag.

<gui type="internal" enabled="yes" keyboard="false">

Menu Configuration

Using Internal GUI, the menu can be brought up by clicking (almost) anywhere on the map, or pressing the Enter (Return) key on the device's keyboard.

The menu is configured using a html-like syntax inside the <gui> ... </gui> tags. Of course, this configuration can be customised - alternative configurations can be found in Internal GUI/Menu configurations.

Initial Start-up

N810-OSD-Home.png

When Navit is first started using the Internal GUI one should see (depending on the skin you have selected to use) something similar to the image to the right. The layout of the internal GUI is controlled by the OSD tags located in the navit.xml file. These tags should be located within the first 100 lines of the file. For information on how to modify the appearance of the OSD layout please reference this link. OSD Layout







Main Menu

InternalGui-MainMenu.png

The main menu is accessed by a single click (or tap for touch screen) anywhere on the map. From here all other sub-menus and actions are accessible. The sub menu items are:

  1. Actions
  2. Settings
  3. Tools
  4. Route
  5. About





Actions

InternalGUI-Actions.png

The Actions menu brings up several sub menus that are focused primarily on routing and location finding. The sub menu items are:

  1. Bookmarks
  2. Map Point
  3. Current Location
  4. Town
  5. Quit - Closes Navit





Bookmarks

InternalGUI-Bookmarks.png

Bookmarks provide a convenient way to store often used destinations. Since Navit does not fully support entering a complete address using OpenStreetMap maps, a user can locate some oft-used destinations on the map and then add that point as a bookmark. That way the next time the user would like a route for that particular destination the user only has to select it from the Bookmarks menu and does not have to go through the tedium of panning the map and zooming into the destination location.

Bookmarks can be arranged hierarchical using / as a separator - anything before the separator becomes the folder name; anything after the separator becomes the bookmark name. For example, if you name your bookmarks Friends/Joe and Friends/Bill, you will have a folder named Friends and the bookmarks Bill and Joe in there.

A fully functioning bookmark editor is currently not available, though some common edits can be performed from within the Bookmarks menu. Bookmarks are stored in a plain-text bookmarks file in your Navit directory (~/.navit on unix systems).

Map Point

InternalGUI-MapPoint.png

The world icon brings up the Map Point sub menu for actions that can be performed for the point that was selected on the map. The items contained in this sub menu are:

  • Set as Destination: Will generate a route to that location from either current GPS data or where vehicle position is manually set (see Vehicle Position).
  • Set as Position: If no GPS data is available then you can specify your "current" location in order to have a route generated from that position to your desired destination.
  • Add as Bookmark: Brings up a keyboard so a name can be entered for the bookmark. The point can then be easily recalled via the Bookmark menu.
  • POIs: Brings up a list of all known POIs around the map point.



POIs
InternalGUI-POIs.png

The POIs sub menu shows all of the POIs that are close to the location that was clicked on the map, with the distance to the POI shown in kilometres. At the top of the menu there are various filter options that allow for specifying the types of POIs to be displayed. The user can click on the POI and select to be routed to that location. Navit will create a route from the current position to the location of the POI selected.







Vehicle Position

InternalGUI-VehiclePosition.png

The vehicle icon brings up the Current Location sub menu. This sub menu allows for various actions to be taken for the GPS position of the device.

  • Set as Destination: Will generate a route to that location from either current GPS data or where vehicle position is manually set (see Vehicle Position).
  • Set as Position: If no GPS data is available then you can specify your "current" location in order to have a route generated from that position to your desired destination.
  • Add as Bookmark: Brings up a keyboard so a name can be entered for the bookmark. The point can then be easily recalled via the Bookmark menu.
  • POIs: Brings up a list of all known POIs around the map point.
  • View on Map: Re-pans the map to display the current "known" position based upon GPS data.




Town

InternalGui-Town.png

The town icon allows for searching for different cities within your map set. Note that Navit attempts to auto complete the town name based upon names available in the mapset being used. On slow devices this can result in a slight pause as each character is typed in. Once a town is located and selected another sub menu will come up allowing for a street to be found within that town.

The icon in the upper left corner (just below the world icon) shows the current country which is being searched. To change the country just click on the icon and another menu will appear allowing you to select the country you would like to search in. Note that this menu also attempts to auto complete as the user types in the name of a country.

Note that if you compiled Navit yourself there can be issues with the icons not being properly generated. This will result in no icon image at all. If you have this problem check your logs to see what is happening during compiling.

If you are having problems with search, please check OpenStreetMap#Problems_with_OSM_and_navit_or_navigation_in_general.



Settings

InternalGUI-Settings.png

The settings menu provides several sub menus to enable certain aspects of how Navit operates to be modified. Note that at this time there is only a limited set of options that can be changed through these sub menus. In order to change settings not currently available in this sub-menu it is necessary to modify the navit.xml file. At some point in the future a more robust settings menu will be implemented that will allow for configuring Navit through a GUI instead of the navit.xml file.

The sub menu items are:

  1. Display
  2. Maps
  3. Vehicle
  4. Rules


Display

InternalGUI-Display.png

The display sub menu provides items to control various display features within Navit.

  1. Layout
  2. Fullscreen/Window Mode
  3. 3D







Layout
InternalGUI-Layout.png

Layout allows for different layouts specified in the navit.xml file to be shown on the map. Different layouts can be used for different reasons including allowing one to see other friends position (if their GPS data is specified in the layout tag). Note that layout options MUST be enabled in the navit.xml file before they can be turned on or off in this menu.







Window Mode (Toggle)

Changes Navit from windowed mode to fullscreen mode and vice versa.

3D (Toggle)

This is a toggle button that enables / disables drawing the map in either a 2D mode or a 3D mode. Currently the only way to modify the "tilt" for the 3D mode is to modify the navit.xml file.



Maps

InternalGUI-Maps.png

Displays the maps that are specified in the navit.xml file and allows for activating/de-activating those maps. Note that a map must be enabled in navit.xml before it will appear in this menu.









Vehicle

InternalGUI-Vehicle.png

Brings up a menu showing what GPS device is currently being used for the current vehicle. Tapping the GPS device name opens a menu with available routing profiles.









Rules

InternalGUI-Rules.png

The rules menu provides for options that change how Navit behaves when there is a satellite lock. Note that some of these items are currently not function and must be changed in the navit.xml file.







Tools

The tools menu allows the user to check what Locale Navit is set to.

Route

InternalGUI-Route.png

The route icon brings up the route menu that will display the active route.

  1. Route Description
  2. Height Profile - currently not implemented.







Route Description

InternalGUI-RouteDescription.png

The route description sub menu displays all of the directions for the currently calculated route.