GeoMOOSE Configuration Options ============================== Introduction ------------- GeoMOOSE has a plethora of configuration options. All of them can be changed in the mapbook and it is possible to highly customize the interface without writing a single line of code. This document attempts to keep up with the various settings options in order to give the user more control over their GeoMOOSE installation. Organization is a little rocky as it mirrors the internal structure and nothing that was ever designed to be human readable. Please bear with us as the documentation gets updated. How to Change a Setting ----------------------- Every Mapbook has a section. In the section there are multiple fields. The fields are how settings are changed from their defaults. For example, to add some HTML to the Links bar:: ... link to Google!]]> ... The Settings ----------------- links_bar_html ^^^^^^^^^^^^^^ HTML Text. Default is ''. Changes the HTML of the "links bar" formally the "menu bar" in the interface. waiting_html ^^^^^^^^^^^^ HTML Text. Default is 'Loading...'. Changes the HTML of the waiting message while services are running. mapserver_url ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ String. MapServer URL used when calling type="mapserver" map-source's. mapbook ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ String. Default is 'php/getmapbook.php'. The URL to the mapbook, this is the only configuration setting that cannot be changed by the mapbook. fractional_zoom ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Boolean. Default is false. This allows the Map to use fractional scales like GeoMOOSE 1.X. This functionality, however, breaks tiled layers. scales ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Array of Floating Point Numbers. The scales are actually ground units per pixel resolution settings and not true scales. This array is what sets the "scales" shown on the map. max_extent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Array of Floating Point Numbers. An array, in the format of [MinX, MinY, MaxX, MaxY] that sets the maximum extents of the map. You can set this in the mapfile without using the brackets but using commas to delineate the members of the array:: [-180,-90,180,90] initial_extent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Array of Floating Point Numbers. This sets the intial view for the map. projection ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ String. The projection of the map, defaults to UTM-15N (EPSG: 26915). GeoMOOSE is primarily developed in the state of Minnesota, USA, so many of our test datasets are in UTM-15N. The default Projection is this way for no other reason than that. ground_units ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ String. Default is 'm'. Set to 'm', 'in', 'mi', 'dd', to reflect the projection being used. coordinate_display.xy ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Boolean. Default is true. Toggles the display of the ground unit X,Y in the footer of the map. coordinate_display.latlon ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Boolean. Default is true. Toggles the display of the latitude and longitude in the footer of the map. coordinate_display.usng ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Boolean. Default is true. Toggles the display of the United States National Grid Coordinates in the footer of the map. tabs ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Associative Array. The keys of the associative array are the titles of the tabs and the values is the DIV that represent the tab. This would be an example setting that is different than the default:: default_tab ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ String. Defaults to 'Catalog'. References the title of the tab that should be shown by default. catalog_name ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ String. Defaults to 'Catalog'. Reference the title of the tab that should be populated with the layers list. catalog.toggle_controls ^^^^^^^^^^^^^^^^^^^^^^^ Boolean. Defaults to true. When set to true, clicking on the layer name allows the controls below the layer to be turned on or off. When set to false the visibility of the controls is set by catalog.show_controls. catalog.show_controls ^^^^^^^^^^^^^^^^^^^^^ Boolean. Defaults to true. Sets whether or not the controls below the layer names should be visible. show_service_settings_in ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ String. Defaults to 'Services'. Reference the title of the tab that should display the prompts for a service when it is called. group_checkboxes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Boolean. Defaults to true. Toggles whether group checkboxes are displayed. zoomto ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Associative Array of Associative Arrays. This is the settings that populate the "jump to" drop downs. Best to explain this by example. If you have difficulties please email the mailing list:: jumpto_scales ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Associative Array. This associative array features keys that are shown in the "scale drop down" and the scale itself is the value. startup_service ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ String. When set, the named service will be called on startup. layer_controls.up.on ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Boolean. Defaults to true. Toggles the layer control to move the layer up on the image stack. layer_controls.down.on ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Boolean. Defaults to true. Toggles the layer control to move the layer down on the image stack. layer_controls.fade.on ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Boolean. Defaults to true. Toggles the layer control to fade the layer out. layer_controls.unfade.on ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Boolean. Defaults to true. Toggles the layer control to unfade the layer out. layer_controls.refresh.on ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Boolean. Defaults to false. Toggles the layer control to allow the user to manually refresh the layer. layer_controls.cycle.on ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Boolean. Defaults to false. Toggles whether the layer control to refresh the layer every layer_controls.cycle.seconds seconds. layer_controls.cycle.seconds ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Floating Point Number. Defaults to 10. The number of seconds between layer refreshes when used with the cycle tool. layer_controls.legend.on ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Boolean. Defaults to true. Toggles whether to show the legend control by default. layer_controls.metadata.on ^^^^^^^^^^^^^^^^^^^^^^^^^^ Boolean. Defaults to false. Toggles whether or not to show the link to a layer's metadata. reference_map.enabled ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Boolean. Defaults to true. Toggle whether the refrence map should be added to the map. reference_map.maximized ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Boolean. Defaults to true. Toggle whether the reference map is expanded by default. reference_map.width ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Integer. Width of the reference map. reference_map.height ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Integer. Height of the reference map. reference_map.minimum_ratio ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Integer. Minimum ratio of display between the main map and the reference map. reference_map.maximum_ratio ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Integer. Maximum ratio of display between the main map and the reference map. scale_line.enabled ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Boolean. Defaults to true. Toggle whether the scale line is shown on the may. scale_line.top_units ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ String. Defaults to 'ft'. Possible unit values are 'm', 'in', 'km', 'ft', 'mi'. scale_line.bottom_units ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ String. Defaults to 'mi'. Possible unit values are 'm', 'in', 'km', 'ft', 'mi'. scale_line.width ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Integer. Defaults to 200. Defines the width of the scale line on the map. drawing_tools.default_fill ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Color. Defaults to 'green'. Sets the default fill for all sketches. drawing_tools.default_stroke ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Color. Defaults to 'red'. Sets the default stroke for all sketches. drawing_tools.default_opacity ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Floating Point Number between 0 and 1. Defaults to .8. Sets the opacity of the sketches. messages.requirement_failure ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ String. Message displayed when a service requirement was not met. messages.invalid_tool ^^^^^^^^^^^^^^^^^^^^^ String. Displayed when a drawing tool that is not defined is called. The string `%TOOL%` will be replaced with the name of the offending tool. messages.service_config_error ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ String. Is displayed when there is an error with the service being called. messages.service_not_found ^^^^^^^^^^^^^^^^^^^^^^^^^^ String. Message displayed when a service is called but is not defined in the mapbook. The string `%SERVICE%` will be replaced with the name of the invalid service. messages.invalid_response ^^^^^^^^^^^^^^^^^^^^^^^^^ String. Messaged displayed when a service does not return a valid answer from the server. messages.mapbook_version ^^^^^^^^^^^^^^^^^^^^^^^^^ String. Error presented to the user if they try to load a mapbook that is not compliant with the current GeoMOOSE version. The string `%VERSION%` will be replaced with the mapbook's version. messages.mapbook_required ^^^^^^^^^^^^^^^^^^^^^^^^^ String. The error shown when a required setting is missing in the mapbook. The string `%FIELD%` will be replaced with the required field's name. messages.mapbook_param_error ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ String. When a param cannot be properly set due to any sort of error, this error message will be displayed. `%FIELD%` will be replaced with the "name" attribute from the param. popups.autosize ^^^^^^^^^^^^^^^ Boolean. Sets whether or not popups are autosized when added to the map.