README.txt 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  1. Current for 7.x-2.0-beta1
  2. updated on 2012-08-24
  3. # Description
  4. OpenLayers is a suite of module to help integrate the
  5. OpenLayers Javascript library within Drupal.
  6. # Requirements
  7. OpenLayers Requires
  8. * CTools: http://drupal.org/project/ctools
  9. * Libraries: https://drupal.org/project/libraries - Use the 2.x version, and make sure to create your sites/all/libraries subdirectory.
  10. * GeoPhP https://drupal.org/project/geophp
  11. Sub-modules require
  12. * OpenLayers Views requires Views: http://drupal.org/project/views
  13. OpenLayers can use Features to package maps into modules
  14. * Features: http://drupal.org/project/features
  15. # Sub-Modules
  16. You'll most likely want to enable OpenLayers UI and OpenLayers Views modules for typical uses of OpenLayers.
  17. * OpenLayers UI - Creates a user interface to make map
  18. arrays which can be used in various places
  19. * Views - Allows data to be displayed on a map
  20. via Views
  21. * Filters - Creates a filter to replace
  22. [openlayers map_name] with a map.
  23. # Basic Concepts
  24. ## Maps
  25. An OpenLayers map in Drupal is a combination of decisions about which
  26. layers to show, what styles to apply, the minimum and maximum zoom levels,
  27. and how the user can interact with the map. A map object is where
  28. the options for these settings are combined and stored. Maps can be
  29. rendered through OpenLayers views of the type "OpenLayers Map," through
  30. filters provided by the OpenLayers Filters module, or directly in your
  31. modules using the api function openlayers_render_map()
  32. ## Layers
  33. OpenLayers allows for the display of a variety of raster and vector data on
  34. maps. These are divided into two categories: basemaps and overlays.
  35. Basemaps, like those from OpenStreetMap or Google Maps, provide a background
  36. for your data. Overlays can be data from OpenLayers data views, KML layers,
  37. or other types of data from external sources.
  38. For more information on layer types, see docs/LAYER_TYPES.txt
  39. ## Styles
  40. The OpenLayers module currently allows users to define custom styles for
  41. vector overlays. The primary use-case here will be data from OpenLayers
  42. data views but this could also include KML files. Styles define things like
  43. stroke width, background and outline colors, and point size and allow the
  44. use of icons if desired. They must be associated with layers on a per-
  45. map basis.
  46. ## Behaviors
  47. Behaviors can be enabled on maps to control how users interact with
  48. the map. Examples of behaviors include navigation, which, when enabled,
  49. allows users to zoom and pan, and Layer Switcher, which provides a UI that
  50. allows users to toggle on and off the layers available on the map.
  51. ## OpenLayers Views
  52. OpenLayers views come in two varieties. The first is a display type called
  53. OpenLayers Data. This is what allows users to control which pieces of
  54. content show up on the map and in what manner. Each OpenLayers data view
  55. provides a layer that can be added to maps when configuring a map. The
  56. second is a style called OpenLayers Map that can be applied to pages,
  57. blocks, attachments, and so on and give users an easy way of rendering
  58. maps.
  59. # Installation
  60. 1. Normal Drupal module installation
  61. 2. Set OpenLayers Source at: admin/structure/openlayers
  62. It is suggested to download the library and use it locally for performance.
  63. 3. A tutorial
  64. # Documentation
  65. More documentation is available in the docs/ directory of this module:
  66. * CUSTOMIZATION.txt: a cookbook for common customizations users might want
  67. to make for performance and tweaking
  68. * API.txt: a technical description of the main map-generating API
  69. * LAYER_TYPES.txt: a technical description of how layer types work and
  70. guide for implementation of new layer types
  71. * KML.txt: an explanation of how KML support works in OpenLayers
  72. * JAVASCRIPT.txt: a technical explanation of how the Javascript included
  73. in the OpenLayers module (not the code in the actual OpenLayers library)
  74. operates
  75. A [tutorial is available on Drupal.org] (https://drupal.org/node/1481374)
  76. # Authors/Credits
  77. * [zzolo](http://drupal.org/user/147331)
  78. * [phayes](http://drupal.org/user/47098)
  79. * [tmcw](http://drupal.org/user/12664)
  80. * [brynbellomy](http://drupal.org/user/537416)
  81. * [bdragon](http://drupal.org/user/53081)
  82. * [OpenLayers monster by Saman Bemel Benrud](http://www.flickr.com/photos/samanpwbb/)
  83. * [strk](http://drupal.org/user/781486)
  84. * [pol](https://drupal.org/user/47194)