* 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)
bgilmer77
Thomas Dietrich
Jerome L
Stefan Triller
Richard Koshak
itheiss
Patrick Fink