Update dashes in tables to single dashes

Dataport · Jul 31, 2024 · 6e6688c · 6e6688c
1 parent bef7977
commit 6e6688c
Show file tree

Hide file tree

Showing 15 changed files with 43 additions and 43 deletions.
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -70,7 +70,7 @@ MapClient.createMap({
 The mapConfiguration allows controlling many client instance details.
 
 | fieldName | type | description |
-| --------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| - | - | - |
 | layerConf | LayerConf | Layer configuration as required by masterportalAPI. |
 | language | enum["de", "en"] | Initial language. |
 | <...masterportalAPI.fields> | various | The object is also used to initialize the masterportalAPI. Please refer to their documentation for options. |
@@ -138,7 +138,7 @@ To figure out the name of the locales to override, inspect the matching plugin i
 A full documentation of the masterportalapiPolygonFillHatch is available at the Masterportal's documentation file [style.json.md](https://bitbucket.org/geowerkstatt-hamburg/masterportal/src/dev/doc/style.json.md), chapter 'Polygon.polygonFillHatch'. The basic usage is quoted below for quick lookup. For more details, visual examples, and expert features, see there.
 
 >|Name|Required|Type|Default|Description|
->|----|--------|----|-------|-----------|
+>| - | - | - | - | - |
 >|pattern|no|enum["diagonal", "diagonal-right", "zig-line", "zig-line-horizontal", "circle", "rectangle", "triangle", "diamond"]/Object|`"diagonal"`|Draw pattern. You may either use a pre-defined pattern from the enum or specify one yourself.|
 >|size|no|Number|`30`|Edge length of a singular repeated pattern element.|
 >|lineWidth|no|Number|`10`|Line width of drawn pattern. To achieve an even distribution in diagonal and zig-line pattern, choose lineWidth as (1/3 * size). For triangle and diamond, a lineWidth of 1 must be chosen. For rectangle, a lineWidth of at most (1/4 * size) should be chosen. Deviating from these rules is not harmful, but patterns may seem off.|
@@ -189,7 +189,7 @@ Since this is the base for many functions, the service ID set in this is used to
 The `<...masterportalAPI.fields>` means that any masterportalAPI field may also be used here _directly_. The most common fields are the following ones; for more, see masterportalAPI.
 
 | fieldName        | type     | description                                                                                                               |
-| ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------- |
+| - | - | - |
 | startResolution  | number   | Initial resolution; must be in options. See below.                                                                        |
 | startCenter      | number[] | Initial center coordinate.                                                                                                |
 | extent           | number[] | Map movement will be restricted to this rectangle.                                                                        |
@@ -211,8 +211,8 @@ On how to configure a plugin, see the respective plugin. The configuration is gi
 
 Most plugins honor this additional field.
 
-| fieldName        | type    | description                                                                                                                                                                                                                                               |
-| ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| fieldName | type | description |
+| - | - | - |
 | displayComponent | boolean? | Optional field that allows hiding UI elements from the user. The store will still be initialized, allowing you to add your own UI elements and control the plugin's functionality via the Store. This may or may not make sense, depending on the plugin. Defaults to `false` , meaning the default UI is hidden. |
 
 ##### mapConfiguration.vuetify

diff --git a/packages/lib/testMountParameters/README.md b/packages/lib/testMountParameters/README.md
@@ -1,4 +1,4 @@
 # createTestMountParameters
 
-This is a helper function for vue testing. It returns fresh `MockParameters`, including a `localVue`, `vuetify`, and `vuex` instance, the latter copying the basic `core` store structure, i.e., having an empty namespaced `plugin` module. 
+This is a helper function for vue testing. It returns fresh `MockParameters`, including a `localVue`, `vuetify`, and `vuex` instance, the latter copying the basic `core` store structure, i.e., having an empty namespaced `plugin` module.   
 This is mostly done to avoid boilerplate code. For regularly used test contents, feel free to extend the returned contents.
diff --git a/packages/plugins/AddressSearch/README.md b/packages/plugins/AddressSearch/README.md
@@ -23,7 +23,7 @@ It is advised to either use one-search-per-group _or_ all services in a singular
 In `categoryProperties` and `groupProperties`, id strings called `groupId` and `categoryId` are used. These are arbitrary strings you can introduce and reuse to group or categorize elements together. Regarding what groups and categories are, see further below.
 
 | fieldName | type | description |
-| ------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| - | - | - |
 | searchMethods | searchMethodsObject[] | Array of search method descriptions. Only searches configured here can be used. |
 | afterResultComponent | VueConstructor? | If given, this component will be rendered in the last line of every single search result. It will be forwarded its search result feature as prop `feature` of type `GeoJSON.Feature`, and the focus state of the result as prop `focus` of type `boolean`. |
 | addLoading | string? | Optional loading action name to start loading. |
@@ -39,7 +39,7 @@ In `categoryProperties` and `groupProperties`, id strings called `groupId` and `
 #### addressSearch.searchMethodsObject
 
 | fieldName | type | description |
-| --------------- | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| - | - | - |
 | type | enum["bkg", "gazetteer", "wfs", "mpapi"] | Service type. Enum can be extended by configuration, see `addressSearch.customSearchMethods`. ⚠️ "gazetteer" is deprecated. Please use "mpapi" instead. |
 | url | string | Search service URL. Should you require a service provider, please contact us for further information. |
 | categoryId | string? | Grouped services can optionally be distinguished in the UI with categories. See `addressSearch.categoryProperties` for configuration options. |
@@ -88,7 +88,7 @@ With this, arbitrary click results can be supported. Please mind that undocument
 #### addressSearch.groupProperties
 
 | fieldName | type | description |
-| ----------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| - | - | - |
 | label | string | Display label. Can be a locale key. |
 | resultDisplayMode | enum['mixed', 'categorized'] | Defaults to `'mixed'`. In `'mixed'`, results of all requested services are offered in a list in no specific order. In `'categorized'`, the results are listed by their searchService's categoryId. |
 | hint | string? | Hint that is displayed below the input field if no other plugin-state-based hint is to be displayed. Can be a locale key. |
@@ -98,21 +98,21 @@ With this, arbitrary click results can be supported. Please mind that undocument
 #### addressSearch.categoryProperties
 
 | fieldName | type | description |
-| --------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| - | - | - |
 | label | string | Category label to display next to results to identify the source. Can be a locale key. Only relevant if the search's `groupProperties` linked via `groupId` contain a `resultDisplayMode` scenario that uses categories. |
 
 ##### addressSearch.searchMethodsObject.queryParameters (type:common)
 
 These fields are interpreted by all implemented services.
 
 | fieldName | type | description |
-| ----------- | ------ | --------------------------------------- |
+| - | - | - |
 | maxFeatures | number? | Maximum amount of features to retrieve. Doesn't limit results if not set. |
 
 ##### addressSearch.searchMethodsObject.queryParameters (type:wfs)
 
 | fieldName | type | description |
-| ------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| - | - | - |
 | featurePrefix | string | XML feature prefix for WFS service. |
 | typeName | string | Feature type to search for by name. |
 | xmlns | string | XML namespace to use in search. |
@@ -129,7 +129,7 @@ Since inputs may overlap with multiple patterns, multiple queries are fired and
 > ⚠️ "gazetteer" is deprecated. Please use "mpapi" instead.
 
 | fieldName | type | description |
-| ------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
+| - | - | - |
 | epsg | `EPSG:${string}` | EPSG code of the projection to use. |
 | fieldName | string[] | Field names of service to search in. |
 | memberSuffix | string | Elements to interpret are fetched from response XML as `wfs:memberSuffix`; fitting suffix must be configured. |
@@ -142,7 +142,7 @@ Since inputs may overlap with multiple patterns, multiple queries are fired and
 > **Please mind that this requires a configured backend. A WFS's Stored Query is requested with predefined parameters using the [masterportalApi](https://bitbucket.org/geowerkstatt-hamburg/masterportalapi/src/master/). This implementation is meant for e.g. https://geodienste.hamburg.de/HH_WFS_GAGES, but works with other WFS configured in the same manner.**
 
 | fieldName | Type | Description |
-| ------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| - | - | - |
 | searchAddress | Boolean? | Defines whether address search is active. For backward compatibility, if "searchAddress" is not configured, the "searchAddress" attribute is set to "true" when "searchStreets" and "searchHouseNumbers" are set to "true". |
 | searchDistricts | Boolean? | Defines whether district search is active. |
 | searchHouseNumbers | Boolean? | Defines whether house numbers should be searched for. Requires `searchStreets` to be set to `true`, too. |
@@ -194,7 +194,7 @@ map.$store.dispatch('plugin/addressSearch/search', {
 The payload object supports the following fields:
 
 | fieldName | type | description |
-| ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| - | - | - |
 | input | string | Search string to be used. |
 | autoselect | enum['first', 'only', 'never'] | By default, 'never' is selected, and results will be presented as if the user searched for them. Setting 'only' will autoselect if a single result was returned; setting 'first' will autoselect the first of an arbitrary amount of results >=1. |
 

diff --git a/packages/plugins/Attributions/README.md b/packages/plugins/Attributions/README.md
@@ -11,7 +11,7 @@ This plugin shows attributions (that is, legal information) regarding copyrights
 All parameters are optional. However, setting neither `layerAttributions` nor `staticAttributions` results in an empty window.
 
 | fieldName | type | description |
-| ------------------ | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| - | - | - |
 | initiallyOpen | boolean? | Whether the information box is open by default. Only usable when renderType is set to 'independent', otherwise the IconMenu handles this. |
 | layerAttributions | layerAttribution[]? | List of attributions that are shown when the matching layer is visible. |
 | listenToChanges | string[]? | Store variable paths to listen to for changes. Will update the currently visible layers depending on the current map state on changes to these values. Please mind that, when referencing another plugin, that plugin must be in `addPlugins` before this one. |
@@ -22,6 +22,6 @@ All parameters are optional. However, setting neither `layerAttributions` nor `s
 #### attributions.layerAttribution
 
 | fieldName | type | description |
-| --------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| - | - | - |
 | id | string | ID of service the attribution relates to. The text will only be shown when the layer is visible. |
 | title | string | Attribution text or localization key. May contain HTML. The tags `<YEAR>` and `<MONTH>` are translated to the current year or month respectively. |
diff --git a/packages/plugins/Draw/README.md b/packages/plugins/Draw/README.md
@@ -32,22 +32,22 @@ The styling of the drawn features can be configured to overwrite the default ol-
 ### draw
 
 | fieldName | type | description |
-| ------------------- | -------- | ---------------------------------------------------------------------------- |
+| - | - | - |
 | selectableDrawModes | string[]? | List 'Point', 'LineString', 'Circle', 'Text' and/or 'Polygon' as desired. All besides 'Text' are selectable by default. |
 | style | style? | Please see example below for styling options. Defaults to standard OpenLayers styling. |
 | textStyle | object? | Use this object with properties 'font' and 'textColor' to style text feature. |
 
 ##### draw.textStyle
 
 | fieldName | type | description |
-| --------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------- |
+| - | - | - |
 | font | object \| string | Style the font of the text feature with either css font properties or use font as an object with properties 'size' and 'family'. |
 | textColor | string? | Define text color in hex or rgb / rgba code. |
 
 ##### draw.textStyle.font
 
 | fieldName | type | description |
-| --------- | -------- | ----------------------------------------------------------------------------------- |
+| - | - | - |
 | family | string? | Font family. |
 | size | number[]? | Array with numbers that define the available text sizes that a user can choose from |
 

diff --git a/packages/plugins/Export/README.md b/packages/plugins/Export/README.md
@@ -9,7 +9,7 @@ The Export plugin offers users to download the currently visible map canvas in a
 ### export
 
 | fieldName | type | description |
-| --------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| - | - | - |
 | download | boolean? | Whether file is offered for download. By default, no download will happen, and the using service is supposed to register whether a "screenshot" has been taken and react accordingly. |
 | showJpg | boolean? | Tools offers current map view as JPG. Defaults to `true`. |
 | showPdf | boolean? | Tools offers current map view as PDF. Defaults to `true`. |

diff --git a/packages/plugins/Fullscreen/README.md b/packages/plugins/Fullscreen/README.md
@@ -9,7 +9,7 @@ The fullscreen plugin allows viewing the map in fullscreen mode. It relies solel
 ### fullscreen
 
 | fieldName | type | description |
-|-------------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| - | - | - |
 | renderType | 'iconMenu' \| 'independent'? | Whether the fullscreen button is being rendered independently or as part of the IconMenu. Defaults to 'independent'. |
 | targetContainerId | string? | Specifies the html element on which the fullscreen mode should be applied. If the parameter is omitted, it falls back to the configured global field `containerId`. |
 

diff --git a/packages/plugins/GeoLocation/README.md b/packages/plugins/GeoLocation/README.md
@@ -11,7 +11,7 @@ either `true` or `false`. When a users denies the location tracking, the button
 #### geoLocation
 
 | fieldName | type | description |
-| ---------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| - | - | - |
 | boundaryLayerId | string? | Id of a vector layer to restrict geolocation markers and zooms to. When geolocation outside of its features occurs, an information will be shown once and the feature is stopped. The map will wait at most 10s for the layer to load; should it not happen, the geolocation feature is turned off. |
 | boundaryOnError | ('strict' \| 'permissive')? | If the boundary layer check does not work due to loading or configuration errors, style `'strict'` will disable the geolocation feature, and style `'permissive'` will act as if no boundaryLayerId was set. Defaults to `'permissive'`. |
 | checkLocationInitially | boolean? | If `true` the location gets checked on page load. When `false` this can be triggered with a button. Defaults to `false`. |