[Documentation] Markdown improvements f to m (openhab#13866)

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
psmedley · Feb 23, 2023 · bf850fa · bf850fa
1 parent 38a299c
commit bf850fa
Show file tree

Hide file tree

Showing 122 changed files with 3,505 additions and 3,677 deletions.
diff --git a/bundles/org.openhab.binding.fineoffsetweatherstation/README.md b/bundles/org.openhab.binding.fineoffsetweatherstation/README.md
@@ -4,16 +4,16 @@ This binding is for weather stations manufactured by [Fine Offset](http://www.fo
 These weather stations are white labeled products which are re-branded by many distribution companies around the world.
 Some of these brands are e.g.:
 
-* Aercus
-* Ambient Weather
-* Ecowitt
-* ELV
-* Froggit
-* Misol
-* Pantech
-* Sainlogic
-* Steinberg Systems
-* Waldbeck Halley
+- Aercus
+- Ambient Weather
+- Ecowitt
+- ELV
+- Froggit
+- Misol
+- Pantech
+- Sainlogic
+- Steinberg Systems
+- Waldbeck Halley
 
 Here is a product picture of how this Weather Station looks like:
 
@@ -23,31 +23,31 @@ This binding works offline by [implementing the wire protocol](https://osswww.ec
 
 ## Discussion
 
-If you have any issues or feedback, please feel free to [get in touch via the community forum](https://community.openhab.org/t/fine-offset-weather-station-binding-discussion/134167) 
+If you have any issues or feedback, please feel free to [get in touch via the community forum](https://community.openhab.org/t/fine-offset-weather-station-binding-discussion/134167)
 
 ## Supported Things
 
 - `weatherstation`: A Fine Offset gateway device with the ThingTypeUID `fineoffsetweatherstation:weatherstation` which supports the [wire protocol](https://osswww.ecowitt.net/uploads/20220407/WN1900%20GW1000,1100%20WH2680,2650%20telenet%20v1.6.4.pdf) e.g.:
-    - HP2550
-    - HP3500
-    - GW1000
-    - GW1001
-    - GW1002
-    - GW1003
-    - GW1100
-    - GW2001
-    - WN1900
-    - WN1910
-    - WH2350
-    - WH2600
-    - WH2610
-    - WH2620
-    - WH2650 (tested)
-    - WH2680
-    - WH2900
-    - WH2950
-    - WS980 ELV (tested)
-    - WittBoy (tested)
+  - HP2550
+  - HP3500
+  - GW1000
+  - GW1001
+  - GW1002
+  - GW1003
+  - GW1100
+  - GW2001
+  - WN1900
+  - WN1910
+  - WH2350
+  - WH2600
+  - WH2610
+  - WH2620
+  - WH2650 (tested)
+  - WH2680
+  - WH2900
+  - WH2950
+  - WS980 ELV (tested)
+  - WittBoy (tested)
 - `sensor`: A Fine Offset sensor which is connected to the bridge with the ThingTypeUID `fineoffsetweatherstation:sensor`.
   Since the gateway collects all the sensor data and harmonizes them, the sensor thing itself will only hold information about the signal and battery status.
   This is a list of sensors supported by the protocol:
@@ -75,7 +75,7 @@ In this case you have to configure a service to which the data is sent.
 Please try if here the [IPObserver binding](https://www.openhab.org/addons/bindings/ipobserver/) offers an alternative.
 Known weather stations not compatible with this binding:
 
-  - [WH3000](https://community.openhab.org/t/fine-offset-weather-station-binding-beta-and-discussion/134167/52?u=andy2003)
+- [WH3000](https://community.openhab.org/t/fine-offset-weather-station-binding-beta-and-discussion/134167/52?u=andy2003)
 
 ## Discovery
 
@@ -262,13 +262,13 @@ Valid sensors:
 | sensor-co2-co2                        | Number:Dimensionless          | R          | CO2                                            |
 | sensor-co2-co2-24-hour-average        | Number:Dimensionless          | R          | CO2 24 Hour Average                            |
 | leaf-wetness-channel-1                | Number:Dimensionless          | R          | Leaf Moisture Channel 1                        |  
-| leaf-wetness-channel-2                | Number:Dimensionless          | R          | Leaf Moisture Channel 2                        | 
-| leaf-wetness-channel-3                | Number:Dimensionless          | R          | Leaf Moisture Channel 3                        | 
-| leaf-wetness-channel-4                | Number:Dimensionless          | R          | Leaf Moisture Channel 4                        | 
-| leaf-wetness-channel-5                | Number:Dimensionless          | R          | Leaf Moisture Channel 5                        | 
-| leaf-wetness-channel-6                | Number:Dimensionless          | R          | Leaf Moisture Channel 6                        | 
-| leaf-wetness-channel-7                | Number:Dimensionless          | R          | Leaf Moisture Channel 7                        | 
-| leaf-wetness-channel-8                | Number:Dimensionless          | R          | Leaf Moisture Channel 8                        | 
+| leaf-wetness-channel-2                | Number:Dimensionless          | R          | Leaf Moisture Channel 2                        |
+| leaf-wetness-channel-3                | Number:Dimensionless          | R          | Leaf Moisture Channel 3                        |
+| leaf-wetness-channel-4                | Number:Dimensionless          | R          | Leaf Moisture Channel 4                        |
+| leaf-wetness-channel-5                | Number:Dimensionless          | R          | Leaf Moisture Channel 5                        |
+| leaf-wetness-channel-6                | Number:Dimensionless          | R          | Leaf Moisture Channel 6                        |
+| leaf-wetness-channel-7                | Number:Dimensionless          | R          | Leaf Moisture Channel 7                        |
+| leaf-wetness-channel-8                | Number:Dimensionless          | R          | Leaf Moisture Channel 8                        |
 | piezo-rain-rate                       | Number:VolumetricFlowRate     | R          | Piezo - Rainfall Rate                          |
 | piezo-rain-event                      | Number:Length                 | R          | Piezo - Amount of Rainfall At the last Rain    |
 | piezo-rain-hour                       | Number:Length                 | R          | Piezo - Rainfall Current Hour                  |
@@ -295,22 +295,22 @@ This is an example configuration for the WH2650 gateway
 
 _weatherstation.things_:
 
-```xtend
+```java
 Bridge fineoffsetweatherstation:gateway:3906700515 "Weather station" [
      ip="192.168.1.42",
      port="45000", 
      discoverInterval="900",
      pollingInterval="16",
      protocol="DEFAULT"
 ] {
-	Thing sensor WH25 "WH25" [sensor="WH25"]
-	Thing sensor WH65 "WH65" [sensor="WH65"]
+ Thing sensor WH25 "WH25" [sensor="WH25"]
+ Thing sensor WH65 "WH65" [sensor="WH65"]
 }
 ```
 
 _weatherstation.items_:
 
-```xtend
+```java
 Group WH25 "WH25"  <Sensor> ["Sensor"]
 Number SignalWH25        "Signal WH25"      <QualityOfService> (WH25) ["Measurement", "Level"] { channel="fineoffsetweatherstation:sensor:3906700515:WH25:signal" }
 Switch BatteryStatusWH25 "Low Battery WH25" <LowBattery>       (WH25) ["Energy", "LowBattery"] { channel="fineoffsetweatherstation:sensor:3906700515:WH25:lowBattery" }

diff --git a/bundles/org.openhab.binding.flicbutton/README.md b/bundles/org.openhab.binding.flicbutton/README.md
@@ -1,4 +1,4 @@
-# Flic Button Binding 
+# Flic Button Binding
 
 openHAB binding for using [Flic Buttons](https://flic.io/)
 with a [fliclib-linux-hci](https://github.com/50ButtonsEach/fliclib-linux-hci) bridge.
@@ -20,8 +20,8 @@ After buttons are initially added to flicd, an internet connection is not requir
 
 ## Discovery
 
-* There is no automatic discovery for flicd-bridge available.
-* After flicd-bridge is (manually) configured, buttons will be automatically discovered via background discovery as soon
+- There is no automatic discovery for flicd-bridge available.
+- After flicd-bridge is (manually) configured, buttons will be automatically discovered via background discovery as soon
   as they're added with [simpleclient](https://github.com/50ButtonsEach/fliclib-linux-hci).
 
 If they're already attached to the flicd-bridge before configuring this binding, they can be discovered by triggering an
@@ -33,14 +33,14 @@ active scan.
 
 Example for textual configuration:
 
-```
+```java
 Bridge flicbutton:flicd-bridge:mybridge
 ```
 
 The default host is localhost:5551 (this should be sufficient if flicd is running with default settings on the same server as openHAB).
 If your flicd service is running somewhere else, specify it like this:
 
-```
+```java
 Bridge flicbutton:flicd-bridge:mybridge [ hostname="<YOUR_HOSTNAME>",  port=<YOUR_PORT>]
 ```
 
@@ -52,7 +52,7 @@ For the button, the only config parameter is the MAC address.
 Normally, no textual configuration is necessary as buttons are auto discovered as soon as the bridge is configured.
 If you want to use textual configuration anyway, you can do it like this:
 
-```
+```java
 Bridge flicbutton:flicd-bridge:mybridge [ hostname="<YOUR_HOSTNAME>",  port=<YOUR_PORT>] {
     Thing button myflic1 "<YOUR_LABEL>" [address ="<MAC_ADDRESS>"]
     Thing button myflic2 "<YOUR_LABEL>" [address ="<MAC_ADDRESS>"]
@@ -70,11 +70,12 @@ You're free to choose any label you like for your button.
 | rawbutton                | [System Trigger Channel](https://www.openhab.org/docs/developer/bindings/thing-xml.html#system-trigger-channel-types) `system.rawbutton`  | Depends on the  [Trigger Profile](https://www.openhab.org/docs/configuration/items.html#profiles) used | Raw Button channel that triggers `PRESSED` and `RELEASED` events, allows to use openHAB profiles or own implementations via rules to detect e.g. double clicks, long presses etc.  |
 | button                   | [System Trigger Channel](https://www.openhab.org/docs/developer/bindings/thing-xml.html#system-trigger-channel-types) `system.button`    | Depends on the [Trigger Profile](https://www.openhab.org/docs/configuration/items.html#profiles) used | Button channel that is using Flic's implementation for detecting long, short or double clicks. Triggers `SHORT_PRESSED`,`DOUBLE_PRESSED` and `LONG_PRESSED` events.   |
 | battery-level            | [System State Channel](https://www.openhab.org/docs/developer/bindings/thing-xml.html#system-state-channel-types) `system.battery-level`     | Number | Represents the battery level as a percentage (0-100%).
+
 ## Example
 
 ### Initial setup
 
-1. Setup and run flicd as described in [fliclib-linux-hci](https://github.com/50ButtonsEach/fliclib-linux-hci). 
+1. Setup and run flicd as described in [fliclib-linux-hci](https://github.com/50ButtonsEach/fliclib-linux-hci).
    Please consider that you need a separate Bluetooth adapter. Shared usage with other Bluetooth services (e.g. Bluez)
    is not possible.
 1. Connect your buttons to flicd using the simpleclient as described in
@@ -92,16 +93,16 @@ You're free to choose any label you like for your button.
 
 demo.things:
 
-```
+```java
 Bridge flicbutton:flicd-bridge:local-flicd {
-	Thing button flic_livingroom "Yellow Button Living Room" [address = "60:13:B3:02:18:BD"]
-	Thing button flic_kitchen "Black Button Kitchen" [address = "B5:7E:59:78:86:9F"]
+ Thing button flic_livingroom "Yellow Button Living Room" [address = "60:13:B3:02:18:BD"]
+ Thing button flic_kitchen "Black Button Kitchen" [address = "B5:7E:59:78:86:9F"]
 }
 ```
 
 demo.items:
 
-```
+```java
 Dimmer Light_LivingRoom  { channel="milight:rgbLed:milight2:4:ledbrightness", channel="flicbutton:button:local-flicd:flic_livingroom:rawbutton" [profile="rawbutton-toggle-switch"], channel="flicbutton:button:local-flicd:flic_kitchen:rawbutton" [profile="rawbutton-toggle-switch"] }  // We have a combined kitchen / livingroom, so we control the living room lights with switches from the living room and from the kitchen
 Switch Light_Kitchen    { channel="hue:group:1:kitchen-bulbs:switch", channel="flicbutton:button:local-flicd:flic_kitchen:rawbutton" [profile="rawbutton-toggle-switch"] }
 ```
@@ -111,7 +112,7 @@ Switch Light_Kitchen    { channel="hue:group:1:kitchen-bulbs:switch", channel="f
 It's also possible to setup [Rules](https://www.openhab.org/docs/configuration/rules-dsl.html).
 The following rules help to initially test your setup as they'll trigger log messages on incoming events.
 
-```
+```java
 rule "Button rule using the button channel"
 
 when

diff --git a/bundles/org.openhab.binding.fmiweather/README.md b/bundles/org.openhab.binding.fmiweather/README.md
@@ -1,6 +1,6 @@
 # FMI Weather Binding
 
-This binding integrates to [the Finnish Meteorological Institute (FMI) Open Data API](https://en.ilmatieteenlaitos.fi/open-data). 
+This binding integrates to [the Finnish Meteorological Institute (FMI) Open Data API](https://en.ilmatieteenlaitos.fi/open-data).
 
 Binding provides access to weather observations from FMI weather stations and [HIRLAM weather forecast model](https://en.ilmatieteenlaitos.fi/weather-forecast-models) forecasts.
 Forecast covers all of Europe, see previous link for more information.
@@ -34,7 +34,6 @@ The binding automatically discovers weather stations and forecasts for nearby pl
 | --------- | ---- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
 | `fmisid`  | text | ✓        | FMI Station ID. You can FMISID of see all weathers stations at [FMI web site](https://en.ilmatieteenlaitos.fi/observation-stations?p_p_id=stationlistingportlet_WAR_fmiwwwweatherportlets&p_p_lifecycle=0&p_p_state=normal&p_p_mode=view&p_p_col_id=column-4&p_p_col_count=1&_stationlistingportlet_WAR_fmiwwwweatherportlets_stationGroup=WEATHER#station-listing) | `"852678"` for Espoo Nuuksio station |
 
-
 ### `forecast` thing configuration
 
 | Parameter  | Type | Required | Description                                                                                          | Example                           |
@@ -107,7 +106,7 @@ Please use the [Units Of Measurement](https://www.openhab.org/docs/concepts/unit
 
 `fmi.things`:
 
-```
+```java
 Thing fmiweather:observation:station_Helsinki_Kumpula "Helsinki Kumpula Observation" [fmisid="101004"]
 Thing fmiweather:forecast:forecast_Paris "Paris Forecast" [location="48.864716, 2.349014"]
 ```
@@ -144,7 +143,7 @@ for channel in observation['value']['channels']:
      '"{label} [{unit}]" {{ channel="{channel_id}" }}').format(**locals()))    
 -->
 
-```
+```java
 DateTime HelsinkiObservationTime "Observation Time [%1$tY-%1$tm-%1$tdT%1$tH:%1$tM:%1$tS]" <time> { channel="fmiweather:observation:station_Helsinki_Kumpula:current#time" }
 Number:Temperature HelsinkiTemperature "Temperature [%.1f %unit%]" <temperature> { channel="fmiweather:observation:station_Helsinki_Kumpula:current#temperature" }
 Number:Dimensionless HelsinkiHumidity "Humidity [%.1f %unit%]" <humidity> { channel="fmiweather:observation:station_Helsinki_Kumpula:current#humidity" }
@@ -216,7 +215,7 @@ for channel in forecast['channels']:
      '"{label} [{unit}]" {icon} {{ channel="{channel_id}" }}').format(**locals()))       
 -->
 
-```
+```java
 DateTime ParisForecastNowTime "Forecast Time Now [%1$tY-%1$tm-%1$tdT%1$tH:%1$tM:%1$tS]" <time> { channel="fmiweather:forecast:forecast_Paris:forecastNow#time" }
 Number:Temperature ParisForecastNowTemperature "Temperature Now [%.1f %unit%]" <temperature> { channel="fmiweather:forecast:forecast_Paris:forecastNow#temperature" }
 Number:Dimensionless ParisForecastNowHumidity "Humidity Now [%.1f %unit%]" <humidity> { channel="fmiweather:forecast:forecast_Paris:forecastNow#humidity" }
@@ -783,7 +782,7 @@ Number ParisForecastHours50WeatherId "Prevailing weather id hour 50 [%.1f %unit%
 
 `fmi_weather.sitemap`:
 
-```
+```perl
 sitemap fmi_weather label="FMI Weather" {
     Frame label="Observation Helsinki" {
         Text item=HelsinkiObservationTime

diff --git a/bundles/org.openhab.binding.folderwatcher/README.md b/bundles/org.openhab.binding.folderwatcher/README.md
@@ -6,7 +6,6 @@ This binding is intended to monitor FTP and local folder and its subfolders and
 
 Currently the binding support two types of things: `ftpfolder` and `localfolder`.
 
-
 ## Thing Configuration
 
 The `ftpfolder` thing has the following configuration options:
@@ -43,7 +42,6 @@ This binding currently supports the following events:
 | newftpfile | String       | A new file name discovered on FTP                                                      |
 | newlocalfile | String       | A new file name discovered on in local folder                                                      |
 
-
 ## Full Example
 
 Thing configuration:

diff --git a/bundles/org.openhab.binding.foobot/README.md b/bundles/org.openhab.binding.foobot/README.md
@@ -25,7 +25,7 @@ Bridge has the following configuration parameters:
 
 | Parameter        | Description                                           | Required
 |------------------|-------------------------------------------------------|----------
-| apikey           | API Key from https://api.foobot.io/apidoc/index.html  | Mandatory
+| apikey           | API Key from <https://api.foobot.io/apidoc/index.html>  | Mandatory
 | username         | The e-mail address used to log into the Foobot App    | Mandatory
 | refreshInterval  | Refresh interval in minutes, minimal 5 minutes        | Optional, the default value is 8 minutes.
 
@@ -40,7 +40,6 @@ The bridge has one channel:
 |----------------------|-----------|-----------------------------------------------
 | apiKeyLimitRemaining | Number    | The remaining number of API requests for today
 
-
 The AirQuality sensors information that is retrieved is available as these channels:
 
 | Channel ID        | Item Type            | Description
@@ -57,7 +56,7 @@ The AirQuality sensors information that is retrieved is available as these chann
 
 demo.things:
 
-```
+```java
 // Bridge configuration:
 Bridge foobot:account:myfoobotaccount "Foobot Account" [apiKey="XXXXXX", username="XXXXXX", refreshInterval=8] {
   Things:
@@ -66,6 +65,6 @@ Bridge foobot:account:myfoobotaccount "Foobot Account" [apiKey="XXXXXX", usernam
 
 demo.items:
 
-```
+```java
 Number:Temperature Temperature "Temperature" <temperature> { channel="foobot:myfoobotaccount:device:myfoobot:temperature" }
 ```