Skip to content

Commit

Permalink
consistent geo.okapi spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
DirkThalheim committed Jan 17, 2019
1 parent 0714315 commit 3b7018e
Show file tree
Hide file tree
Showing 9 changed files with 54 additions and 54 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Online Karten API (Geo.OKAPI)
# Online Karten API (geo.okapi)

<span style="color:#ff0000;">**repository currently under construction**</span>

Online Karten API (Geo.OKAPI) is a JavaScript library that encapsulates features for creating interactive maps. It is
**O**nline **K**arten **API** (geo.**okapi**) is a JavaScript library that encapsulates features for creating interactive maps. It is
based on OpenLayers and adds some useful features to this library.

## Getting Started

To use Geo.OKAPI you need the appropriate .js and .css files. Those files are created with the build process as
To use geo.okapi you need the appropriate .js and .css files. Those files are created with the build process as
described [here](doc/develop/01_Getting_Started.md)

[//]: # "TODO: add direct downloaded link"
Expand All @@ -33,8 +33,8 @@ described [here](doc/develop/01_Getting_Started.md)
*okapi.no.libs.min.css*

### External Libraries
If you use the Geo.OKAPI builds without external libraries, you need to include the following in your web site before
including the Geo.OKAPI JavaScript and CSS files:
If you use the geo.okapi builds without external libraries, you need to include the following in your web site before
including the geo.okapi JavaScript and CSS files:

- OpenLayers 4.6.5<br>
Links:<br>
Expand Down
16 changes: 8 additions & 8 deletions config/jsdoc/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Geo.OKAPI
# geo.okapi

Geo.OKAPI is a JavaScript library that encapsulates features for creating interactive maps. It is based on OpenLayers
and adds some useful features to this library. Geo.OKAPI is open source and it is published under the MIT License.
geo.okapi is a JavaScript library that encapsulates features for creating interactive maps. It is based on OpenLayers
and adds some useful features to this library. geo.okapi is open source and it is published under the MIT License.

## Create a simple map
```javascript
Expand All @@ -19,16 +19,16 @@ var map = new okapi.MapBuilder()
.create(); // Create map
```

**NOTE:** The Geo.OKAPI version with all libraries bundled uses a custom version of OpenLayers with only the necessary
**NOTE:** The geo.okapi version with all libraries bundled uses a custom version of OpenLayers with only the necessary
classes included. If you would like to use more OpenLayers classes in your code, you should do the following:

1. Find OpenLayer Version used in Geo.OKAPI:
- Add Geo.OKAPI with all libraries included in a HTML file.
1. Find OpenLayer Version used in geo.okapi:
- Add geo.okapi with all libraries included in a HTML file.
- Open file with browser and start the console.
- Type: *okapi.OPENLAYERS_VERSION*
2. Download the same version of OpenLayers: https://github.com/openlayers/openlayers/releases/
3. At your website use a Geo.OKAPI version without any libraries and add OpenLayers before Geo.OKAPI.
4. Add also the following libraries before Geo.OKAPI:
3. At your website use a geo.okapi version without any libraries and add OpenLayers before geo.okapi.
4. Add also the following libraries before geo.okapi:
- Proj4js 2.5.0 (https://github.com/proj4js/proj4js/releases/tag/2.5.0)
- FileSaver 1.3.8 (https://github.com/eligrey/FileSaver.js/releases/tag/1.3.8)
- SheetJS js-xlsx 0.12.13 (https://github.com/SheetJS/js-xlsx/releases/tag/v0.12.13)
10 changes: 5 additions & 5 deletions doc/develop/01_Getting_Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ To create a development environment you need **node.js** and **npm**: https://no
```bash
# Clone repository
git clone https://github.com/de-bkg/geo.okapi.git
cd geo-okapi
cd geo.okapi

# Install npm packages
# It creates folder node_modules with all packages listed in package.json
Expand All @@ -29,9 +29,9 @@ To explore the examples within the directory of the same name you have to build
A brief description of directories and useful files:

```
geo-okapi
geo.okapi
| package.json # List of packages that the project depends on
| build.js # Configuration for building Geo.OKAPI (used by buildify)
| build.js # Configuration for building geo.okapi (used by buildify)
| .eslintrc.json # Configuration for ESLint
| .gitignore # Ignore files in Git
|
Expand Down Expand Up @@ -63,7 +63,7 @@ geo-okapi
| |
| +---develop # Information about the repository and developing
|
+---examples # Example applications that use Geo.OKAPI
+---examples # Example applications that use geo.okapi
|
+---node_modules # Libraries installed using package.json
|
Expand All @@ -73,7 +73,7 @@ geo-okapi
| |
| +---js # JavaScript source files
| |
| +---schema # Geo.OKAPI config API and persistence schema
| +---schema # geo.okapi config API and persistence schema
|
+---tests # Tests
| |
Expand Down
16 changes: 8 additions & 8 deletions doc/develop/02_Developing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[Back to TOC](README.md)

# Developing Geo.OKAPI
# Developing geo.okapi

## Required Software

Expand All @@ -11,7 +11,7 @@ environment variable.

## Create custom OpenLayers build

Geo.OKAPI uses a custom OpenLayers build with classes defined in file **config/ol/ol-custom.js**.<br/>
geo.okapi uses a custom OpenLayers build with classes defined in file **config/ol/ol-custom.js**.<br/>
If you need to use an OpenLayers class not included in current custom build, then you should add this class in file
ol-custom.js

Expand Down Expand Up @@ -44,34 +44,34 @@ If the compile command does not work check if
`.*\Oracle\Java\javapath`


## Create Geo.OKAPI build
## Create geo.okapi build

All source files should be in folder */src*. JavaScript in *src/js* and CSS in *src/css*.<br/>
Any new files created must be also defined in file **build.js**. Only then, they can be included in build.

```javascript
// JavaScript files of Geo.OKAPI
// JavaScript files of geo.okapi
var jsFiles = [
'src/js/BKGWebMap.js'
...
...
];

// CSS files of Geo.OKAPI
// CSS files of geo.okapi
var cssFiles = [
'src/css/app.css'
...
...
];
```

Create Geo.OKAPI build:
Create geo.okapi build:

```bash
npm run build
```

The above command creates compressed/uncompressed versions of Geo.OKAPI including/not including libraries. All these
The above command creates compressed/uncompressed versions of geo.okapi including/not including libraries. All these
files are located in folder *build/libs*.


Expand All @@ -86,7 +86,7 @@ If you would like to change the first page of jsdoc (index.html) you should edit

## Using examples

Application and code examples can be found within the directory examples. To use the examples the Geo.OKAPI libraries
Application and code examples can be found within the directory examples. To use the examples the geo.okapi libraries
has to be build. The [index](../../examples/index.html) can be used to list all examples. If you want to add a new
example you have to edit examples/resources/default.js:
```javascript
Expand Down
8 changes: 4 additions & 4 deletions doc/develop/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Geo.OKAPI
# geo.okapi

Geo.OKAPI is a JavaScript library that encapsulates features for creating interactive maps. It is based on OpenLayers
geo.okapi is a JavaScript library that encapsulates features for creating interactive maps. It is based on OpenLayers
and adds some useful features to this library.
<br><br>
## Table of contents
- [Getting Started](01_Getting_Started.md)
- Clone repository
- Using Geo.OKAPI
- Using geo.okapi
- Installation for developers
- Directory structure
- [Developing BKG WebMap](02_Developing.md)
- Create custom OpenLayers build
- Create Geo.OKAPI build
- Create geo.okapi build
- Documenting and Linting source code
- [Unit tests](03_Unit_Tests.md)
- Configure unit tests
Expand Down
42 changes: 21 additions & 21 deletions examples/projections.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,27 +83,27 @@
<div id="map"></div>
<div class="criteria">
<ul>
<li><a href="_projections.html?srsname=EPSG:25832">UTM 32</a></li>
<li><a href="_projections.html?srsname=EPSG:25833">UTM 33</a></li>
<li><a href="_projections.html?srsname=EPSG:3857">Pseudo Mercator</a></li>
<li><a href="_projections.html?srsname=EPSG:4326">WGS84</a></li>
<li><a href="_projections.html?srsname=EPSG:4258">Lambert</a></li>
<li><a href="_projections.html?srsname=EPSG:4839">EPSG:4839</a></li> <!-- TODO: WMS 1.3.0 doesn't work -->
<li><a href="_projections.html?srsname=EPSG:31466">GK2</a></li> <!-- TODO: WMS 1.3.0 doesn't work -->
<li><a href="_projections.html?srsname=EPSG:5676">GK2 (EPSG:5676)</a></li>
<li><a href="_projections.html?srsname=EPSG:31467">GK3</a></li> <!-- TODO: WMS 1.3.0 doesn't work -->
<li><a href="_projections.html?srsname=EPSG:5677">GK3 (EPSG:5677)</a></li>
<li><a href="_projections.html?srsname=EPSG:31468">GK4</a></li> <!-- TODO: WMS 1.3.0 doesn't work -->
<li><a href="_projections.html?srsname=EPSG:5678">GK4 (EPSG:5678)</a></li>
<li><a href="_projections.html?srsname=EPSG:31469">GK5</a></li> <!-- TODO: WMS 1.3.0 doesn't work -->
<li><a href="_projections.html?srsname=EPSG:5679">GK5 (EPSG:5679)</a></li>
<li><a href="_projections.html?srsname=EPSG:3034">EPSG:3034</a></li> <!-- TODO: WMS 1.3.0 doesn't work -->
<li><a href="_projections.html?srsname=EPSG:3035">EPSG:3035</a></li>
<li><a href="_projections.html?srsname=EPSG:3044">EPSG:3044</a></li>
<li><a href="_projections.html?srsname=EPSG:3045">EPSG:3045</a></li>
<li><a href="_projections.html?srsname=EPSG:2397">EPSG:2397</a></li>
<li><a href="_projections.html?srsname=EPSG:2398">EPSG:2398</a></li>
<li><a href="_projections.html?srsname=EPSG:2399">EPSG:2399</a></li>
<li><a href="projections.html?srsname=EPSG:25832">UTM 32</a></li>
<li><a href="projections.html?srsname=EPSG:25833">UTM 33</a></li>
<li><a href="projections.html?srsname=EPSG:3857">Pseudo Mercator</a></li>
<li><a href="projections.html?srsname=EPSG:4326">WGS84</a></li>
<li><a href="projections.html?srsname=EPSG:4258">Lambert</a></li>
<li><a href="projections.html?srsname=EPSG:4839">EPSG:4839</a></li> <!-- TODO: WMS 1.3.0 doesn't work -->
<li><a href="projections.html?srsname=EPSG:31466">GK2</a></li> <!-- TODO: WMS 1.3.0 doesn't work -->
<li><a href="projections.html?srsname=EPSG:5676">GK2 (EPSG:5676)</a></li>
<li><a href="projections.html?srsname=EPSG:31467">GK3</a></li> <!-- TODO: WMS 1.3.0 doesn't work -->
<li><a href="projections.html?srsname=EPSG:5677">GK3 (EPSG:5677)</a></li>
<li><a href="projections.html?srsname=EPSG:31468">GK4</a></li> <!-- TODO: WMS 1.3.0 doesn't work -->
<li><a href="projections.html?srsname=EPSG:5678">GK4 (EPSG:5678)</a></li>
<li><a href="projections.html?srsname=EPSG:31469">GK5</a></li> <!-- TODO: WMS 1.3.0 doesn't work -->
<li><a href="projections.html?srsname=EPSG:5679">GK5 (EPSG:5679)</a></li>
<li><a href="projections.html?srsname=EPSG:3034">EPSG:3034</a></li> <!-- TODO: WMS 1.3.0 doesn't work -->
<li><a href="projections.html?srsname=EPSG:3035">EPSG:3035</a></li>
<li><a href="projections.html?srsname=EPSG:3044">EPSG:3044</a></li>
<li><a href="projections.html?srsname=EPSG:3045">EPSG:3045</a></li>
<li><a href="projections.html?srsname=EPSG:2397">EPSG:2397</a></li>
<li><a href="projections.html?srsname=EPSG:2398">EPSG:2398</a></li>
<li><a href="projections.html?srsname=EPSG:2399">EPSG:2399</a></li>
</ul>
</div>

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Geo.OKAPI",
"name": "geo.okapi",
"version": "1.0.0",
"scripts": {
"test": "karma start test/conf/karma.conf.js",
Expand Down
2 changes: 1 addition & 1 deletion src/js/Control/Zoom.js
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ BKGWebMap.Control.createZoom = function () {
ol.extent.extend(extent, layer.extent);
}
});

// TODO: doesn't work with different projections
map.getView().fit(extent, map.getSize());
}

Expand Down
2 changes: 1 addition & 1 deletion src/js/okapi.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Namespace: okapi
*
* The okapi object provides a namespace for all Geo.OKAPI things.
* The okapi object provides a namespace for all geo.okapi things.
*
* <br/>
*
Expand Down

0 comments on commit 3b7018e

Please sign in to comment.