This plugin adds Datalayers and Locations to WordPress which can be retrieved via the OpenKaarten REST API.
In order to make the OpenKaarten Plugin work, you will need to have a WordPress installation with at least the following installed (and activated):
On this WordPress installation you will have to enable pretty permalinks (Settings > Permalinks > Select any of the options that is not plain).
There are two possible setups for the OpenKaarten, this can be:
- On the WordPress installation of an existing website.
- On a completely new WordPress installation.
In all scenarios the OpenKaarten needs to have the following installed (and activated):
With this installed you can use the OpenKaarten Base plugin in your WordPress website.
If you chose for option 2 (new WordPress installation), you will probably need to install a WordPress theme. Since the OpenKaarten plugin is a REST API, it can be used in any WordPress theme.
At this point manual installation is not supported, because of composer dependencies. We are working on this.
composer source [email protected]:OpenWebconcept/plugin-openkaarten-base.gitcomposer require acato/openkaarten-basecd /wp-content/plugins/openkaarten-basenpm install && npm run build- Activate the OpenKaarten Base Plugin through the 'Plugins' menu in WordPress.
Datalayers can be imported via the WordPress admin panel. Go to the Datalayers menu, add a New Datalayer and click on the 'Add or Upload file' button. Here you can select a file to import.
The import supports the following file extensions:
- (geo)JSON
- KML
- XML
GeoJSON is the preferred format for importing datalayers.
The import requires the following properties (as stated in the GeoJSON specification):
- type: The type of the datalayer (e.g. 'FeatureCollection').
- features: An array of features.
Each feature requires the following properties (as stated in the GeoJSON specification):
- type: The type of the feature (e.g. 'Feature').
- geometry: The geometry of the feature.
- properties: The properties of the feature.
The geometry requires the following properties (as stated in the GeoJSON specification):
- type: The type of the geometry (e.g. 'Point').
- coordinates: The coordinates of the geometry.
More information about the GeoJSON specification can be found here.
Locations can be added in two ways:
- Via the dayalayer importer described above. When importing a datalayer, the locations will be added to as a location post type and will be connected to the datalayer.
- Manually via the WordPress admin panel. Go to the Locations menu, add a New Location, select a datalayer and fill in the required fields.
After importing a datalayer file, you can create a title mapping and field mapping for the datalayer. The title mapping is used to determine the title of the location post. The field mapping is used to determine the content of the location post. Per field you can also select whether the field should be included in the REST API output for this datalayer.
For each datalayer a Leaflet map will be created and a preview of the map with all the connected locations will be shown in the WordPress admin panel. The map markers can be customized within the datalayer post. First you can create a default marker by selecting a marker color. Additionally, you can create multiple custom marker by selecting the property that should be used to determine the marker color and the marker icon.
The marker icons are SVG icons that are supplied by the OpenGemeenten Iconenset. More information about the icons can be found here.
Datalayers and locations can be deleted via the WordPress admin panel. Go to the Datalayers or Locations menu, hover over the datalayer or location you want to delete and click on the 'Trash' link. If a datalayer is deleted, all connected locations will also be deleted.
Please remember, we use the WordPress PHP Coding Standards for this plugin! (https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/) To check if your changes are compatible with these standards:
cd /wp-content/plugins/openkaarten-basecomposer install(this step is only needed once after installing the plugin)./vendor/bin/phpcs --standard=phpcs.xml.dist .- See the output if you have made any errors.
- Errors marked with
[x]can be fixed automatically by phpcbf, to do so run:./vendor/bin/phpcbf --standard=phpcs.xml.dist .
- Errors marked with
N.B. the composer install command will also install a git hook, preventing you from committing code that isn't compatible with the coding standards.
The plugin uses NPM for managing the JavaScript dependencies and building the leaflet map for showing locations within a datalayer. To install the dependencies, run the following command:
npm install
To deploy the JavaScript files, run the following command:
npm run build
To watch the JavaScript files for changes, run the following command:
npm run watch
wp i18n make-pot . languages/openkaarten-base.pot --exclude="node_modules/,vendor/" --domain="openkaarten-base"
cd languages && wp i18n make-json openkaarten-base-nl_NL.po --no-purge
This plugin adds two custom post types to WordPress:
- Datalayers
- Location
This plugin adds the following REST API GET-endpoints:
/wp-json/owc/openkaarten/v1/wp-json/owc/openkaarten/v1/datasets/wp-json/owc/openkaarten/v1/datasets/id/{id}/wp-json/owc/openkaarten/v1/datasets/id/{id}/{output_format}
Further documentation about using the REST API can be found in the OpenKaarten API documentation.
With the endpoint /wp-json/owc/openkaarten/v1/datasets/id/{id}/{output_format} you can specify an output format for a specific datalayer. The following output formats are supported:
json(default if no output format is specified)geojson
Future formats:
kmlxml
With the endpoint /wp-json/owc/openkaarten/v1/datasets/id/{id}?projection=<projection> you can specify a projection for the output for showing coordinates within a geometry object of a location. The following projections are supported:
wgs84(default if no projection is specified)rd
This plugin is compatible with the following open source projects: