* items.md: override labels
Added information about how to override label text and state representation on sitemaps.
Signed-off-by: Josua Arndt <josuaarndt@live.de>
* Typos
* Add item override example
Signed-off-by: Josua Arndt <josuaarndt@live.de>
* Added UoM link
Signed-off-by: Josua Arndt <josuaarndt@live.de>
* Update code fences and example comments
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
* Clarify Contact
I spent hours trying to find the problem, as I was trying to send a command to a contact. I think it should be mentioned a contact item only accepts status, and the 'CommandType' should be renamed OpenClosed with a D as the status is in fact CLOSED and not CLOSE. Less confusing this way.
* Update items.md
Sign off from PR comment:
Signed-off-by: Bas Stronks bas.stronks@gmaill.com (github: DomQuixote)
* Reverted concept changes to make pr ready for merge.
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
* Revert really everything
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
* fixed broken link
updated broken link to homekit docs
* updated hue link
updated the hue link too
* use base template
replace absolute links to docs.openhab.org with the base template
* 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)
* Add Section on Item State; fixes#507
Propose to add a section on Item State to the documentation on Items to address #507.
Adding an Item state diagram would be very useful.
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Make additions visible in GitHub "View" mode
Strange - adding the TODO line caused the text below to not be visible on GitHub. Removing it.
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Correct text formatting so that each sentence is on one line
The Item State section has been reformatted so that each sentence is on its own line.
This seems to be the norm for line formatting.
Inserted a TODO regarding generating a state diagram.
* Remove TODO note
The TODO note about adding a state diagram has been removed - it seems to cause the entire new Item State section to disappear - at least in GitHub 'View' mode.
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Correct links to other relevant articles
Links were incorrect. This commit resolves the problem.
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Incorporate "Restoring State" info at end of items.md into this section
I removed the text at the end of the items.md file related to restoring state.
Incorporated them into this new section.
* Address comments from @ThomDietrich (first round)
All comments received from @ThomDietrich's first round have been addressed.
Ran linter and reformatted list items.
* Remove section on restoring states
The section on restoring states has been removed - it repeats information which is available elsewhere in the documentation.
* Address comments from Thom dated 8-OCT
- removed backticks that were used incorrectly.
- added links to Persistence and system-based-trigger articles
- removed trailing periods from list items
-
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Add naming recommendations to items article
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Follow up on comments, improve article parts
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Address further comments
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Unify example item names, add details
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Add last fixes
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Add Item types to article
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Add tagging intro and example
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Add tagging syntax example
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Rearrange and improve Dynamic Icons chapter
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Transform general Item syntax into list
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Final comments and further additions
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
Like discussed in #434:
Fixed/Improved the toc configuration for the Editors article
Fixed broken ESH Designer urls in 3 pages
Signed-off-by: Jerome Luckenbach <github@luckenba.ch> (github: @Confectrician)
* Moved Syntax Highlighting page from openhab1-addons wiki into user manual
Signed-off-by: Jerome Luckenbach <github@luckenba.ch> (github: @Confectrician)
* Cosmetic improvements according to the PR Discussion
Signed-off-by: Jerome Luckenbach github@luckenba.ch (github: @Confectrician)
* Some Improvements from the feedback of @ThomDietrich.
More to come.
Signed-off-by: Jerome Luckenbach <github@luckenba.ch> (github: @Confectrician)
* General:
Added some introduction sentences.
Updated Notepad++ "installation" section
Eclipse SmartHome Designer:
Moved ESH article from installation category to editors page.
Additionally removed the navigation menu entry and updated all references to other articles and moved used images in the now necessary folder.
Signed-off-by: Jerome Luckenbach <github@luckenba.ch> (github: @Confectrician)
* Improvement due to requested change
"First letter of a line capital pls"
Signed-off-by: Jerome Luckenbach <github@luckenba.ch> (github: @Confectrician)
* Requested Name and capital Letter changes.
Signed-off-by: Jerome Luckenbach <github@luckenba.ch> (github: @Confectrician)
* Updated mcedit section.
Signed-off-by: Jerome Luckenbach <github@luckenba.ch> (github: @Confectrician)
* - Requested changes by ThomDietrich
- Additionally shortenend the "Others" Section
Signed-off-by: Jerome Luckenbach <github@luckenba.ch> (github: @Confectrician)
* Typo correction and intro text update to current headlines.
Signed-off-by: Jerome Luckenbach <github@luckenba.ch> (github: @Confectrician)
* - Defined headanchor explicitly
- Added designer.md file with a redirection to the new editors page.
- Removed some sentences of the introduction
- Changed the "Others" headline
Signed-off-by: Jerome Luckenbach <github@luckenba.ch> (github: @Confectrician)
* Add stable anchors
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Correct linter warning ins config articles, part 1
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Finish configuration linter corrections
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Corrected behavior for group functions
Signed-off-by: Stefan Triller <stefan.triller@telekom.de>
* Break down sentences to lines
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
Continue the items article revision with all comments in #250.
The article is far from perfect. Many things still need to be added and improved.
This PR is another iteration and ready to be merged for now.
Related to #250#402Resolves#291
Next look into #373
* Add toc to sitemap article
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Reorganize Items sections
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Update introduction and syntax
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Overhaul Icons section and more
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Add multi binding section
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Edited Items document:.
* Edited Items document:
Made 'Item' and 'Group' consistently captalized
Minor grammatical and word choice corrections
Clarified the behavior of icons when used with a map
Added the table of contents
Clarified binding/linking to Items.
Signed-off-by: Richard Koshak rlkoshak@gmail.com (github: rkoshak)
* Reworked the icons section
Added a bullet list of requirements for dynamic icons.
Put the example in a table.
Added more explanation about the filename format
A few more grammatical and word choice changes
Signed-off-by: Richard Koshak <rlkoshak@gmail.com> (github: rkoshak)
Raj Shah
Arnold
Jerome Luckenbach
Josar
Dom Quixote
Yannick Schaus
Thomas Karl Pietrowski
Rossko57
Mike Kolcun
bgilmer77
Thomas Dietrich
Jerome L
Stefan Triller
Richard Koshak
itheiss
Patrick Fink