Differences

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

--- configuration:geographic_features [2023/10/24 11:02] – Remove technical notes on releases 3.x and 4.x. demiankatz
+++ configuration:geographic_features [2023/10/24 19:25] (current) – [General Configuration Notes] lmgonzales
@@ Line 1: / Line 1: @@
 ====== Geographic Features ======
-VuFind contains modules for displaying geographic data at the record level, as well as a geographic search interface.
+VuFind® contains modules for displaying geographic data at the record level, as well as a geographic search interface.
 Features:
@@ Line 11: / Line 11: @@
 To properly configure the Geographic Search & Display modules, you will need to ensure that your data is indexed properly, and then you will need to configure the module options in the associated .ini files.
-This functionality was first introduced in VuFind 3.1; it has subsequently evolved, as described in the [[configuration:geographic_features:changelog|geographic features changelog]].
+This functionality was first introduced in VuFind® 3.1; it has subsequently evolved, as described in the [[configuration:geographic_features:changelog|geographic features changelog]].
 ===== Indexing Geographic Data =====
@@ Line 19: / Line 19: @@
 ==== Coordinates ====
 The coordinate data will go into field 034 of your MARC record, in subfields $d,$e,$f, and $g.
-You can format your coordinates as decimal degrees (DD) or degrees minutes seconds (DMS), and you can assign hemispheres by using either letters (N,S,E,W) or symbols (+,-).
+You can format your coordinates as decimal degrees (DD) or degrees minutes seconds (DMS), and you can assign hemispheres by using either letters (N,S,E,W) or symbols (+,-). If you omit the + sign, it is considered the default.
 Note that the order for coordinates in the [[http://www.loc.gov/marc/bibliographic/concise/bd034.html|MARC 034 field]], is:
 $d: West; $e: East; $f: North; $g: South
-* Note, [[https://github.com/vufind-org/vufind/pull/1076|PR#1076]] upgrades the code to allow for unsigned DD coordinates. With this patch, positive values do not need to be prefixed with the + sign.
+If malformed coordinates are detected during indexing, an error message containing the record ID, coordinate values, and problems with the coordinate values will be displayed. Malformed coordinates will not be included in the indexed record.
-If malformed coordinates are detected during indexing, an error message containing the record ID, coordinate values, and problems with the coordinate values will be displayed. Malformed coordinates will not be indexed.
 ==== Labels ====
@@ Line 51: / Line 49: @@
 ==== Solr fields and files ====
-Starting in VuFind 4.0, the following Solr fields are used store geographic data:
+Starting in VuFind® 4.0, the following Solr fields are used store geographic data:
   * **long_lat**: stores the coordinates as a bounding box field type and you can reference the [[https://solr.apache.org/guide/solr/latest/query-guide/spatial-search.html|Solr Spatial Guide]] for more information on that.
   * **long_lat_display**: used for storing the coordinates that are used in the record's geographic display.
@@ Line 65: / Line 63: @@
 ===== Displaying Geographic Data =====
-Starting with VuFind 5.0, geographic features are displayed with **Leaflet**. For historical information about earlier implementations using OpenLayers and GoogleMaps, click the "Old revisions" button below to find earlier versions of this page.
+==== Underlying Technology ====
+Starting with VuFind® 5.0, geographic features are displayed with **Leaflet**. For historical information about earlier implementations using OpenLayers and GoogleMaps, click the "Old revisions" button below to find earlier versions of this page.
 Leaflet provides a light-weight code base for displaying point and rectangle features, as well as their labels and coordinates.
 Features can be clicked on to show a popup window that will display the label and/or coordinates of that feature depending on how the [MapTab] section is configured in the **geofeatures.ini** file.
-//Notes://
+==== General Configuration Notes ====
-  * The recordMap parameter in geofeatures.ini [MapTab] section has changed from a string to a boolean field in VuFind 5.0 so that it can be used to toggle the Map Tab display on and off.
+  * The recordMap parameter in geofeatures.ini [MapTab] section can be used to toggle the Map Tab display on and off.
   * The basemap is set in the [Basemap] section of geofeatures.ini
@@ Line 89: / Line 89: @@
 Labels can be read from the long_lat_label field if they are stored in Solr, or assigned on the fly with a look-up table. If you use a look-up table, put it in your local/config/vufind/ directory, and in the geofeatures.ini file, set mapLabels = file:filename.
+:!: // Note:  Starting in VuFind® 7.0., the contentsecuritypolicy.ini file was implemented. You will need to modify this file to include the basemap tileserver domain.
+The following is an example if you are using CARTO basemap server:
+//
+<code>
+img-src[] =  "http://basemaps.cartocdn.com"
+</code>
+==== Notes on Map Tiles ====
+Map display depends on access to a tile set to allow zooming and scrolling around the world. The geofeatures.ini file includes some example tile URLs, but tile sets from free providers come with significant limitations on usage. If you wish to use this feature in production, you may need to subscribe to a commercial map provider or else run your own [[configuration:geographic_features:map_tile_server|local tile server]].
+One way to help reduce the amount of map tile server calls is to configure the defaultRecordTab setting in the config.ini file to something other than "Map".
 ===== Geographic Searching =====
@@ Line 102: / Line 114: @@
 If you need help, just click on the **Need Help?** link next to the **Draw Search Box** button.
-The help text for geographic searching has been integrated into the VuFind help system so that the help is easier to maintain for translation purposes.
+The help text for geographic searching has been integrated into the VuFind® help system so that the help is easier to maintain for translation purposes.
-Starting in VuFind 4.0, the geographic search queries against the long_lat field and returns the data from the following fields: long_lat, title, id.
+Starting in VuFind® 4.0, the geographic search queries against the long_lat field and returns the data from the following fields: long_lat, title, id.
 ==== Configurable Options ====
 To turn on the geographic search functionality, uncomment the MapSelection line in the Top Recommendations section of the searches.ini file:
@@ Line 111: / Line 123: @@
 </code>
-=== VuFind 5.0 and Later: ===
+You can set the default search box coordinates and the height of the map search interface in the [MapSelection] section of the **geofeatures.ini** file.
-Set the default search box coordinates and the height of the map search interface in the [MapSelection] section of the **geofeatures.ini** file.
 When setting your default search coordinates, try to focus the search on either an area with the most results or an area of high interest. Don’t make the search area too large or too small. You’ll probably have to play with the search interface to find the right setting.
@@ Line 125: / Line 136: @@
 ; height:    Height in pixels of the map selection interface.
 default_coordinates = "-95, 30, 72, 15"
-height = 320
-</code>
-=== VuFind 3.1 and 4.x: ====
-Set the default search box coordinates and the height of the map search interface in the Map Selection section of the searches.ini file.
-When setting your default search coordinates, try to focus the search on either an area with the most results or an area of high interest. Don’t make the search area too large or too small. You’ll probably have to play with the search interface to find the right setting.
-<code>
-[MapSelection]
-; The default coordinates specified below are in decimal degrees, and are
-; ordered as WENS (west, east, north, south). Ranges of valid values are:
-; -180 to 180 (longitude) and -85 to 85 (latitude). Note, to search from and to
-; the international date line, use west = -179 and east = -180.
-default_coordinates = "-95, 30, 72, 15"
-; height: Height in pixels of the map selection interface.
 height = 320
 </code>
@@ Line 165: / Line 161: @@
 DismaxHandler: edismax
 </code>
-==== Caveats for VuFind 3.1 and 4.x ====
-The following functionality was upgraded in VuFind 5.0. In VuFind 5.0, all geographic features that intersect the search box are plotted. Center points for rectangle features are clustered and clusters, when hovered over show the range of center points contained within the cluster.
-**Clustering of Rectangle Features** \\
-Search results clustering requires that all clustered features be points. As such, the code calculates the center point for each rectangle feature.
-The code goes through several routines to check for rectangle features that intersect the search box, and to check if the center point of those rectangles land within the search box.
-For those rectangles that intersect the search box and have center points that fall outside of the search box, the code sets the rectangles' center points to the center of the search box.
-**Records with Multiple Geographic Features** \\
-For records that have multiple geographic features, only the first feature that falls within the search box is plotted in the search results.
 ===== Customizing the Geographic Search & Display Code =====
@@ Line 231: / Line 215: @@
 ===== Additional Resources =====
-For an overview of these features as they were originally developed for VuFind 3.1, you can [[https://vufind.org/docs/summit2016/geo.pptx|download the presentation slides]] from the [[community:conferences:summit_2016|VuFind 2016 Summit]] for more information.
+For an overview of these features as they were originally developed for VuFind® 3.1, you can [[https://vufind.org/docs/summit2016/geo.pptx|download the presentation slides]] from the [[community:conferences:summit_2016|VuFind® 2016 Summit]] for more information.
 ---- struct data ----