Make Markdown code block languages consistent (#17480)

* Make Markdown code block languages consistent Signed-off-by: Jacob Laursen <[email protected]> * Fix indentation Signed-off-by: Jacob Laursen <[email protected]> --------- Signed-off-by: Jacob Laursen <[email protected]>
openhab · Sep 29, 2024 · 85b1652 · 85b1652
1 parent c4576bb
commit 85b1652
Show file tree

Hide file tree

Showing 39 changed files with 100 additions and 103 deletions.
diff --git a/bundles/org.openhab.automation.groovyscripting/README.md b/bundles/org.openhab.automation.groovyscripting/README.md
@@ -15,7 +15,7 @@ If you create an empty file called `test.groovy`, you will see a log line with i
 
 To enable debug logging, use the [console logging]({{base}}/administration/logging.html) commands to enable debug logging for the automation functionality:
 
-```text
+```shell
 log:set DEBUG org.openhab.core.automation
 ```
 

diff --git a/bundles/org.openhab.automation.jsscriptingnashorn/README.md b/bundles/org.openhab.automation.jsscriptingnashorn/README.md
@@ -21,7 +21,7 @@ If you create an empty file called `test.nashornjs`, you will see a log line wit
 
 To enable debug logging, use the [console logging]({{base}}/administration/logging.html) commands to enable debug logging for the automation functionality:
 
-```text
+```shell
 log:set DEBUG org.openhab.core.automation
 ```
 

diff --git a/bundles/org.openhab.binding.amazonechocontrol/README.md b/bundles/org.openhab.binding.amazonechocontrol/README.md
@@ -537,7 +537,7 @@ E.g. to read out the history call from an installation on openhab:8080 with an a
 
 1) Create a rule with a trigger of your choice
 
-```php
+```java
 rule "Say welcome if the door opens"
 when
     Item Door_Contact changed to OPEN
@@ -548,7 +548,7 @@ end
 
 You can also use [SSML](https://docs.aws.amazon.com/polly/latest/dg/supported-ssml.html) to provide a better voice experience
 
-```php
+```java
 rule "Say welcome if the door opens"
 when
     Item Door_Contact changed to OPEN
@@ -563,7 +563,7 @@ end
 
 Simple:
 
-```php
+```java
 rule "Say welcome if the door opens"
 when
     Item Door_Contact changed to OPEN
@@ -576,7 +576,7 @@ Expert:
 
 You can use a json formatted string to control title, sound and volume:
 
-```php
+```json
 {"sound": true, "speak":"<Speak>", "title": "<Title>", "body": "<Body Text>", "volume": 20}
 ```
 

diff --git a/bundles/org.openhab.binding.argoclima/README.md b/bundles/org.openhab.binding.argoclima/README.md
@@ -269,7 +269,7 @@ Switch  ArgoClimaHVACRemote_FilterMode  "Filter Mode"    <switch> (GArgoClimaHVA
 
 ### argoclima.sitemap
 
-```java
+```perl
 // All things in all modes expose the same channels
 Frame label="❄ HVAC Control" {
     Switch item=ArgoClimaHVACRemote_Power

diff --git a/bundles/org.openhab.binding.avmfritz/README.md b/bundles/org.openhab.binding.avmfritz/README.md
@@ -126,7 +126,7 @@ To do so
 Auto-discovery is enabled by default.
 To disable it, you can add the following line to `<openHAB-conf>/services/runtime.cfg`:
 
-```text
+```ini
 discovery.avmfritz:background=false
 ```
 

diff --git a/bundles/org.openhab.binding.bigassfan/README.md b/bundles/org.openhab.binding.bigassfan/README.md
@@ -48,7 +48,7 @@ Background discovery polls the network every few minutes for devices.
 Background discovery is **enabled** by default.
 To **disable** background discovery, add the following line to the _conf/services/runtime.cfg_ file:
 
-```text
+```ini
 discovery.bigassfan:background=false
 ```
 

diff --git a/bundles/org.openhab.binding.daikin/README.md b/bundles/org.openhab.binding.daikin/README.md
@@ -21,7 +21,7 @@ Background discovery polls the network every minute for devices.
 Background discovery is **enabled** by default.
 To **disable** background discovery, add the following line to the _conf/services/runtime.cfg_ file:
 
-```text
+```ini
 discovery.daikin:background=false
 ```
 

diff --git a/bundles/org.openhab.binding.dbquery/README.md b/bundles/org.openhab.binding.dbquery/README.md
@@ -212,7 +212,7 @@ Create a rule that is fired
 - **When** `calculateParameters` is triggered in `myquery`
 - **Then** executes the following script action (in that example Jython):
 
-```text
+```python
 map = {"time" : "-2h"}
 dbquery = actions.get("dbquery","dbquery:query:myquery")
 dbquery.setQueryParameters(map)

diff --git a/bundles/org.openhab.binding.emotiva/README.md b/bundles/org.openhab.binding.emotiva/README.md
@@ -117,15 +117,15 @@ The Emotiva Processor supports the following channels (some channels are model s
 
 ## Full Example
 
-### `.things` file:
+### `.things` file
 
-```perl
+```java
 Thing emotiva:processor:1 "XMC-2" @ "Living room" [ipAddress="10.0.0.100", protocolVersion="3.0"]
 ```
 
-### `.items` file:
+### `.items` file
 
-```perl
+```java
 Switch                  emotiva-power               "Processor"                     {channel="emotiva:processor:1:general#power"}
 Dimmer                  emotiva-volume              "Volume [%d %%]"                {channel="emotiva:processor:1:main-zone#volume"}
 Number:Dimensionless    emotiva-volume-db           "Volume [%d dB]"                {channel="emotiva:processor:1:main-zone#volume-db"}
@@ -148,7 +148,7 @@ String                  emotiva-menu-tottom-center  ""                      <non
 String                  emotiva-menu-tottom-end     ""                      <none>  {channel="emotiva:processor:1:general#menu-display-bottom-end"}
 ```
 
-### `.sitemap` file:
+### `.sitemap` file
 
 ```perl
 Group item=emotiva-input label="Processor" icon="receiver" {

diff --git a/bundles/org.openhab.binding.fenecon/README.md b/bundles/org.openhab.binding.fenecon/README.md
@@ -93,7 +93,6 @@ Number:Energy        TotalBuyEnergy                 <energy>       (GF_UtilityRo
 // Examples of items for calculating the energy purchased and sold. Look at the demo.rules section.
 Number:Currency      SoldEnergy "Total sold energy [%.2f €]"           <price> (GF_UtilityRoomSolar)
 Number:Currency      PurchasedEnergy "Total purchased energy [%.2f €]" <price> (GF_UtilityRoomSolar)
-
 ```
 
 ### demo.sitemap

diff --git a/bundles/org.openhab.binding.flume/README.md b/bundles/org.openhab.binding.flume/README.md
@@ -62,22 +62,20 @@ Note, there is a rate limit of 120 queries per hour imposed by Flume so use caut
 Please note that the device meter ID is only available through the API and not available on the Flume portal.
 When the Bridge device is first created, there will be a log message with the ID of the discovered device which can be used in further configuring the device via the text files.
 
-```
+```java
 Bridge flume:cloud:cloudconnector [ username="xxx", password="xxx", clientId="xxx", clientSecret="xxx" ] {
-
     meter-device meter [ id="xxx" ]
 }
 ```
 
 ### Item Configuration
 
-```
+```java
 Number:VolumetricFlowRate     InstantUsage     "Instant Usage"         { channel = "flume:meter-device:1:meter:instant-usage" }
 Number:Volume                 CumulativeUsed   "Cumulative Used"       { channel = "flume:meter-device:1:meter:cumulative-usage" }
 Number:Dimensionless          BatteryLevel     "Battery Level"         { channel = "flume:meter-device:1:meter:battery-level" }
 DateTime                      LastSeen         "Last Seen"             { channel = "flume:meter-device:1:meter:last-seen" }
 Switch                        LowPower         "Battery Low Power"     { channel = "flume:meter-device:1:meter:low-battery" }
-
 ```
 
 ### Rules

diff --git a/bundles/org.openhab.binding.globalcache/README.md b/bundles/org.openhab.binding.globalcache/README.md
@@ -127,7 +127,7 @@ The GlobalCache binding will automatically detect those devices, then add them t
 Background discovery is **enabled** by default.
 To disable background discovery, add the following line to the _conf/services/runtime.cfg_ file:
 
-```text
+```ini
 discovery.globalcache:background=false
 ```
 

diff --git a/bundles/org.openhab.binding.growatt/README.md b/bundles/org.openhab.binding.growatt/README.md
@@ -139,14 +139,14 @@ The list of all possible channels is as follows:
 This binding includes rule actions, which allow you to setup programs for battery charging and discharging.
 Each inverter thing has a separate actions instance, which can be retrieved as follows.
 
-```php
+```java
 val growattActions = getActions("growatt", "growatt:inverter:home:sph")
 ```
 
 Where the first parameter must always be `growatt` and the second must be the full inverter thing UID.
 Once the action instance has been retrieved, you can invoke the following method:
 
-```php
+```java
 growattActions.setupBatteryProgram(int programMode, @Nullable Integer powerLevel, @Nullable Integer stopSOC, @Nullable Boolean enableAcCharging, @Nullable String startTime, @Nullable String stopTime, @Nullable Boolean enableProgram)
 ```
 
@@ -184,7 +184,7 @@ The permission for passing 'null' parameters, and the effect of such 'null' para
 
 The following is an example program to charge the battery during a night-time low tariff period, and depending on the forecast solar energy for the coming day.
 
-```php
+```java
 // solar power constants
 val Integer programMode = 1 // 0 = Load First, 1 = Battery First, 2 = Grid First
 val Integer powerLevel = 23 // percent
@@ -257,7 +257,7 @@ end
 
 The following is an example program to charge the battery in preparation to avoid importing energy during a coming extra high tariff time window.
 
-```php
+```java
 // solar power constants
 var pauseProgramLastSetupDate
 
@@ -409,7 +409,7 @@ The installation is as follows:
 
 A suggested Grott configuration for openHAB is as follows:
 
-```php
+```ini
 [Generic]
 mode = proxy
 compat = False
@@ -437,7 +437,7 @@ The service configuration for Linux is summarised below:
 - Copy the `grott.service` file to the `/etc/systemd/system/` folder
 - Modify `grott.service` to enter your user name; the Grott settings; the path to Python; and the path to the Grott application:
 
-```php
+```ini
 [Service]
 SyslogIdentifier=grott
 User=<username>  // your username

diff --git a/bundles/org.openhab.binding.hdpowerview/README.md b/bundles/org.openhab.binding.hdpowerview/README.md
@@ -323,7 +323,7 @@ Switch Automation_Children_Up_Time "Children Up At 6:30" {channel="hdpowerview:h
 
 ### `demo.sitemap` File
 
-```php
+```perl
 Frame label="Living Room" {
     Switch item=Living_Room_Shades_Scene_Open
     Slider item=Living_Room_Shade_Position

diff --git a/bundles/org.openhab.binding.hue/README.md b/bundles/org.openhab.binding.hue/README.md
@@ -37,7 +37,7 @@ Potentially two types of Bridge will be discovered - namely an API v1 Bridge and
 Auto-discovery is enabled by default.
 To disable it, you can add the following line to `<openHAB-conf>/services/runtime.cfg`:
 
-```text
+```ini
 discovery.hue:background=false
 ```
 

diff --git a/bundles/org.openhab.binding.hue/doc/readme_v1.md b/bundles/org.openhab.binding.hue/doc/readme_v1.md
@@ -217,14 +217,14 @@ The `tap_switch_event` can trigger one of the following events:
 This binding includes a rule action, which allows to change a light channel with a specific fading time from within rules.
 There is a separate instance for each light or light group, which can be retrieved e.g. through
 
-```php
+```java
 val hueActions = getActions("hue","hue:0210:00178810d0dc:1")
 ```
 
 where the first parameter always has to be `hue` and the second is the full Thing UID of the light that should be used.
 Once this action instance is retrieved, you can invoke the `fadingLightCommand(String channel, Command command, DecimalType fadeTime)` method on it:
 
-```php
+```java
 hueActions.fadingLightCommand("color", new PercentType(100), new DecimalType(1000))
 ```
 
@@ -335,7 +335,7 @@ sitemap demo label="Main Menu"
 
 ### Events
 
- ```php
+ ```java
 rule "example trigger rule"
 when
     Channel "hue:0820:1:dimmer-switch:dimmer_switch_event" triggered <EVENT>
@@ -349,7 +349,7 @@ If ommited the rule gets triggered by any key action and you can determine the e
 Be aware that the events have a '.0' attached to them, like `2001.0` or `34.0`.
 So, testing for specific events looks like this:
 
-```php
+```java
 if (receivedEvent == "1000.0") {
     //do stuff
 }

diff --git a/bundles/org.openhab.binding.hue/doc/readme_v2.md b/bundles/org.openhab.binding.hue/doc/readme_v2.md
@@ -207,14 +207,14 @@ openhab> openhab:hue hue:bridge-api2:g24 things > myThingsFile.things
 This binding includes a rule action, which implements dynamic (i.e. gradual) transitions to a new scene or light(s) state.
 Each thing has a separate action instance, which can be retrieved as follows.
 
-```php
+```java
 val hueActions = getActions("hue","hue:device:g24:11111111-2222-3333-4444-555555555555")
 ```
 
 Where the first parameter must always be `hue` and the second must be the full thing UID.
 Once the action instance has been retrieved, you can invoke its `dynamicCommand(String channelId, Command command, Long durationMs)` method as follows.
 
-```php
+```java
 hueActions.dynamicCommand("brightness", new PercentType(100), new Long(10000))
 
 hueActions.dynamicCommand("scene", new StringType("SceneName"), new Long(20000))

diff --git a/bundles/org.openhab.binding.icloud/README.md b/bundles/org.openhab.binding.icloud/README.md
@@ -67,7 +67,7 @@ The following channels are available (if supported by the device):
 
 ### icloud.things
 
-```php
+```java
 Bridge icloud:account:myaccount [appleId="[email protected]", password="secure", code="123456", refreshTimeInMinutes=5]
 {
     Thing device myiPhone8 "iPhone 8" @ "World" [deviceId="VIRG9FsrvXfE90ewVBA1H5swtwEQePdXVjHq3Si6pdJY2Cjro8QlreHYVGSUzuWV"]
@@ -79,7 +79,7 @@ The information _@ "World"_ is optional.
 
 ### icloud.items
 
-```php
+```java
 Group    iCloud_Group "iPhone"
 
 String   iPhone_BatteryStatus             "Battery Status [%s]"     <battery>   (iCloud_Group) {channel="icloud:device:myaccount:myiPhone8:batteryStatus"}
@@ -94,7 +94,7 @@ Switch   iPhone_Home                      "Phone Home"              <presence>
 
 ### icloud.sitemap
 
-```php
+```perl
 sitemap icloud label="iCloud" {
     Frame item=iCloud_Group {
         Text item=iPhone_BatteryStatus
@@ -112,7 +112,7 @@ sitemap icloud label="iCloud" {
 
 ### icloud.rules
 
-```php
+```java
 rule "iPhone Home"
 when
     Item iPhone_Location changed

diff --git a/bundles/org.openhab.binding.insteon/README.md b/bundles/org.openhab.binding.insteon/README.md
@@ -836,7 +836,7 @@ Insufficient access to the lock directory will result in openHAB failing to acce
 Device types are defined in the file `device_types.xml`, which is inside the Insteon bundle and thus not visible to the user.
 You can however load your own device_types.xml by referencing it in the network config parameters:
 
-```text
+```ini
 additionalDevices="/usr/local/openhab/rt/my_own_devices.xml"
 ```
 
@@ -861,7 +861,7 @@ Avoid duplicate keys by finding the highest fake product key in the `device_type
 
 If you can't build a new device out of the existing device features (for a complete list see `device_features.xml`) you can add new features by specifying a file (let's call it `my_own_features.xml`) with the "additionalDevices" option in the network config parameters:
 
-```text
+```ini
 additionalFeatures="/usr/local/openhab/rt/my_own_features.xml"
 ```
 

diff --git a/bundles/org.openhab.binding.loxone/README.md b/bundles/org.openhab.binding.loxone/README.md
@@ -200,7 +200,7 @@ If a parameter is not explicitly defined, binding will use its default value.
 
 To define a parameter value in a .things file, please refer to it by parameter's ID, for example:
 
-```text
+```ini
 keepAlivePeriod=120
 ```