|
1
|
# OpenLayers
|
|
2
|
|
|
3
|
Copyright (c) 2005-2013 OpenLayers Contributors. See authors.txt for
|
|
4
|
more details.
|
|
5
|
|
|
6
|
OpenLayers is a JavaScript library for building map applications
|
|
7
|
on the web. OpenLayers is made available under a BSD-license.
|
|
8
|
Please see license.txt in this distribution for more details.
|
|
9
|
|
|
10
|
## Getting OpenLayers
|
|
11
|
|
|
12
|
OpenLayers lives at http://www.openlayers.org/. Find details on downloading stable releases or the development version the [development site](http://trac.osgeo.org/openlayers/wiki/HowToDownload).
|
|
13
|
|
|
14
|
## Installing OpenLayers
|
|
15
|
|
|
16
|
You can use OpenLayers as-is by copying build/OpenLayers.js and the
|
|
17
|
entire theme/ and img/ directories up to your webserver and putting them
|
|
18
|
in the same directory. The files can be in subdirectories on your website,
|
|
19
|
or right in the root of the site, as in these examples.
|
|
20
|
To include the OpenLayers library in your web page from the root of the site, use:
|
|
21
|
|
|
22
|
<script type="text/javascript" src="/OpenLayers.js" />
|
|
23
|
|
|
24
|
As an example, using bash (with the release files in ~/openlayers):
|
|
25
|
|
|
26
|
$ cd /var/www/html
|
|
27
|
$ cp ~/openlayers/OpenLayers.js ./
|
|
28
|
$ cp -R ~/openlayers/theme ./
|
|
29
|
$ cp -R ~/openlayers/img ./
|
|
30
|
|
|
31
|
If you want to use the multiple-file version of OpenLayers (for, say,
|
|
32
|
debugging or development purposes), copy the lib/ directory up to your
|
|
33
|
webserver in the same directory you put the img/ folder. Then add
|
|
34
|
the following to your web page instead:
|
|
35
|
|
|
36
|
<script type="text/javascript" src="/lib/OpenLayers.js" />
|
|
37
|
|
|
38
|
As an example, using bash (with the release files in ~/openlayers):
|
|
39
|
|
|
40
|
$ cd /var/www/html
|
|
41
|
$ cp -R ~/openlayers/lib ./
|
|
42
|
$ cp -R ~/openlayers/theme ./
|
|
43
|
$ cp -R ~/openlayers/img ./
|
|
44
|
|
|
45
|
## Alternate OpenLayers Versions in this Release
|
|
46
|
|
|
47
|
The following versions of OpenLayers single file builds are included in this release
|
|
48
|
and can be used in place of OpenLayers.js in any of the above instructions:
|
|
49
|
|
|
50
|
1. OpenLayers.js - full build --> Includes everything except the alternate language
|
|
51
|
translations and deprecated classes.
|
|
52
|
2. OpenLayers.mobile.js - a mobile focused build --> Includes a subset of the OpenLayers
|
|
53
|
library to serve common mobile web app use cases. This build provides access to
|
|
54
|
OpenStreetMap, Bing, WMS, WFS and vector layers; touch optimized controls; geolocation;
|
|
55
|
vector editing and interaction tools. The examples tagged ``mobile`` can use this build.
|
|
56
|
3. OpenLayers.light.js - a simple use case focused build --> Includes a subset of the
|
|
57
|
OpenLayers library to serve the basic use case of displaying points and polygons
|
|
58
|
on a map. This build provides access to OpenStreetMap, Bing, Google, WMS, and
|
|
59
|
vector layers; basic map controls; and vector interaction tools. The examples
|
|
60
|
tagged ``light`` can use this build.
|
|
61
|
|
|
62
|
## Using OpenLayers in Your Own Website
|
|
63
|
|
|
64
|
The [examples directory](http://openlayers.org/dev/examples/) is full of useful examples.
|
|
65
|
|
|
66
|
Documentation is available at http://trac.osgeo.org/openlayers/wiki/Documentation.
|
|
67
|
You can generate the API documentation with http://www.naturaldocs.org/
|
|
68
|
As an example, using bash (with the release files in ~/openlayers):
|
|
69
|
|
|
70
|
$ cd ~/openlayers/
|
|
71
|
$ /path/to/NaturalDocs -i lib/ -o HTML doc/ -p doc_config/ -s Default OL
|
|
72
|
|
|
73
|
Information on changes in the API is available in release notes found in the notes folder.
|
|
74
|
|
|
75
|
## Contributing to OpenLayers
|
|
76
|
|
|
77
|
Please join the email lists at http://openlayers.org/mailman/listinfo
|
|
78
|
Patches are welcome!
|
|
79
|
|