Permalink
Browse files

Remove the '3' from OpenLayers

1 parent ab3d97d commit 7424ee91e3e790d5a3ad84ad0a19588e60091c7b @ahocevar ahocevar committed Jan 2, 2017
Showing with 1,888 additions and 1,888 deletions.
  1. +14 −14 CONTRIBUTING.md
  2. +6 −6 DEVELOPING.md
  3. +6 −6 README.md
  4. +4 −4 bin/example-screenshot.js
  5. +1 −1 bin/loader_hosted_examples.js
  6. +4 −4 changelog/upgrade-notes.md
  7. +219 −219 changelog/v3.1.0.md
  8. +1 −1 changelog/v3.1.1.md
  9. +65 −65 changelog/v3.10.0.md
  10. +1 −1 changelog/v3.10.1.md
  11. +73 −73 changelog/v3.11.0.md
  12. +4 −4 changelog/v3.11.1.md
  13. +4 −4 changelog/v3.11.2.md
  14. +71 −71 changelog/v3.12.0.md
  15. +4 −4 changelog/v3.12.1.md
  16. +68 −68 changelog/v3.13.0.md
  17. +3 −3 changelog/v3.13.1.md
  18. +93 −93 changelog/v3.14.0.md
  19. +3 −3 changelog/v3.14.1.md
  20. +6 −6 changelog/v3.14.2.md
  21. +137 −137 changelog/v3.15.0.md
  22. +2 −2 changelog/v3.15.1.md
  23. +96 −96 changelog/v3.16.0.md
  24. +61 −61 changelog/v3.17.0.md
  25. +2 −2 changelog/v3.17.1.md
  26. +125 −125 changelog/v3.18.0.md
  27. +3 −3 changelog/v3.18.1.md
  28. +2 −2 changelog/v3.18.2.md
  29. +128 −128 changelog/v3.19.0.md
  30. +5 −5 changelog/v3.19.1.md
  31. +73 −73 changelog/v3.2.0.md
  32. +2 −2 changelog/v3.2.1.md
  33. +89 −89 changelog/v3.20.0.md
  34. +3 −3 changelog/v3.20.1.md
  35. +39 −39 changelog/v3.3.0.md
  36. +41 −41 changelog/v3.4.0.md
  37. +131 −131 changelog/v3.5.0.md
  38. +42 −42 changelog/v3.6.0.md
  39. +43 −43 changelog/v3.7.0.md
  40. +33 −33 changelog/v3.8.0.md
  41. +1 −1 changelog/v3.8.1.md
  42. +1 −1 changelog/v3.8.2.md
  43. +66 −66 changelog/v3.9.0.md
  44. +1 −1 config/examples/example.html
  45. +1 −1 config/jsdoc/api/conf.json
  46. +1 −1 config/jsdoc/api/index.md
  47. +1 −1 config/jsdoc/api/template/static/scripts/main.js
  48. +2 −2 config/jsdoc/api/template/tmpl/layout.tmpl
  49. +4 −4 doc/index.hbs
  50. +2 −2 doc/quickstart.hbs
  51. +4 −4 doc/tutorials/browserify.md
  52. +17 −17 doc/tutorials/closure.md
  53. +3 −3 doc/tutorials/concepts.hbs
  54. +17 −17 doc/tutorials/custom-builds.md
  55. +1 −1 doc/tutorials/index.hbs
  56. +1 −1 doc/tutorials/raster-reprojection.md
  57. +2 −2 examples/d3.html
  58. +1 −1 examples/feature-animation.js
  59. +1 −1 examples/feature-move-animation.js
  60. +1 −1 examples/flight-animation.js
  61. +3 −3 examples/index.html
  62. +2 −2 examples/jsts.html
  63. +1 −1 examples/overlay.html
  64. +2 −2 examples/topolis.html
  65. +2 −2 examples/turf.html
  66. +1 −1 examples/wms-no-proj.html
  67. +1 −1 externs/olx.js
  68. +1 −1 externs/readme.md
  69. +3 −3 package.json
  70. +1 −1 src/ol/format/geojson.js
  71. +1 −1 src/ol/format/gpx.js
  72. +4 −4 src/ol/format/readme.md
  73. +1 −1 src/ol/index.js
  74. +3 −3 src/ol/map.js
  75. +1 −1 src/ol/view.js
  76. +2 −2 tasks/build.js
  77. +1 −1 tasks/changelog.sh
  78. +1 −1 tasks/publish.sh
  79. +5 −5 tasks/readme.md
  80. +17 −17 test/spec/ol/format/gpx.test.js
View
@@ -1,17 +1,17 @@
-# Contributing to OpenLayers 3
+# Contributing to OpenLayers
-Thanks for your interest in contributing to OpenLayers 3.
+Thanks for your interest in contributing to OpenLayers.
## Asking Questions
Please ask questions about using the library on [stackoverflow using the tag 'openlayers-3'](http://stackoverflow.com/questions/tagged/openlayers-3).
-When you want to get involved and discuss new features or changes, please use [the mailing list](https://groups.google.com/forum/#!forum/ol3-dev).
+When you want to get involved and discuss new features or changes, please use [the mailing list](https://groups.google.com/forum/#!forum/openlayers-dev).
## Submitting Bug Reports
-Please use the [GitHub issue tracker](https://github.com/openlayers/ol3/issues). Before creating a new issue, do a quick search to see if the problem has been reported already.
+Please use the [GitHub issue tracker](https://github.com/openlayers/openlayers/issues). Before creating a new issue, do a quick search to see if the problem has been reported already.
## Getting Familiar with the Code in the Repository
@@ -21,12 +21,12 @@ Look for `readme.md` files! Several directories contain a `readme.md` file that
## Contributing Code
-See [`DEVELOPING.md`](https://github.com/openlayers/ol3/blob/master/DEVELOPING.md) to learn how to get started developing.
+See [`DEVELOPING.md`](https://github.com/openlayers/openlayers/blob/master/DEVELOPING.md) to learn how to get started developing.
Our preferred means of receiving contributions is through [pull requests](https://help.github.com/articles/using-pull-requests). Make sure
that your pull request follows our pull request guidelines below before submitting it.
-This page describes what you need to know to contribute code to ol3 as a developer.
+This page describes what you need to know to contribute code to OpenLayers as a developer.
## Contributor License Agreement
@@ -45,7 +45,7 @@ Before working on a pull request, create an issue explaining what you want to co
Your pull request must:
- * Follow OpenLayers 3's coding style.
+ * Follow OpenLayers's coding style.
* Pass the integration tests run automatically by the Travis Continuous
Integration system.
@@ -77,9 +77,9 @@ include:
* Tests
-### Follow OpenLayers 3's coding style
+### Follow OpenLayers's coding style
-OpenLayers 3 follows [Google's JavaScript Style
+OpenLayers follows [Google's JavaScript Style
Guide](https://google.github.io/styleguide/javascriptguide.xml).
This is checked using [ESLint](http://eslint.org/), you
can run the linter locally on your machine before committing using the `lint`
@@ -88,7 +88,7 @@ target:
$ make lint
In addition to fixing problems identified by the linter, please also follow the
-style of the existing OpenLayers 3 code, which includes:
+style of the existing OpenLayers code, which includes:
* Always wrap the body of `for`, `if`, and `while` statements in braces.
@@ -114,7 +114,7 @@ http://editorconfig.org/#download) site links to plugins for various editors.
### Pass the integration tests run automatically by the Travis CI system
The integration tests contain a number of automated checks to ensure that the
-code follows the OpenLayers 3 style and does not break tests or examples. You
+code follows the OpenLayers style and does not break tests or examples. You
can run the integration tests locally using the `ci` target:
$ make ci
@@ -199,7 +199,7 @@ Microsoft Visual Studio's javascript debugger may be used to debug the
build/hosted/your-branch/examples. It will be convenient to set
build/hosted/your-branch/examples/index.html as the startup page.
-Your ol3 source tree need not be under the Cygwin root.
-if you checkout to c:/ol3 then you can build under Cygwin at /cygdrive/c/ol3 .
-However, keep the path to the ol3 files short otherwise you may see
+Your OpenLayers source tree need not be under the Cygwin root.
+if you checkout to c:/openlayers then you can build under Cygwin at /cygdrive/c/openlayers .
+However, keep the path to the OpenLayers files short otherwise you may see
`ENAMETOOLONG` errors.
View
@@ -3,7 +3,7 @@
## Setting up development environment
You will obviously start by
-[forking](https://github.com/openlayers/ol3/fork) the ol3 repository.
+[forking](https://github.com/openlayers/openlayers/fork) the OpenLayers repository.
### Travis CI
@@ -33,7 +33,7 @@ To install the Node.js dependencies run
## Working with the build tool
-As an ol3 developer you will use `make` to run build targets defined in the
+As an OpenLayers developer you will use `make` to run build targets defined in the
`Makefile` located at the root of the repository. The `Makefile` includes
targets for running the linter, the compiler, the tests, etc.
@@ -51,7 +51,7 @@ latter is a meta-target that basically runs `lint`, `build`, and `test`.
The `serve` target starts a node-based web server, which we will refer to as the *dev server*. You'll need to start that server for running the examples and the tests in a browser. More information on that further down.
-Other targets include `apidoc` and `ci`. The latter is the target used on Travis CI. See ol3's [Travis configuration file](https://github.com/openlayers/ol3/blob/master/.travis.yml).
+Other targets include `apidoc` and `ci`. The latter is the target used on Travis CI. See OpenLayers's [Travis configuration file](https://github.com/openlayers/openlayers/blob/master/.travis.yml).
## Running the `check` target
@@ -126,11 +126,11 @@ You can use `simple.js` and `simple.html` as templates for new examples.
### Use of the `goog` namespace in examples
-Short story: the ol3 examples should not use the `goog` namespace, except
+Short story: the OpenLayers examples should not use the `goog` namespace, except
for `goog.require`.
-Longer story: we want that the ol3 examples work in multiple modes, with the
+Longer story: we want that the OpenLayers examples work in multiple modes, with the
standalone lib (which has implications of the symbols and properties we
-export), and compiled together with the ol3 library.
+export), and compiled together with the OpenLayers library.
Compiling the examples together with the library makes it mandatory to declare dependencies with `goog.require` statements.
View
@@ -1,16 +1,16 @@
-# OpenLayers 3
+# OpenLayers
-[![Travis CI Status](https://secure.travis-ci.org/openlayers/ol3.svg)](http://travis-ci.org/#!/openlayers/ol3)
-[![Coverage Status](https://coveralls.io/repos/github/openlayers/ol3/badge.svg?branch=master)](https://coveralls.io/github/openlayers/ol3?branch=master)
+[![Travis CI Status](https://secure.travis-ci.org/openlayers/openlayers.svg)](http://travis-ci.org/#!/openlayers/openlayers)
+[![Coverage Status](https://coveralls.io/repos/github/openlayers/openlayers/badge.svg?branch=master)](https://coveralls.io/github/openlayers/openlayers?branch=master)
[![OSGeo Project](https://img.shields.io/badge/OSGeo-Project-brightgreen.svg)](http://osgeo.org/)
-[OpenLayers 3](https://openlayers.org/) is a high-performance, feature-packed library for creating interactive maps on the web. It can display map tiles, vector data and markers loaded from any source on any web page. OpenLayers has been developed to further the use of geographic information of all kinds. It is completely free, Open Source JavaScript, released under the 2-clause BSD License (also known as the FreeBSD).
+[OpenLayers](https://openlayers.org/) is a high-performance, feature-packed library for creating interactive maps on the web. It can display map tiles, vector data and markers loaded from any source on any web page. OpenLayers has been developed to further the use of geographic information of all kinds. It is completely free, Open Source JavaScript, released under the 2-clause BSD License (also known as the FreeBSD).
## Getting Started
- Download the [latest release](https://openlayers.org/download/)
- Install with npm: `npm install openlayers`
-- Clone the repo: `git clone git@github.com:openlayers/ol3.git`
+- Clone the repo: `git clone git@github.com:openlayers/openlayers.git`
## Supported Browsers
@@ -22,7 +22,7 @@ Check out the [hosted examples](https://openlayers.org/en/latest/examples/), the
## Bugs
-Please use the [GitHub issue tracker](https://github.com/openlayers/ol3/issues) for all bugs and feature requests. Before creating a new issue, do a quick search to see if the problem has been reported already.
+Please use the [GitHub issue tracker](https://github.com/openlayers/openlayers/issues) for all bugs and feature requests. Before creating a new issue, do a quick search to see if the problem has been reported already.
## Contributing
@@ -8,16 +8,16 @@
*
* Example usage:
*
- * user@host:~/ol3/bin $ phantomjs example-screenshot.js \
- * http://localhost:8000/ol3/examples/ \
+ * user@host:~/openlayers/bin $ phantomjs example-screenshot.js \
+ * http://localhost:8000/openlayers/examples/ \
* ../examples
*
* The above command will generate `*.png` files in `examples/` for all html
- * files that are served through `http://localhost:8000/ol3/examples/`.
+ * files that are served through `http://localhost:8000/openlayers/examples/`.
*
* So if there is a file `my-humpty-example.html` inside of the relative folder
* `../examples/` which is being served through the webserver so that
- * `http://localhost:8000/ol3/examples/my-humpty-example.html` is a valid and
+ * `http://localhost:8000/openlayers/examples/my-humpty-example.html` is a valid and
* reachable URL, this script will generate a screenshot and store it as
* `my-humpty-example.html.png`.
*
@@ -6,7 +6,7 @@
* loads Closure Library's base.js, ol-deps.js, the example's "goog.require"
* script, and the example's script in "development" mode.
*
- * The ol.js and ol-deps.js scripts are built using ol3's Makefile. They are
+ * The ol.js and ol-deps.js scripts are built using OpenLayers's Makefile. They are
* located in the ../build/ directory, relative to this script.
*
* The script must be named loader.js.
@@ -230,7 +230,7 @@ A number of internal types have been renamed. This will not affect those who us
#### `ol.source.MapQuest` removal
-Because of changes at MapQuest (see: https://lists.openstreetmap.org/pipermail/talk/2016-June/076106.html) we had to remove the MapQuest source for now (see https://github.com/openlayers/ol3/issues/5484 for details).
+Because of changes at MapQuest (see: https://lists.openstreetmap.org/pipermail/talk/2016-June/076106.html) we had to remove the MapQuest source for now (see https://github.com/openlayers/openlayers/issues/5484 for details).
#### `ol.interaction.ModifyEvent` changes
@@ -611,7 +611,7 @@ When single clicking a line or boundary within the `pixelTolerance`, a vertex is
#### `ol.interaction.Draw` changes
* The `minPointsPerRing` config option has been renamed to `minPoints`. It is now also available for linestring drawing, not only for polygons.
-* The `ol.DrawEvent` and `ol.DrawEventType` types were renamed to `ol.interaction.DrawEvent` and `ol.interaction.DrawEventType`. This has an impact on your code only if your code is compiled together with ol3.
+* The `ol.DrawEvent` and `ol.DrawEventType` types were renamed to `ol.interaction.DrawEvent` and `ol.interaction.DrawEventType`. This has an impact on your code only if your code is compiled together with OpenLayers.
#### `ol.tilegrid` changes
@@ -625,7 +625,7 @@ now specify an `extent` instead of `widths`. These settings are used to restrict
#### `ol.Object` and `bindTo`
-* The following experimental methods have been removed from `ol.Object`: `bindTo`, `unbind`, and `unbindAll`. If you want to get notification about `ol.Object` property changes, you can listen for the `'propertychange'` event (e.g. `object.on('propertychange', listener)`). Two-way binding can be set up at the application level using property change listeners. See [#3472](https://github.com/openlayers/ol3/pull/3472) for details on the change.
+* The following experimental methods have been removed from `ol.Object`: `bindTo`, `unbind`, and `unbindAll`. If you want to get notification about `ol.Object` property changes, you can listen for the `'propertychange'` event (e.g. `object.on('propertychange', listener)`). Two-way binding can be set up at the application level using property change listeners. See [#3472](https://github.com/openlayers/openlayers/pull/3472) for details on the change.
* The experimental `ol.dom.Input` component has been removed. If you need to synchronize the state of a dom Input element with an `ol.Object`, this can be accomplished using listeners for change events. For example, you might bind the state of a checkbox type input with a layer's visibility like this:
@@ -778,7 +778,7 @@ There should be nothing special required when upgrading from v3.3.0 to v3.4.0.
### v3.3.0
-* The `ol.events.condition.mouseMove` function was replaced by `ol.events.condition.pointerMove` (see [#3281](https://github.com/openlayers/ol3/pull/3281)). For example, if you use `ol.events.condition.mouseMove` as the condition in a `Select` interaction then you now need to use `ol.events.condition.pointerMove`:
+* The `ol.events.condition.mouseMove` function was replaced by `ol.events.condition.pointerMove` (see [#3281](https://github.com/openlayers/openlayers/pull/3281)). For example, if you use `ol.events.condition.mouseMove` as the condition in a `Select` interaction then you now need to use `ol.events.condition.pointerMove`:
```js
var selectInteraction = new ol.interaction.Select({
Oops, something went wrong.

0 comments on commit 7424ee9

Please sign in to comment.