[Documentation] Markdown improvements f to m #13866

Confectrician · 2022-12-06T19:50:32Z

This is a bulk pr for getting some consistency into the doc markdown files.

Reference for a general linting approach here: #13858
Discussion Reference for codeblock styles i have applied: openhab/openhab-docs#999

(Sorry for the many review requests, there is plenty much to improve in the repo. 🤷‍♂️)

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

wborn

Thanks! 👍

duhast

Mikrotik looks good 👍🏻

MHerbst · 2022-12-08T08:33:16Z

Homematic LGTM

MikeTheTux · 2022-12-08T08:34:26Z

@Confectrician, in keba and guntamatic item description, some tabs have been converted to space incomplete. Are you able to fix that?

BjoernLange

LGTM

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

andrewfg

Gardena LGTM
HdPowerView LGTM
Hue LGTM

ramack

heliosventilation LGTM

jlaur

@Confectrician, @wborn FYI - I've made some additional review comments after PR has been merged.

jlaur · 2022-12-08T20:22:57Z

bundles/org.openhab.binding.flicbutton/README.md

+ 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"]


These tabs should be converted to four spaces to preserve indentation:

Suggested change

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"]

jlaur · 2022-12-08T20:25:06Z

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


Can you reformat the table alignment after this change, i.e. add two spaces/dashes at the end for this column in the lines before and after?

jlaur · 2022-12-08T20:28:01Z

bundles/org.openhab.binding.fsinternetradio/README.md

+ Frame {
+  Switch item=RadioPower
+  Slider visibility=[RadioPower==ON] item=RadioVolume
+  Switch visibility=[RadioPower==ON] item=RadioMute
+  Selection visibility=[RadioPower==ON] item=RadioPreset mappings=[0="Favourit 1", 1="Favourit 2", 2="Favourit 3", 3="Favourit 4"]
+  Selection visibility=[RadioPower==ON] item=RadioMode mappings=[0="Internet Radio", 1="Musik Player", 2="DAB", 3="FM", 4="AUX"]
+  Text visibility=[RadioPower==ON] item=RadioInfo1
+  Text visibility=[RadioPower==ON] item=RadioInfo2
+ }


Tabs should be converted to four spaces to preserve indentation:

Suggested change

Frame {

Switch item=RadioPower

Slider visibility=[RadioPower==ON] item=RadioVolume

Switch visibility=[RadioPower==ON] item=RadioMute

Selection visibility=[RadioPower==ON] item=RadioPreset mappings=[0="Favourit 1", 1="Favourit 2", 2="Favourit 3", 3="Favourit 4"]

Selection visibility=[RadioPower==ON] item=RadioMode mappings=[0="Internet Radio", 1="Musik Player", 2="DAB", 3="FM", 4="AUX"]

Text visibility=[RadioPower==ON] item=RadioInfo1

Text visibility=[RadioPower==ON] item=RadioInfo2

}

Frame {

Switch item=RadioPower

Slider visibility=[RadioPower==ON] item=RadioVolume

Switch visibility=[RadioPower==ON] item=RadioMute

Selection visibility=[RadioPower==ON] item=RadioPreset mappings=[0="Favourit 1", 1="Favourit 2", 2="Favourit 3", 3="Favourit 4"]

Selection visibility=[RadioPower==ON] item=RadioMode mappings=[0="Internet Radio", 1="Musik Player", 2="DAB", 3="FM", 4="AUX"]

Text visibility=[RadioPower==ON] item=RadioInfo1

Text visibility=[RadioPower==ON] item=RadioInfo2

}

jlaur · 2022-12-08T20:35:23Z

bundles/org.openhab.binding.haywardomnilogic/README.md

@@ -31,7 +31,7 @@ Hayward OmniLogic Connection Parameters:

 | Property             | Default                                                        | Required | Description                                  |
 |----------------------|----------------------------------------------------------------|----------|----------------------------------------------|
-| Host Name            | https://app1.haywardomnilogic.com/HAAPI/HomeAutomation/API.ash | Yes      | Host name of the Hayward API server          |
+| Host Name            | <https://app1.haywardomnilogic.com/HAAPI/HomeAutomation/API.ash> | Yes      | Host name of the Hayward API server          |


Can you reformat the table alignment after this change?

jlaur · 2022-12-08T20:38:04Z

bundles/org.openhab.binding.hdpowerview/README.md

+| Single action<br>top-down   | `position`        | ▲                     | Up               | **`CLOSED`** | 0%                | ▲                    |
+|                             |                   | ▼                     | Down             | **`OPEN`**   | 100%              | ▼                    |


Can this table also be reformatted with alignment? Here and below:

Suggested change

| Single action<br>top-down | `position` | ▲ | Up | **`CLOSED`** | 0% | ▲ |

| | | ▼ | Down | **`OPEN`** | 100% | ▼ |

| Single action<br>top-down | `position` | ▲ | Up | **`CLOSED`** | 0% | ▲ |

| | | ▼ | Down | **`OPEN`** | 100% | ▼ |

jlaur · 2022-12-08T20:40:35Z

bundles/org.openhab.binding.heos/README.md

+ player Kitchen "Kitchen"[pid="434523813"]
+ player LivingRoom "Living Room"[pid="918797451"]
+ group 813793755 "Ground Level"[members="434523813;918797451"]


Spaces for keeping indentation.

jlaur · 2022-12-08T20:43:20Z

bundles/org.openhab.binding.heos/README.md

+     Default item=LivingRoom_Control
+     Default item=LivingRoom_Mute
+     Default item=LivingRoom_Volume
+     Default item=LivingRoom_Title
+     Default item=LivingRoom_Interpret
+     Default item=LivingRoom_Album


Here I would also suggest to replace tabs with four spaces.

jlaur · 2022-12-08T20:43:35Z

bundles/org.openhab.binding.heos/README.md

+ when
+  Item HeosKitchen_InputSelect received command
+ then
+  if (receivedCommand.toString == "aux_in_1") {
+   sendCommand(HeosKitchen_Input, "aux_in_1")
+
+  } if (receivedCommand.toString == "LivingRoom") {
+   sendCommand(HeosBridge_Play_Living, ON)
+   sendCommand(HeosKitchen_Input, "aux_in_1")
+   sendCommand(HeosBridge_Play_Living, OFF) //Switch player channel off again to be sure that it is OFF
+  }


jlaur · 2022-12-08T20:43:49Z

bundles/org.openhab.binding.heos/README.md

+ Default item=HeosGroup1_Player
+ Default item=HeosGroup1_Volume
+ Default item=HeosGroup1_Mute
+ Default item=HeosGroup1_Favorites
+ Default item=HeosGroup1_Playlist
+
+ Text item=HeosGroup1_Song {
+  Default item=HeosGroup1_Song
+  Default item=HeosGroup1_Artist
+  Default item=HeosGroup1_Album
+  Image item=HeosGroup1_Cover url=""
+ }


jlaur · 2022-12-08T20:46:09Z

bundles/org.openhab.binding.http/README.md

+ baseURL="https://example.com/api/v1/metadata-api/web/metadata",
+ headers="key1=value1", "key2=value2", "key3=value3",
+ refresh=15] {
+  Channels:
+   Type string : text "Text" [ stateTransformation="JSONPATH:$.metadata.data" ]


Tab => four spaces.

jlaur · 2022-12-08T20:52:15Z

bundles/org.openhab.binding.jellyfin/README.md

+ clientActiveWithInSeconds=0,
+ hostname="192.168.1.177",
+ port=8096,
+ refreshSeconds=30,
+ ssl="false"


Tab => four spaces.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch> Signed-off-by: Ben Rosenblum <rosenblumb@gmail.com>

Signed-off-by: Jerome Luckenbach <github@luckenba.ch> Signed-off-by: Andras Uhrin <andras.uhrin@gmail.com>

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

according to openhab#13866 Signed-off-by: Martin Grassl <martin.grassl@digital-filestore.de>

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

Signed-off-by: Jerome Luckenbach <github@luckenba.ch> Signed-off-by: Andras Uhrin <andras.uhrin@gmail.com>

Confectrician added 6 commits December 6, 2022 10:00

Apply markdown fixes for bindings with letter _f_

49b6bd6

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

Apply markdown fixes for bindings with letter _f-to-j_

8b645d1

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

Apply markdown fixes for bindings with letter _j_

ce643c8

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

Apply markdown fixes for bindings with letter _k_

7213769

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

Apply markdown fixes for bindings with letter _l_

e00218b

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

Apply markdown fixes for bindings with letter _m_

ffb622c

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

wborn approved these changes Dec 7, 2022

View reviewed changes

duhast approved these changes Dec 7, 2022

View reviewed changes

goopilot approved these changes Dec 8, 2022

View reviewed changes

ne0h approved these changes Dec 8, 2022

View reviewed changes

sgiehl approved these changes Dec 8, 2022

View reviewed changes

BjoernLange approved these changes Dec 8, 2022

View reviewed changes

Item formatting.

e0279eb

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

andrewfg approved these changes Dec 8, 2022

View reviewed changes

ramack approved these changes Dec 8, 2022

View reviewed changes

wborn merged commit 0e68936 into openhab:main Dec 8, 2022

wborn added this to the 3.4 milestone Dec 8, 2022

jlaur reviewed Dec 8, 2022

View reviewed changes

Confectrician mentioned this pull request Dec 8, 2022

[Documentation] Second post merge refactoring for bindings f to m needed #13882

Closed

jlaur reviewed Dec 8, 2022

View reviewed changes

jlaur mentioned this pull request Dec 17, 2022

Fix alignment/indentation in documentation #13994

Merged

morph166955 pushed a commit to morph166955/openhab-addons that referenced this pull request Dec 18, 2022

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

ea0e47a

Signed-off-by: Jerome Luckenbach <github@luckenba.ch> Signed-off-by: Ben Rosenblum <rosenblumb@gmail.com>

andrasU pushed a commit to andrasU/openhab-addons that referenced this pull request Dec 24, 2022

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

d0d3f61

Signed-off-by: Jerome Luckenbach <github@luckenba.ch> Signed-off-by: Andras Uhrin <andras.uhrin@gmail.com>

borazslo pushed a commit to borazslo/openhab-mideaac-addon that referenced this pull request Jan 8, 2023

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

5577258

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

jlaur mentioned this pull request Feb 19, 2023

[mybmw] Upgrade to new BMW API #14452

Merged

martingrassl added a commit to martingrassl/openhab-addons that referenced this pull request Feb 20, 2023

[mybmw/Documentation] re-fix linting of README

6e525c9

according to openhab#13866 Signed-off-by: Martin Grassl <martin.grassl@digital-filestore.de>

psmedley pushed a commit to psmedley/openhab-addons that referenced this pull request Feb 23, 2023

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

bf850fa

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

nemerdaud pushed a commit to nemerdaud/openhab-addons that referenced this pull request Feb 28, 2023

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

288d011

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

jlaur mentioned this pull request Sep 19, 2023

[http] Improve binding #15376

Closed

andrasU pushed a commit to andrasU/openhab-addons that referenced this pull request Jan 6, 2024

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

abc627f

Signed-off-by: Jerome Luckenbach <github@luckenba.ch> Signed-off-by: Andras Uhrin <andras.uhrin@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Documentation] Markdown improvements f to m #13866

[Documentation] Markdown improvements f to m #13866

Confectrician commented Dec 6, 2022

wborn left a comment

duhast left a comment

MHerbst commented Dec 8, 2022

MikeTheTux commented Dec 8, 2022

BjoernLange left a comment

andrewfg left a comment

ramack left a comment

jlaur left a comment

jlaur Dec 8, 2022

jlaur Dec 8, 2022

jlaur Dec 8, 2022

jlaur Dec 8, 2022

jlaur Dec 8, 2022

jlaur Dec 8, 2022

jlaur Dec 8, 2022

jlaur Dec 8, 2022

jlaur Dec 8, 2022

jlaur Dec 8, 2022

jlaur Dec 8, 2022

		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"]

		\| Single action<br>top-down \| `position` \| ▲ \| Up \| `CLOSED` \| 0% \| ▲ \|
		\| \| \| ▼ \| Down \| `OPEN` \| 100% \| ▼ \|

[Documentation] Markdown improvements f to m #13866

[Documentation] Markdown improvements f to m #13866

Conversation

Confectrician commented Dec 6, 2022

wborn left a comment

Choose a reason for hiding this comment

duhast left a comment

Choose a reason for hiding this comment

MHerbst commented Dec 8, 2022

MikeTheTux commented Dec 8, 2022

BjoernLange left a comment

Choose a reason for hiding this comment

andrewfg left a comment

Choose a reason for hiding this comment

ramack left a comment

Choose a reason for hiding this comment

jlaur left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment