Go to file

Tim Schaub f115c7a943 Use commit hash instead of (mock) svn rev.

When we upgraded to git, we didn't fully change over the way the website and examples are built.  The cron job that runs the update script only built the website & examples if the revision returned by the svn interface to the GitHub repo was different than the previously stored revision.  At some point, using `svn info` on the repo stopped being reliable.  For example, this is what I get when running this today (in 2012):

    svn info https://github.com/openlayers/openlayers/

    Path: openlayers
    URL: https://github.com/openlayers/openlayers
    Repository Root: https://github.com/openlayers/openlayers
    Repository UUID: d631b94f-4ba7-6298-eb8f-ce57b7db7bff
    Revision: 5488
    Node Kind: directory
    Last Changed Author: schuyler.erle
    Last Changed Rev: 5488
    Last Changed Date: 2006-05-12 12:35:22 -0700 (Fri, 12 May 2006)

(Last change looks like it was 6 years ago.)

We should be using a proper clone of the git repo and building the website and examples out of this.  Until then, we can at least use `git-ls-remote` to check what the latest HEAD from the canonical repo looks like.  This should get the website and examples building again (they stopped being updated a few weeks ago).

2012-05-09 19:48:51 -06:00

apidoc_config

Move NG renderer to deprecated.js

2012-03-14 09:17:42 +01:00

art

Unmixing line endings. No functional change.

2009-03-12 20:04:34 +00:00

build

Remove "firebug" on the tests.cfg

2012-04-28 18:33:22 +02:00

doc_config

Move NG renderer to deprecated.js

2012-03-14 09:17:42 +01:00

examples

examples/cartodb-geojson.html: kill long lines, use local OpenLayers.js

2012-05-07 13:06:14 +02:00

img

Update popup image to fix slight sizing issue (See #3413 ); thx jorix

2011-08-08 13:57:44 +00:00

lib

Adding missing dependency. Non-functional change.

2012-05-09 11:03:57 +02:00

licenses

move the licenses dir to the root of the repo

2012-03-29 21:59:58 +02:00

notes

Add a bit to the release notes about dotless identifiers.

2012-04-23 19:25:39 -04:00

tests

Merge branch '2.12'

2012-05-02 17:11:37 +02:00

theme/default

class name olLayerGridTile renamed olLayerGrid

2012-04-03 06:28:06 +02:00

tools

Use commit hash instead of (mock) svn rev.

2012-05-09 19:48:51 -06:00

.gitignore

Add example-lists to gitignore

2012-01-22 21:40:55 +00:00

authors.txt

move authors.txt to the root of the repo

2012-03-29 21:58:54 +02:00

license.txt

remove any reference to svn.openlayers.org from license.txt

2012-03-29 22:00:56 +02:00

readme.md

correct typo in readme

2012-03-13 00:07:18 -05:00

readme.md

OpenLayers

OpenLayers is a JavaScript library for building map applications on the web. OpenLayers is made available under a BSD-license. Please see license.txt in this distribution for more details.

Getting OpenLayers

OpenLayers lives at http://www.openlayers.org/. Find details on downloading stable releases or the development version the development site.

Installing OpenLayers

You can use OpenLayers as-is by copying build/OpenLayers.js and the entire theme/ and img/ directories up to your webserver and putting them in the same directory. The files can be in subdirectories on your website, or right in the root of the site, as in these examples. To include the OpenLayers library in your web page from the root of the site, use:

<script type="text/javascript" src="/OpenLayers.js" />

As an example, using bash (with the release files in ~/openlayers):

$ cd /var/www/html
$ cp ~/openlayers/OpenLayers.js ./
$ cp -R ~/openlayers/theme ./
$ cp -R ~/openlayers/img ./

If you want to use the multiple-file version of OpenLayers (for, say, debugging or development purposes), copy the lib/ directory up to your webserver in the same directory you put the img/ folder. Then add the following to your web page instead:

<script type="text/javascript" src="/lib/OpenLayers.js" />

As an example, using bash (with the release files in ~/openlayers):

$ cd /var/www/html
$ cp -R ~/openlayers/lib ./
$ cp -R ~/openlayers/theme ./
$ cp -R ~/openlayers/img ./

Alternate OpenLayers Versions in this Release

The following versions of OpenLayers single file builds are included in this release and can be used in place of OpenLayers.js in any of the above instructions:

OpenLayers.js - full build --> Includes everything except the alternate language translations and deprecated classes.
OpenLayers.mobile.js - a mobile focused build --> Includes a subset of the OpenLayers library to serve common mobile web app use cases. This build provides access to OpenStreetMap, Bing, WMS, WFS and vector layers; touch optimized controls; geolocation; vector editing and interaction tools. The examples tagged mobile can use this build.
OpenLayers.light.js - a simple use case focused build --> Includes a subset of the OpenLayers library to serve the basic use case of displaying points and polygons on a map. This build provides access to OpenStreetMap, Bing, Google, WMS, and vector layers; basic map controls; and vector interaction tools. The examples tagged light can use this build.

Using OpenLayers in Your Own Website

The examples directory is full of useful examples.

Documentation is available at http://trac.osgeo.org/openlayers/wiki/Documentation. You can generate the API documentation with http://www.naturaldocs.org/ As an example, using bash (with the release files in ~/openlayers):

$ cd ~/openlayers/
$ /path/to/NaturalDocs -i lib/ -o HTML doc/ -p doc_config/ -s Default OL

Information on changes in the API is available in release notes found in the notes folder.

Contributing to OpenLayers

Please join the email lists at http://openlayers.org/mailman/listinfo Patches are welcome!