openhab-docs/configuration
bgilmer77 5532a042e1 [Items] Improve comprehension (#512)
* Improve introductory paragraph

This is a test.
DO NOT approve this PR.

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)

* Clarify Item/real world interaction

This is a second test.  I am still learning about GitHub/GitHub Desktop interaction.  The purpose of the test is to check the behavior of GitHub when making multiple commits on a single branch.

I have modified the language to clarify the interaction between Items and the real world through bindings.  While the existing language was okay, I hope this submission provides additional clarity  around the fact that Item states can be set by actions in the real world

* Improve readability of Introduction section

Changed wording in the Introduction section to improve readability and comprehension.

* Correct spelling error and clarify Item/real world interaction

Edited introduction to correct spelling error and clarify Item/real-world interaction.

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)

* Item Definition and Syntax: improve readability

Some wording in the Item Definition and Syntax section has been changed to improve readability.

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)

* Type: improve readability

Some wording in the Type section has been changed to improve readability

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)

* Name: improve readability

Some wording in the Name section has been changed, and the section has been reorganized to improve comprehension.

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)

* Name: Tweak group naming suggestions

Based upon comment from @ThomDetrich, tweak the first scheme for group names.

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)

* Label: improve readability

Changed text in the Label section to improve readability and comprehension

* State: improve readability

Made changes to improve readability and comprehension.

* Icons: improve readability

The Icons section has been modified to improve readability and comprehension.

* Group: improve readability

Changes have been made in wording and arrangement to improve readability and comprehension.

* Tags: improve readability

Changes have been made in wording and arrangement to improve readability and comprehension.

* Binding: improve readability

Changes have been made in wording and arrangement to improve readability and comprehension.

* Binding Configuration: improve readability

Changes have been made in wording and arrangement to improve readability and comprehension.
Not sure whether all this 1.x information needs to remain.
Removed information on persistence.  Will look to see if it should be added to other PR on STATE #507.

This complete the nit pass through the items.md file

* Correct linter formatting issues

This commit corrects formatting issues revealed by linter.

* Add some last minute changes

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)

* Discuss distinction between command and status

-  End-users may assume that the change in state of a Switch Item reflects the actual state of the Thing.
-  Added section to make clear the difference between command and status
-  May seem obvious, but some implementers could get burned by not thinking this through.

* Add second batch of corrections

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)

* Correct typo

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-11-07 12:37:40 +01:00
..
images [Editors] Add LSP to VS Code section (#550) 2017-11-06 01:29:36 +01:00
eclipseiotmarket.md Correct linter warnings for configuration articles (#444) 2017-07-20 18:47:28 +02:00
editors.md [Editors] Add LSP to VS Code section (#550) 2017-11-06 01:29:36 +01:00
habmin.md Add new externals, rename addons plural 2017-10-18 17:04:23 +02:00
habpanel.md updated generated content 2017-10-18 17:08:32 +02:00
index.md [Configuration] Remove occurance of "Karaf" (#471) 2017-08-30 14:01:41 +02:00
items.md [Items] Improve comprehension (#512) 2017-11-07 12:37:40 +01:00
jsr223-js.md Add initial JSR223 documentation (#428) 2017-07-14 14:07:51 +02:00
jsr223-jython.md Add initial JSR223 documentation (#428) 2017-07-14 14:07:51 +02:00
jsr223.md Added requirement for NG rule engine. (#454) 2017-07-24 12:23:57 +02:00
multimedia.md Distinguish collections, improve update process (#514) 2017-09-22 21:05:09 +02:00
packages.md Correct linter warnings for configuration articles (#444) 2017-07-20 18:47:28 +02:00
paperui.md Correct linter warnings for configuration articles (#444) 2017-07-20 18:47:28 +02:00
persistence.md [Persistence] Add improvements (#535) 2017-11-03 18:16:59 +01:00
restdocs.md [REST API] Add full article, fixes #490 (#508) 2017-09-21 23:55:30 +02:00
rules-dsl.md [Rules] Fix missing "val" in example (#531) 2017-10-16 18:33:02 +02:00
rules-ng.md [Rules NG] Update instructions and screenshots (#370) 2017-04-11 11:00:46 +02:00
services.md [Configuration] Add wrongfully deleted services.md (#460) 2017-07-26 23:56:04 +02:00
sitemaps.md [Sitemaps] Update editors recommendation (#551) 2017-11-06 01:31:15 +01:00
things.md Correct linter warnings for configuration articles (#444) 2017-07-20 18:47:28 +02:00
transform.md [Transformations] Add general usage description (#488) 2017-09-21 22:13:32 +02:00