|
|
1 |
OpenLayers |
|
|
2 |
-=-=-=-=-=- |
|
|
3 |
Copyright (c) 2005-2008 MetaCarta, Inc. |
|
|
4 |
|
|
|
5 |
OpenLayers is a JavaScript library for building map applications |
|
|
6 |
on the web. OpenLayers is made available under a BSD-license. |
|
|
7 |
Please see license.txt in this distribution for more details. |
|
|
8 |
|
|
|
9 |
------------------ |
|
|
10 |
Getting OpenLayers |
|
|
11 |
------------------ |
|
|
12 |
|
|
|
13 |
OpenLayers lives at http://www.openlayers.org/. |
|
|
14 |
|
|
|
15 |
You can get OpenLayers from |
|
|
16 |
http://trac.openlayers.org/wiki/HowToDownload. |
|
|
17 |
|
|
|
18 |
--------------------- |
|
|
19 |
Installing OpenLayers |
|
|
20 |
--------------------- |
|
|
21 |
|
|
|
22 |
You can use OpenLayers as-is by copying build/OpenLayers.js and the |
|
|
23 |
entire theme/ and img/ directories up to your webserver, putting them |
|
|
24 |
in the same directory. The files can be in subdirectories on your website, |
|
|
25 |
or right in the root of the site, as in these examples. |
|
|
26 |
To include the OpenLayers library in your web page from the root of the site, use: |
|
|
27 |
|
|
|
28 |
<script type="text/javascript" src="/OpenLayers.js" /> |
|
|
29 |
|
|
|
30 |
As an example, using bash (with the release files in ~/openlayers ): |
|
|
31 |
$ cd /var/www/html |
|
|
32 |
$ cp ~/openlayers/build/OpenLayers.js ./ |
|
|
33 |
$ cp -R ~/openlayers/theme ./ |
|
|
34 |
$ cp -R ~/openlayers/img ./ |
|
|
35 |
|
|
|
36 |
If you want to use the multiple-file version of OpenLayers (for, say, |
|
|
37 |
debugging or development purposes), copy the lib/ directory up to your |
|
|
38 |
webserver in the same directory you put the img/ folder. Then add |
|
|
39 |
the following to your web page instead: |
|
|
40 |
|
|
|
41 |
<script type="text/javascript" src="/lib/OpenLayers.js" /> |
|
|
42 |
|
|
|
43 |
As an example, using bash (with the release files in ~/openlayers ): |
|
|
44 |
$ cd /var/www/html |
|
|
45 |
$ cp -R ~/openlayers/lib ./ |
|
|
46 |
$ cp -R ~/openlayers/theme ./ |
|
|
47 |
$ cp -R ~/openlayers/img ./ |
|
|
48 |
|
|
|
49 |
|
|
|
50 |
------------------------------------ |
|
|
51 |
Using OpenLayers in Your Own Website |
|
|
52 |
------------------------------------ |
|
|
53 |
|
|
|
54 |
The examples/ directory is full of useful examples. |
|
|
55 |
|
|
|
56 |
Documentation is available at http://trac.openlayers.org/wiki/Documentation. |
|
|
57 |
You can generate the API documentation with http://www.naturaldocs.org/: |
|
|
58 |
As an example, using bash (with the release files in ~/openlayers ): |
|
|
59 |
$ cd ~/openlayers/ |
|
|
60 |
$ /path/to/NaturalDocs -i lib/ -o HTML doc/ -p doc_config/ -s Default OL |
|
|
61 |
|
|
|
62 |
Information on changes in the API is available in news.txt. |
|
|
63 |
|
|
|
64 |
-------------------------- |
|
|
65 |
Contributing to OpenLayers |
|
|
66 |
-------------------------- |
|
|
67 |
|
|
|
68 |
Please join the email lists at http://openlayers.org/mailman/listinfo |
|
|
69 |
Patches are welcome! |
|
|
70 |
|
|
|
71 |
= 30 = |
|
|
72 |
|