Merge pull request #177 from Dataport/documentation/improve-package-d…

…escriptions-and-keywords

improve keywords/descriptions in package.json files

packages/clients/afm/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/client-afm",
   "version": "1.0.1",
-  "description": "Client Afm",
+  "description": "POLAR Client AfM. This client has been put together for use in citizen participation platforms and for making applications (referring to legal documents, not executables).",
+  "keywords": ["OpenLayers", "ol", "POLAR", "client"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/clients/dish/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/client-dish",
   "version": "1.1.1",
-  "description": "Client dish",
+  "description": "POLAR Client DISH. This client provides information about monuments in Schleswig-Holstein, Germany.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "client", "DISH", "monument", "memorial"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/clients/generic/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/client-generic",
   "version": "1.0.0",
-  "description": "Client Generic",
+  "description": "POLAR Client Generic. General purpose client with everything plugged in.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "client", "generic"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/clients/meldemichel/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/client-meldemichel",
   "version": "1.1.2",
-  "description": "Client Meldemichel",
+  "description": "POLAR Client Meldemichel. This client aids in crowd-sourcing the detection of Hamburg's infrastructure in need of repair or maintenance.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "client", "Meldemichel", "reporting", "infrastructure"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/clients/snowbox/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/client-snowbox",
   "private": true,
-  "description": "Snow❄️📦box",
+  "description": "Snow❄️📦box (Test Environment)",
+  "keywords": ["OpenLayers", "ol", "POLAR", "client", "Snowbox", "testing"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/clients/textLocator/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/client-text-locator",
   "version": "1.0.0-alpha.0",
-  "description": "Client TextLocator",
+  "description": "POLAR Client TextLocator. This client helps research by connecting geospatial to literature information.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "client", "TextLocator", "AI", "toponyms", "literature"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/components/package.json

@@ -1,6 +1,8 @@
 {
   "name": "@polar/components",
   "version": "2.1.1",
+  "description": "POLAR components package. Provides global components.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "components"],
   "license": "EUPL-1.2",
   "author": "Dataport AöR <[email protected]>",
   "main": "index.ts",

packages/core/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/core",
   "version": "1.4.1",
-  "description": "MapClient Core",
+  "description": "POLAR core package. Provides POALR environment with store setup, localization, UI framework, and other basics.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "core", "base"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/lib/getCluster/package.json

@@ -1,6 +1,8 @@
 {
   "name": "@polar/lib-get-cluster",
   "version": "1.0.0",
+  "description": "Provides a method to retrieve a cluster a feature belongs to.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "lib", "cluster"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/lib/getFeatures/package.json

@@ -1,6 +1,8 @@
 {
   "name": "@polar/lib-get-features",
   "version": "1.0.1",
+  "description": "Provides feature information retrieval for WFS and gazetteers.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "lib", "GFI", "feature information"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/lib/idx/package.json

@@ -1,6 +1,8 @@
 {
   "name": "@polar/lib-idx",
   "version": "1.0.0",
+  "description": "Provides a function to step into objects and fetch whatever.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "lib", "getter"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/lib/invisibleStyle/package.json

@@ -1,6 +1,8 @@
 {
   "name": "@polar/lib-invisible-style",
   "version": "1.0.0",
+  "description": "Provides semantic styling for elements to remove visiblity from them in a detectable fashion that adds programmatic semantics, i.e. whether an element should be considered as visible or not to the user and should hence appear (or be considered) in user interfaces.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "lib", "visiblity", "filter"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/lib/passesBoundaryCheck/package.json

@@ -1,6 +1,8 @@
 {
   "name": "@polar/lib-passes-boundary-check",
   "version": "2.0.0",
+  "description": "Provides a check function for whether something is in (potentially asynchronously available) boundaries.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "lib", "boundary"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/lib/testMountParameters/package.json

@@ -1,6 +1,8 @@
 {
   "name": "@polar/lib-test-mount-parameters",
   "version": "1.2.1",
+  "description": "Internal initialization parameters for testing framework in POLAR.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "lib", "testing"],
   "license": "EUPL-1.2",
   "author": "Dataport AöR <[email protected]>",
   "main": "index.ts",

packages/lib/tooltip/package.json

@@ -1,6 +1,8 @@
 {
   "name": "@polar/lib-tooltip",
   "version": "1.0.0",
+  "description": "Tooltip lib that provides localizable and stylable information on hovering map elements in POLAR.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "lib", "tooltip"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/plugins/AddressSearch/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/plugin-address-search",
   "version": "1.2.1",
-  "description": "Plugin AddressSearch",
+  "description": "AddressSearch plugin for POLAR that adds a user interface to search for various kinds of textual information to map it to a geometry; e.g. parcel numbers or addresses, but any kind of toponym mapping is possible.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "plugin", "AddressSearch", "parcel", "address", "search"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/plugins/Attributions/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/plugin-attributions",
   "version": "1.2.1",
-  "description": "Displays the Attributions of the Map",
+  "description": "Attributions plugin for POLAR that adds copyright information regarding all currently active layers. Additionally, static information can be added.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "plugin", "Attributions", "copyright"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/plugins/Draw/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/plugin-draw",
   "version": "1.1.0",
-  "description": "Plugin Draw",
+  "description": "Draw plugin for POLAR that adds draw interactions to the map, allowing users to place various shapes and texts.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "plugin", "Draw", "interaction"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/plugins/Export/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/plugin-export",
   "version": "1.2.0",
-  "description": "Export the map in several formats",
+  "description": "Export plugin for POLAR that adds export functionality in various formats to retrieve a screenshot-like graphic of the map without the buttons.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "plugin", "Export", "PDF", "PNG", "JPG", "screenshot"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/plugins/Filter/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/plugin-filter",
   "version": "1.1.2",
-  "description": "Plugin Filter",
+  "description": "Filter plugin for POLAR that adds filter functionality to vector-data based layers.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "plugin", "Filter"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/plugins/Fullscreen/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/plugin-fullscreen",
   "version": "1.2.1",
-  "description": "Plugin Fullscreen",
+  "description": "Fullscreen plugin for POLAR that adds a fullscreen button.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "plugin", "Fullscreen"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/plugins/GeoLocation/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/plugin-geo-location",
   "version": "1.3.1",
-  "description": "Plugin GeoLocation",
+  "description": "GeoLocation plugin for POLAR that adds geographic user detection if the user so allows. The user position is indicated with a marker.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "plugin", "GeoLocation", "position"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/plugins/Gfi/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/plugin-gfi",
   "version": "1.2.2",
-  "description": "Plugin Gfi",
+  "description": "Gfi plugin for POLAR that adds feature information retrieval. UI elements can be provided by configuration, else it works as a store integration.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "plugin", "gfi", "feature information"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/plugins/IconMenu/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/plugin-icon-menu",
   "version": "1.2.0",
-  "description": "Plugin IconMenu",
+  "description": "IconMenu plugin for POLAR that adds a menu that may provide various plugins' functionality as openable menu points.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "plugin", "icon menu", "menu"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/plugins/LayerChooser/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/plugin-layer-chooser",
   "version": "1.2.0",
-  "description": "Plugin LayerChooser",
+  "description": "LayerChooser plugin for POLAR that adds a layer selection and configuration UI element for both backgrounds and overlays.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "plugin", "LayerChooser", "layer"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/plugins/Legend/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/plugin-legend",
   "version": "1.1.0",
-  "description": "Plugin Legend",
+  "description": "Legend plugin for POLAR that adds a simple legend overview referring to the services' provided infographics.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "plugin", "legend", "infographic"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/plugins/LoadingIndicator/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/plugin-loading-indicator",
   "version": "1.1.0",
-  "description": "Plugin LoadingIndicator",
+  "description": "LoadingIndicator plugin for POLAR that adds a configurable element to indicate something is loading.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "plugin", "loading indicator"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/plugins/Pins/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/plugin-pins",
   "version": "1.3.1",
-  "description": "Plugin Pins",
+  "description": "Pins plugin for POLAR that adds map interactions to client that allow users to indicate a specific point on the map.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "plugin", "pin", "coordinate"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/plugins/ReverseGeocoder/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/plugin-reverse-geocoder",
   "version": "1.2.0",
-  "description": "Plugin Reverse Geocoder",
+  "description": "ReverseGeocoder plugin for POLAR that adds a ui-less reverse geocoding mechanism that can be adresses via store interactions.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "plugin", "reverse geocoder"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/plugins/Scale/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/plugin-scale",
   "version": "1.1.0",
-  "description": "Plugin Scale",
+  "description": "Scale plugin for POLAR that adds a resolution display to the client.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "plugin", "scale"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/plugins/Toast/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/plugin-toast",
   "version": "1.1.0",
-  "description": "Plugin Toast",
+  "description": "Toast plugin for POLAR that adds toast elements (notification popups) to the client.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "plugin", "toast", "notification", "popup"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/plugins/Zoom/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@polar/plugin-zoom",
   "version": "1.2.0",
-  "description": "Plugin Zoom",
+  "description": "Zoom plugin for POLAR that adds zoom functionality via UI and store.",
+  "keywords": ["OpenLayers", "ol", "POLAR", "plugin", "zoom"],
   "license": "EUPL-1.2",
   "type": "module",
   "author": "Dataport AöR <[email protected]>",

packages/types/custom/package.json

@@ -1,6 +1,8 @@
 {
   "name": "@polar/lib-custom-types",
   "version": "1.4.1",
+  "description": "global type package for overarching types in POLAR",
+  "keywords": ["OpenLayers", "ol", "POLAR", "types"],
   "license": "EUPL-1.2",
   "author": "Dataport AöR <[email protected]>",
   "main": "index.ts",