Merge pull request #445 from fredj/rename

Rename ol3-cesium to ol-cesium

.gitmodules

@@ -1,6 +1,6 @@
-[submodule "ol3"]
-	path = ol3
-	url = https://github.com/openlayers/ol3.git
+[submodule "ol"]
+	path = ol
+	url = https://github.com/openlayers/openlayers.git
 [submodule "cesium"]
 	path = cesium
 	url = https://github.com/AnalyticalGraphicsInc/cesium.git

.travis.yml

@@ -14,7 +14,7 @@ git:
   submodules: false
 
 before_install:
-  - git submodule update --init ol3
+  - git submodule update --init ol
 
 script:
   - NO_CESIUM=1 make dist

CHANGES.md

@@ -1,5 +1,17 @@
 # Changelog
 
+# v 1.24.1
+
+* Changes
+  * Renamed project to OL-Cesium following the renaming of the OpenLayers3 project.
+    In existing clones, do:
+      git submodule sync
+      git submodule update --recursive --init
+      rm -rf ol3
+      make cleanall
+    Note that the distributed js file is olcesium.js
+
+
 # v 1.24 - 2017-02-17
 
 * Changes

CONTRIBUTING.md

@@ -1,13 +1,13 @@
-# Contributing to Ol3-Cesium
+# Contributing to Ol-Cesium
 
-Thanks for your interest in contributing to Ol3-Cesium.
+Thanks for your interest in contributing to Ol-Cesium.
 
 ## Contributing Code
 
 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-cesium as a developer.
+This page describes what you need to know to contribute code to ol-cesium as a developer.
 
 ## Contributor License Agreement
 
@@ -21,15 +21,15 @@ Contributor License Agreement](https://docs.google.com/spreadsheet/viewform?form
 ## Setting up development environment
 
 You will obviously start by
-[forking](https://github.com/openlayers/ol3-cesium/fork) the ol3-cesium repository.
+[forking](https://github.com/openlayers/ol-cesium/fork) the ol-cesium repository.
 
 ### Cloning the repository
 
 Make sure you clone the repositiory using `git clone --recursive` command.
 
 ## Working with the build tool
 
-As an ol3-cesium developer you will need to use the `make` command in order
+As an ol-cesium developer you will need to use the `make` command in order
 to run the linter, the compiler, the tests, etc.
 
 The targets can be invoked using:
@@ -48,7 +48,7 @@ and [available compilers](https://github.com/google/closure-compiler/wiki/Binary
 
 ## Pull request guidelines
 
-Your pull request should follow the OpenLayers 3 guidelines.
+Your pull request should follow the OpenLayers guidelines.
 
 ### The `check` build target
 
@@ -66,9 +66,9 @@ include:
  * Tests
 
 
-### Follow OpenLayers 3's coding style
+### Follow OpenLayers coding style
 
-The OpenLayers 3's coding style should be followed except as specified below.
+The OpenLayers coding style should be followed except as specified below.
 
 For readablitiy, testing for `undefined` and `null` must be handled as follows:
 

Makefile

@@ -19,7 +19,7 @@ help:
 	@echo
 	@echo "Main targets:"
 	@echo
-	@echo "- dist                    Create a "distribution" for the library (dist/ol3cesium.js)"
+	@echo "- dist                    Create a "distribution" for the library (dist/olcesium.js)"
 	@echo "- check                   Perform a number of checks on the code (lint, compile, etc.)"
 	@echo "- lint                    Check the code with the linter"
 	@echo "- serve                   Run a development web server for running the examples"
@@ -38,7 +38,7 @@ serve: npm-install cesium/Build/Cesium/Cesium.js
 	node build/serve.js
 
 .PHONY: dist
-dist: dist/ol3cesium.js dist/ol3cesium-debug.js CHANGES.md
+dist: dist/olcesium.js dist/olcesium-debug.js CHANGES.md
 	cp CHANGES.md dist/
 
 .PHONY: dist-examples
@@ -53,21 +53,21 @@ lint: .build/node_modules.timestamp .build/eslint.timestamp
 	@build/check-no-goog.sh
 
 .build/geojsonhint.timestamp: $(EXAMPLES_GEOJSON_FILES)
-	$(foreach file,$?, echo $(file); node_modules/geojsonhint/bin/geojsonhint $(file);)
+	$(foreach file,$?, echo $(file); node_modules/.bin/geojsonhint $(file);)
 	touch $@
 
 .PHONY: check
 check: lint dist .build/geojsonhint.timestamp
 
 .PHONY: clean
 clean:
-	rm -f dist/ol3cesium.js
-	rm -f ol3/build/ol.js
-	rm -f ol3/build/ol-debug.js
-	rm -f ol3/build/ol.css
+	rm -f dist/olcesium.js
+	rm -f ol/build/ol.js
+	rm -f ol/build/ol-debug.js
+	rm -f ol/build/ol.css
 	rm -rf cesium/Build/Cesium
 	rm -rf cesium/Build/CesiumUnminified
-	rm -rf dist/ol3
+	rm -rf dist/ol
 	rm -rf dist/examples
 	rm -rf dist/Cesium
 
@@ -85,38 +85,38 @@ cleanall: clean
 	./node_modules/.bin/eslint $?
 	touch $@
 
-.build/dist-examples.timestamp: cesium/Build/Cesium/Cesium.js cesium/Build/CesiumUnminified/Cesium.js dist/ol3cesium.js $(EXAMPLES_JS_FILES) $(EXAMPLES_HTML_FILES)
+.build/dist-examples.timestamp: cesium/Build/Cesium/Cesium.js cesium/Build/CesiumUnminified/Cesium.js dist/olcesium.js $(EXAMPLES_JS_FILES) $(EXAMPLES_HTML_FILES)
 	node build/parse-examples.js
 	mkdir -p $(dir $@)
 	cp -R cesium/Build/Cesium dist/
 	cp -R cesium/Build/CesiumUnminified dist/
 	cp -R examples dist/
-	cp ol3/css/ol.css dist/
-	$(SEDI) 'sYDIST = falseYDIST = trueY' dist/examples/inject_ol3_cesium.js
-	$(SEDI) 'sY@loaderYol3cesium.jsY' dist/examples/inject_ol3_cesium.js
-	$(SEDI) 'sY../cesium/Build/Y../Y' dist/examples/inject_ol3_cesium.js
-	for f in dist/examples/*.html; do $(SEDI) 'sY../ol3/css/ol.cssY../ol.cssY' $$f; done
+	cp ol/css/ol.css dist/
+	$(SEDI) 'sYDIST = falseYDIST = trueY' dist/examples/inject_ol_cesium.js
+	$(SEDI) 'sY@loaderYolcesium.jsY' dist/examples/inject_ol_cesium.js
+	$(SEDI) 'sY../cesium/Build/Y../Y' dist/examples/inject_ol_cesium.js
+	for f in dist/examples/*.html; do $(SEDI) 'sY../ol/css/ol.cssY../ol.cssY' $$f; done
 	touch $@
 
-dist/ol3cesium-debug.js: build/ol3cesium-debug.json $(SRC_JS_FILES) Cesium.externs.js build/build.js npm-install
+dist/olcesium-debug.js: build/olcesium-debug.json $(SRC_JS_FILES) Cesium.externs.js build/build.js npm-install
 	mkdir -p $(dir $@)
 	node build/build.js $< $@
 
 
-ol3/node_modules/rbush/package.json: ol3/package.json
-	(cd ol3 && npm install --production)
+ol/node_modules/rbush/package.json: ol/package.json
+	(cd ol && npm install --production)
 
-ol3/build/ol.ext/rbush.js: ol3/node_modules/rbush/package.json
-	(cd ol3 && node tasks/build-ext.js)
+ol/build/ol.ext/rbush.js: ol/node_modules/rbush/package.json
+	(cd ol && node tasks/build-ext.js)
 
 
 # A sourcemap is prepared, the source is exected to be deployed in 'source' directory
-dist/ol3cesium.js: build/ol3cesium.json $(SRC_JS_FILES) Cesium.externs.js build/build.js npm-install ol3/build/ol.ext/rbush.js
+dist/olcesium.js: build/olcesium.json $(SRC_JS_FILES) Cesium.externs.js build/build.js npm-install ol/build/ol.ext/rbush.js
 	mkdir -p $(dir $@)
 	node build/build.js $< $@
-	$(SEDI) 's!$(shell pwd)/dist!source!g' dist/ol3cesium.js.map
-	$(SEDI) 's!$(shell pwd)!source!g' dist/ol3cesium.js.map
-#	echo '//# sourceMappingURL=ol3cesium.js.map' >> dist/ol3cesium.js
+	$(SEDI) 's!$(shell pwd)/dist!source!g' dist/olcesium.js.map
+	$(SEDI) 's!$(shell pwd)!source!g' dist/olcesium.js.map
+#	echo '//# sourceMappingURL=olcesium.js.map' >> dist/olcesium.js
 #	-ln -s .. dist/source
 
 cesium/node_modules/.bin/gulp: cesium/package.json

README.md

@@ -1,8 +1,8 @@
-OL3-Cesium
+Ol-Cesium
 ==========
 
-OpenLayers - Cesium integration library. Create your map using [OpenLayers 3](http://openlayers.org/), and visualize it on a globe with [Cesium](http://cesiumjs.org).
-See [live examples](http://openlayers.org/ol3-cesium/examples/).
+OpenLayers - Cesium integration library. Create your map using [OpenLayers](http://openlayers.org/), and visualize it on a globe with [Cesium](http://cesiumjs.org).
+See [live examples](http://openlayers.org/ol-cesium/examples/).
 
 Features
 --------
@@ -23,13 +23,13 @@ Stay tuned for more exciting features like animated transitions between map and
 Getting started
 ---------------
 
-To obtain OL3-Cesium, either download a release from https://github.com/openlayers/ol3-cesium/releases, or clone the repository and build it yourself (see below).
+To obtain Ol-Cesium, either download a release from https://github.com/openlayers/ol-cesium/releases, or clone the repository and build it yourself (see below).
 
-Applications using OL3-Cesium also need to load OpenLayers styles and Cesium resources (included in the distribution):
+Applications using Ol-Cesium also need to load OpenLayers styles and Cesium resources (included in the distribution):
 ```html
 <link rel="stylesheet" href="ol.css" type="text/css">
 <script src="Cesium/Cesium.js"></script>
-<script src="ol3cesium.js"></script>
+<script src="olcesium.js"></script>
 ```
 
 An OpenLayers map can be switched to a 3d globe view by running the code below after the map has been created:
@@ -51,25 +51,25 @@ ol3d.setEnabled(true);
 Building the library
 --------------------
 
-Requirements for building OL3-Cesium:
+Requirements for building Ol-Cesium:
 
 * [GNU Make](http://www.gnu.org/software/make/)
 * [Node.js](http://nodejs.org/)
 
-To get started, clone the [OL3-Cesium repository](https://github.com/openlayers/ol3-cesium) with its submodules:
+To get started, clone the [Ol-Cesium repository](https://github.com/openlayers/ol-cesium) with its submodules:
 
-    $ git clone --recursive https://github.com/openlayers/ol3-cesium.git
+    $ git clone --recursive https://github.com/openlayers/ol-cesium.git
 
 Change into the clone directory, and invoke
 
     $ make dist
 
-from the root of the repository. You will then be able to use `dist/ol3cesium.js` for your applications.
+from the root of the repository. You will then be able to use `dist/olcesium.js` for your applications.
 
 Running the examples in debug mode
 ----------------------------------
 
-This is useful for contributing to OL3-Cesium, because it loads the
+This is useful for contributing to Ol-Cesium, because it loads the
 source files instead of a minified build:
 
     $ make serve
@@ -81,17 +81,17 @@ Running the unminified version of Cesium
 
 Passing the parameter `?mode=dev` to an example will load the debug version of
 Cesium instead of the minified one. This is helpful when something breaks inside
-Cesium. In distribution mode, an unminified version of OL3 and OL3-Cesium is
+Cesium. In distribution mode, an unminified version of OpenLayers and Ol-Cesium is
 also loaded.
 
 Limitations
 -----------
 
 OpenLayers unmanaged layers are not discoverable and as a consequence not
 supported. Plain layers should be used instead or the synchronization managed
-manually. See https://github.com/openlayers/ol3-cesium/issues/350.
+manually. See https://github.com/openlayers/ol-cesium/issues/350.
 
 Release process
 ---------------
 
-See [RELEASE.md](https://github.com/openlayers/ol3-cesium/blob/master/RELEASE.md).
+See [RELEASE.md](https://github.com/openlayers/ol-cesium/blob/master/RELEASE.md).

RELEASE.md

@@ -1,17 +1,17 @@
 # Howto create a new release
 
 ## Frequency
-Each month, a new release is published in accordance to https://github.com/openlayers/ol3-cesium/wiki/Versioning-policy.
+Each month, a new release is published in accordance to https://github.com/openlayers/ol-cesium/wiki/Versioning-policy.
 
 ## Steps
-- Update Ol3 and Cesium dependencies to latest stable version
+- Update OpenLayers and Cesium dependencies to latest stable version
 - Check the Cesium CHANGES.md for API changes and update the Cesium externs
 - Compile from scratch and run all tests:
   - `make dist && make check && make dist-examples && make dist-apidoc && make serve`
   - check examples both in development and hosted modes
 - Add the release to github
-  - mentioning in the description the OL3 and Cesium version we compiled with
-  - adding the zip generated by `VERSION=ol3-cesium-v`grep version package.json | cut -f4 -d'"' | cut -d. -f1-2` && cp -R dist/ $VERSION && zip -r $VERSION.zip $VERSION`
+  - mentioning in the description the OpenLayers and Cesium version we compiled with
+  - adding the zip generated by `VERSION=ol-cesium-v`grep version package.json | cut -f4 -d'"' | cut -d. -f1-2` && cp -R dist/ $VERSION && zip -r $VERSION.zip $VERSION`
 - Update npm by calling `npm publish`.
 - Update github.io examples by calling `build/publish-website.sh`
 - Announce the release

build/README.md

@@ -3,10 +3,10 @@ This folder contains resources required for building the library and publishing
 Publishing the website
 ----------------------
 
-The website at http://openlayers.org/ol3-cesium/ is built using GitHub's [Automatic Page Generator](https://github.com/openlayers/ol3-cesium/generated_pages/new), with the Architect theme. The page should be regenerated any time `README.md` changes. Please follow the instructions in the HTML comment block at the top of the content editor when updating the content of the web site.
+The website at http://openlayers.org/ol-cesium/ is built using GitHub's [Automatic Page Generator](https://github.com/openlayers/ol-cesium/generated_pages/new), with the Architect theme. The page should be regenerated any time `README.md` changes. Please follow the instructions in the HTML comment block at the top of the content editor when updating the content of the web site.
 
 To update the distribution artifacts (build, examples, API docs), go to the root of the repository, and invoke
 
     $ build/publish-website.sh
 
-This will build the distribution artifacts and will publish them to the website.
+This will build the distribution artifacts and will publish them to the website.

build/build.js

@@ -105,7 +105,7 @@ function getDependencies(config, exports, callback) {
       callback(err);
       return;
     }
-    log.info('ol3-cesium', 'Parsing dependencies');
+    log.info('ol-cesium', 'Parsing dependencies');
     var options;
     if (config.src) {
       options = {
@@ -163,12 +163,12 @@ function build(config, paths, callback) {
     jvm: config.jvm
   };
   if (!options.compile) {
-    log.info('ol3-cesium', 'No compile options found.  Concatenating ' +
+    log.info('ol-cesium', 'No compile options found.  Concatenating ' +
         paths.length + ' sources');
     concatenate(paths, callback);
   } else {
-    log.info('ol3-cesium', 'Compiling ' + paths.length + ' sources');
-    paths = paths.concat('ol3/src/ol/typedefs.js');
+    log.info('ol-cesium', 'Compiling ' + paths.length + ' sources');
+    paths = paths.concat('ol/src/ol/typedefs.js');
     options.compile.js = paths.concat(options.compile.js || []);
     closure.compile(options, callback);
   }
@@ -183,8 +183,8 @@ function build(config, paths, callback) {
  */
 function addHeader(compiledSource, callback) {
   exec('git describe --tags', function(error, stdout, stderr) {
-    var header = '// Ol3-Cesium. See https://github.com/openlayers/ol3-cesium/\n';
-    header += '// License: https://github.com/openlayers/ol3-cesium/blob/master/LICENSE\n';
+    var header = '// Ol-Cesium. See https://github.com/openlayers/ol-cesium/\n';
+    header += '// License: https://github.com/openlayers/ol-cesium/blob/master/LICENSE\n';
     if (stdout !== '') {
       header += '// Version: ' + stdout + '\n';
     }

build/generate-info.js

@@ -6,7 +6,7 @@ var async = require('async');
 var fse = require('fs-extra');
 var walk = require('walk').walk;
 
-var sourceDirOL = path.join(__dirname, '..', 'ol3', 'src');
+var sourceDirOL = path.join(__dirname, '..', 'ol', 'src');
 var sourceDirSelf = path.join(__dirname, '..', 'src');
 var sourceDirs = [sourceDirOL, sourceDirSelf];
 var infoPath = path.join(__dirname, '..', '.build', 'info.json');

build/jsdoc/api/conf.json

@@ -35,7 +35,7 @@
         "default": {
             "outputSourceFiles": true
         },
-        "applicationName": "OL3-Cesium"
+        "applicationName": "OL-Cesium"
     },
     "jsVersion": 180
 }

build/jsdoc/api/template/tmpl/layout.tmpl

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>OL3-Cesium API Documentation - <?js= title ?></title>
+    <title>OL-Cesium API Documentation - <?js= title ?></title>
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
     <script src="scripts/jquery.min.js"> </script>
@@ -29,4 +29,4 @@
 <script src="scripts/linenumber.js"></script>
 <script src="scripts/main.js"></script>
 </body>
-</html>
+</html>

build/ol3cesium-debug.json → build/olcesium-debug.json

@@ -1,8 +1,8 @@
 {
   "src": [
     "src/**/*.js",
-    "ol3/src/**/*.js",
-    "ol3/build/ol.ext/*.js"
+    "ol/src/**/*.js",
+    "ol/build/ol.ext/*.js"
   ],
   "exports": ["*"]
 }