Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revisionBoth sides next revision
en:help:settings:user-settings [2015/12/17 12:09] – [List of main user settings] psyberiaen:help:settings:user-settings [2017/11/06 21:22] psyberia
Line 11: Line 11:
  
  
-==== List of main user settings ====+===== List of user settings ===== 
 +\\ 
 +^  Name  ^ Type  ^  Default value  ^  Preview 
 +^ **Core** ^^^^ 
 +| **''core.logs.verbose''**  | Boolean  | ''0'' / ''false''  |  | 
 +| Activate the verbose mode so the application displays more information in the log files.  ||| ::: | 
 +| **''core.locale''**  | [ ''ar'', ''en'', ''es'', ''fr'', ''it'', ''ko'', ''lt'', ''pt'', ''ru'', ''sk'', ''tr'' ]  | ''empty''  |  | 
 +| Force a different language other than the one of the device.  ||| ::: | 
 +| **''core.custom_location_printer''**  | [ ''grid'', ''xy'', ''d'', ''dm'', ''dms'' ],String  | ''empty''  |  | 
 +| Define a custom coordinate format. The first part is the display format, the second part is the [[https://en.wikipedia.org/wiki/Well-known_text|OGC WKT]] of the projection (for example something like [[http://www.spatialreference.org/ref/epsg/4326/ogcwkt/|this]]).  ||| ::: | 
 +| **''core.bearing_decimals''**  | Integer  | ''2''  | {{:en:help:v2:settings:user-settings:bearing-decimals.jpg?nolink}} | 
 +| Define the maximum number of decimals to use when displaying bearing units.  ||| ::: | 
 +| **''core.pictures.format''**  | String  | ''yyyy-MM-dd_HH-mm-ss''  |  | 
 +| Define how to name pictures taken from the application, for example when creating picture waypoints (see accepted patterns [[http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns|here]]).  ||| ::: | 
 +| **''core.audio.volume''**  | Float [''0.0'' - ''1.0'' | ''1.0''  |  | 
 +| Default volume of played sounds from proximity alerts and followed paths.  ||| ::: | 
 +| **''core.audio.stream''**  | [''3'', ''4'', ''5'' | ''4''  |  | 
 +| System audio stream on which to play sounds: ''3'' (MUSIC), ''4'' (ALARM), ''5'' (NOTIF)  ||| ::: | 
 +| **''core.screen.orientation''**  | [''PORTRAIT'', ''LANDSCAPE'' | empty  |  | 
 +| Force a particular screen orientation.  ||| ::: | 
 +| **''core.submenu.force_exit_button''**  | Boolean  | ''0'' / ''false''  | {{:en:help:v2:settings:user-settings:display-close-menu-entry.jpg?nolink}} | 
 +| Display an exit button in the main menu on all devices.  ||| ::: | 
 +| **''core.submenu.display_workspaces_chooser''**  | Boolean  | ''1'' / ''true''  |  | 
 +| Display a chooser to switch workspace in the main sub-menu (only when at least one alternate workspace has been created).  ||| ::: | 
 +| **''core.menu.display_help_buttons''**  | Boolean  | ''1'' / ''true''  |  | 
 +| Display help buttons in the menus.  ||| ::: | 
 +| **''core.behavior.finish_on_external_map''**  | Boolean  | ''0'' / ''false''  |  | 
 +| Close the application when selecting an external mapping application from the "Open with" action.  ||| ::: | 
 +^ **Main map** ^^^^ 
 +| **''map.infobox.text_color''**  | String  | ''#212121''  | {{:en:help:v2:settings:user-settings:infobox-text-color.jpg?nolink}} | 
 +| Define the display color of the texts displayed in the information boxes (see accepted colors [[http://html-color-codes.info/#HTML_Color_Picker|here]]).  ||| ::: | 
 +| **''map.coordinates.main.color''**  | String  | ''#000000''  |  | 
 +| Define the display color of the main coordinate format and grid (see accepted colors [[http://html-color-codes.info/#HTML_Color_Picker|here]]).  ||| ::: | 
 +| **''map.coordinates.alternative.color''**  | String  | ''#0000FF''  |  | 
 +| Define the display color of the alternative coordinate format and grid (see accepted colors [[http://html-color-codes.info/#HTML_Color_Picker|here]]).  ||| ::: | 
 +| **''map.coordinates.share_crs''**  | String  | ''EPSG:4326''  |  | 
 +| EPSG code of the coordinate reference system (CRS) to use when sharing a coordinate using the "Share" action. By default, the application uses the GPS coordinate system (code "''EPSG:4326''" ||| ::: | 
 +| **''map.coordinates.share_provider''**  | String  | ''null''  |  | 
 +| URL of a mapping website to use in the "Share" action text message. The following variables are available: "''{$longitude}''", "''{$latitude}''" and "''{$zoom}''". The default URL is "''https://google.com/maps/place/{$latitude},{$longitude}''" ||| ::: | 
 +| **''map.coordinates.openwith_provider.osm''**  | String  | ''null''  |  | 
 +| URL of the website to use when selecting the "Open with OpenStreetMap Maps" action. The default URL is "''https://www.openstreetmap.org/#map={$zoom}/{$latitude}/{$longitude}''" ||| ::: | 
 +| **''map.coordinates.openwith_provider.google''**  | String  | ''null''  |  | 
 +| URL of the website to use when selecting the "Open with Google Maps" action. The default URL is "''https://google.com/maps/place/{$latitude},{$longitude}/@{$latitude},{$longitude},{$zoom}z''" ||| ::: | 
 +| **''map.coordinates.openwith_provider.yandex''**  | String  | ''null''  |  | 
 +| URL of the website to use when selecting the "Open with Yandex Maps" action. The default URL is "''https://yandex.ru/maps/?ll={$longitude}%2C{$latitude}&z={$zoom}&mode=whatshere&whatshere%5Bpoint%5D={$longitude}%2C{$latitude}&whatshere%5Bzoom%5D={$zoom}''" ||| ::: | 
 +| **''map.buttons.offset_y''**  | Integer  | ''0''  |  | 
 +| Y pixels offset for the display of zoom buttons.  ||| ::: | 
 +| **''map.canvas.popup_comment_size''**  | Float  | ''12.0''  | {{:en:help:v2:settings:user-settings:comment-text-size.jpg?nolink}} | 
 +| Text size ([[https://material.google.com/layout/units-measurements.html#units-measurements-scaleable-pixels-sp|in sp]]) of popup comments when clicking on a displayed landmark.  ||| ::: | 
 +| **''map.canvas.tiles_bitmap_config''**  | [''RGB_565'', ''ARGB_8888'' | ''RGB_565''  |  | 
 +| Image quality (bitmap configuration) used for the map canvas tiles. ARGB_8888 has a better display quality but uses more memory (4 bytes instead of 2 for RGB_565).  ||| ::: | 
 +| **''map.canvas.smooth_end_move''**  | Boolean  | ''1'' / ''true''  |  | 
 +| Define if the map continues to move a little after ending sliding it.  ||| ::: | 
 +| **''map.canvas.heading_size_factor''**  | Float  | ''1.1''  |  | 
 +| Display size factor for the current location heading arrow.  ||| ::: | 
 +| **''map.canvas.display_copyrights''**  | Boolean  | ''1'' / ''true''  |  | 
 +| Display maps data copyright notice on the map.  ||| ::: | 
 +| **''map.canvas.display_center_icon''**  | Boolean  | ''1'' / ''true''  | {{:en:help:v2:settings:user-settings:display_center_icon.jpg?nolink}} | 
 +| Display the screen center icon.  ||| ::: | 
 +| **''map.canvas.center_point.radius''**  | Int  | ''5''  |  | 
 +| Radius ([[https://material.google.com/layout/units-measurements.html#units-measurements-density-independent-pixels-dp|in dp]]) of the screen center icon.  ||| ::: | 
 +| **''map.canvas.display_osm_zoom_id''**  | Boolean  | ''0'' / ''false''  | {{:en:help:v2:settings:user-settings:display-osm-zoom-id.jpg?nolink}} | 
 +| Display the OSM/Google zoom index id in the map scale information box.  ||| ::: | 
 +^ **Maps** ^^^^ 
 +| **''maps.debug''**  | Boolean  | ''0'' / ''false''  |  | 
 +| Activate the debug mode for maps: increases logs for maps and displays map tile bounds and coordinates.  ||| ::: | 
 +| **''maps.explorer.cells_layer_alpha''**  | Float [''0.1'' - ''0.9'' | ''0.5''  |  | 
 +| Alpha value of the white layer displayed over the previews in the Maps Explorer.  ||| ::: | 
 +| **''maps.features.favorites.ask_if_outofbounds''**  | Boolean  | ''0'' / ''false''  |  | 
 +| When selecting a favorite map that doesn't cover the currently displayed area, ask the user to move to a covered area.  ||| ::: | 
 +| **''maps.features.offlinemaps.explorer.display_root''**  | Boolean  | ''0'' / ''false''  | {{:en:help:v2:settings:user-settings:maps-explorer-display-root.jpg?nolink}} | 
 +| Display an entry allowing to select the device's root folder in the menu drawer of the Maps Explorer.  ||| ::: | 
 +^ **Landmarks** ^^^^ 
 +| **''landmarks.painter.icons_factor''**  | Float  | ''1.0''  | {{:en:help:v2:settings:user-settings:icons-display-factor.jpg?nolink}} | 
 +| Display size factor for landmark icons.  ||| ::: | 
 +| **''landmarks.proximity.color''**  | String  | ''#A52A2A''  | {{:en:help:v2:settings:user-settings:proximity-alerts-color.jpg?nolink}} | 
 +| Color used to draw proximity alerts (see accepted colors [[http://html-color-codes.info/#HTML_Color_Picker|here]]).  ||| ::: | 
 +| **''landmarks.explorer.display_full_bearing''**  | Boolean  | ''0'' / ''false''  | {{:en:help:v2:settings:user-settings:landmarks-explorer-display-full-bearing.jpg?nolink}} | 
 +| Display the bearing value to waypoint values in addition of the direction arrow in the Landmarks Explorer.  ||| ::: | 
 +| **''landmarks.creator.sets.ask_for_names''**  | Boolean  | ''1'' / ''true''  |  | 
 +| Ask for waypoint names when creating sets of waypoints.  ||| ::: | 
 +| **''landmarks.features.offlinelandmarks.explorer.display_root''**  | Boolean  | ''0'' / ''false''  | {{:en:help:v2:settings:user-settings:landmarks-explorer-display-root.jpg?nolink}} | 
 +| Display an entry allowing to select the device's root folder in the menu drawer of the Landmarks Explorer.  ||| ::: | 
 +| **''landmarks.features.offlinelandmarks.open_file_auto_choice''**  | [ ''0'', ''1'', ''2'' ]  | ''0''  | {{:en:help:v2:settings:user-settings:open_file_auto_choice.jpg?nolink}} | 
 +| Action to make when opening a landmarks file to import (.gpx, .kml, etc.) from an external file manager: ''0'' (ask the user), ''1'' (browse content), ''2'' (display content).  ||| ::: | 
 +| **''landmarks.features.offlinelandmarks.formats.gpx.export_wgs84_elevations''**  | Boolean  | ''0'' / ''false''  |  | 
 +| Use the WGS84 elevations instead of the EGM96 elevations in exported GPX files.  ||| ::: | 
 +| **''landmarks.features.offlinelandmarks.formats.gpx.export_geoidheight''**  | Boolean  | ''0'' / ''false''  |  | 
 +| Write the "''geoidheight''" tag ([[http://www.topografix.com/GPX/1/1/#type_wptType|see specification here]]) in exported GPX files (the geoid height is the difference in meters between the EGM96 elevation and the WGS84 elevation).  ||| ::: | 
 +| **''landmarks.features.offlinelandmarks.formats.gpx.export_pictures''**  | Boolean  | ''0'' / ''false''  |  | 
 +| Write "''picture''" tags containing the path of pictures associated with waypoints in exported GPX files.  ||| ::: | 
 +| **''landmarks.preprocessing.type''**  | [''0'', ''1'', ''2''  | ''2''  |  | 
 +| Pre-processing type applied to tracks upon loading: ''0'' (no pre-processing), ''1'' (only check erroneous time values), ''2'' (check erroneous times and remove inaccurate points). The pre-processing setting must also be checked in the regular application preferences.  ||| ::: | 
 +| **''landmarks.preprocessing.max_passes''**  | Integer   | ''10''  |  | 
 +| Maximum iterations to make when removing inaccurate points.  ||| ::: | 
 +^ **Localisation** ^^^^ 
 +| **''geolocation.localisation.relock_delay_ms''**  | Integer  | ''10000''  |  | 
 +| Time (in milliseconds) after which to re-lock the GPS location if this option is checked in the main settings.  ||| ::: | 
 +| **''geolocation.localisation.painter.color_accurate''**  | String  | ''#0064FF''  |  | 
 +| Color used to draw the current location when accurate (see accepted colors [[http://html-color-codes.info/#HTML_Color_Picker|here]]).  ||| ::: | 
 +| **''geolocation.localisation.painter.color_inaccurate''**  | String  | ''#E30000''  |  | 
 +| Color used to draw the current location when not accurate (see accepted colors [[http://html-color-codes.info/#HTML_Color_Picker|here]]).  ||| ::: | 
 +| **''geolocation.localisation.egm96_adjustment.[provider]''**  | Boolean  | ''1'' / ''true'' for provider "''gps''", ''0'' / ''false'' otherwise  |  | 
 +| Adjust provided WGS84 elevations to Geoid elevations using the EGM96 model for ''[provider]'' (ex: "''gps''", "''passive''").  ||| ::: |
  
-^  Name  ^  Type  ^  Description  ^  Default value  ^ 
-| **Core** |||| 
-| ''core.logs.verbose''  | Boolean  | Activate the verbose mode for logs to display more information  | ''0'' / ''false''  | 
-| ''core.locale''  | String  | Force a language [ ''en'', ''es'', ''fr'', ''it'', ''ko'' ]  | ''empty''  | 
-| ''core.custom_location_printer''  | [ ''grid'', ''xy'', ''d'', ''dm'', ''dms'' ],String  | Define a custom coordinate format  | ''empty''  | 
-| ''core.bearing_decimals''  | Integer  | Define the number of decimals for bearing units  | ''2''  | 
-| ''core.pictures.format''  | String  | Define how to name picture taken with the application (see accepted patterns [[http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns|here]])  | ''yyyy-MM-dd_HH-mm-ss''  | 
-| **Main map** |||| 
-| ''map.coordinates.main.color''  | String  | Define the display color of the main coordinate format, display and grid (see accepted colors [[http://html-color-codes.info/|here]])  | ''#000000''  | 
-| ''map.coordinates.alternative.color''  | String  | Define the display color of the alternative coordinate format, display and grid (see accepted colors [[http://html-color-codes.info/|here]])  | ''#0000FF''  | 
-| ''map.buttons.offset_y''  | Integer  | Y pixels offset for the display of zoom buttons  | ''0''  | 
-| ''map.open_with.z''  | Integer  | Zoom value passed to Google Maps and Earth when opening a location  | ''17''  | 
-| ''map.canvas.smooth_end_move''  | Boolean  | Define if the map continues to move a little after ending sliding it  | ''1'' / ''true''  | 
-| ''map.canvas.display_center_icon''  | Boolean  | Display the center screen icon  | ''1'' / ''true''  | 
-| ''map.canvas.display_copyrights''  | Boolean  | Display maps data copyright notice on the map  | ''1'' / ''true''  | 
-| ''map.canvas.display_osm_zoom_id''  | Boolean  | Display the OSM/Google equivalent zoom level id with the map scale  | ''0'' / ''false''  | 
-| **Maps** |||| 
-| ''maps.features.areadownloader.max_queue_size''  | Integer  | Maximum tiles to download per session in the store area feature   | ''50000''  | 
-| **Landmarks** |||| 
-| ''landmarks.painter.icons_factor''  | Float  | Display size factor for landmark icons  | ''1.0''  | 
-| ''landmarks.explorer.display_full_bearing''  | Boolean  | Display the full bearing to waypoint values in addition of the direction arrow in the Landmarks Explorer  | ''0'' / ''false''  | 
-| ''landmarks.features.offlinelandmarks .formats.gpx.full_export''  | Boolean  | Write additional custom values in GPX files such as pressure or accuracy values  | ''0'' / ''false''  | 
-| ''landmarks.features.offlinelandmarks .formats.gpx.geoidheight_export''  | Boolean  | Export ''geoidheight'' data in saved GPX files  | ''0'' / ''false''  | 
-| **Localisation** |||| 
-| ''geolocation.localisation.lock_map''  | Boolean  | Re-center the map on the GPS location after 10 seconds without user interactions  | ''1'' / ''true''  | 
-| ''geolocation.localisation .painter.color_accurate''  | String  | Color used to draw the current location when accurate (see accepted colors [[http://html-color-codes.info/|here]])  | ''#0064ff''  | 
-| ''geolocation.localisation .painter.color_inaccurate''  | String  | Color used to draw the current location when not accurate (see accepted colors [[http://html-color-codes.info/|here]])  | ''#e30000''  | 
-| ''geolocation.localisation.egm96_adjustment.[provider]''  | Boolean  | Adjust provided WGS84 elevations to Geoid elevations using the EGM96 model for ''[provider]'' (ex: "''gps''", "''passive''" | ''1'' / ''true'' for provider "''gps''", ''0'' / ''false'' otherwise  | 
  
 ==== Example file ==== ==== Example file ====