* Additional improvements to persistence article
Addressing comments left over from #527
- Changed that -> than
- Resolved clashing headlines
- Strategies section: added `default` and explained its operation
- Changed persistence extensions from code block to itemized list
* Improve readability of Strategies and Items sections
- Reworded some of tne introductory material
- Reorganized and changed some sub-section titles in Strategies and Items area to improve comprehension.
- Item Persistence Configuration -> Persistence Configuration
- Added Persistence Trigers section
- Strategies section -> Strategies
- Items section -> Items
- Addressed comments by @Confectrician
* Address numerous comments from @ThomDietrich
- Deleted one configuration headline
- Added intro sentence to configuration section
- Combined all text about default in one section of the document
- corrected cronexpression angle bracket error
- added code fence around everyChange, etc.
- Removed detail of Quartz stuff and just added a pointer to Rules article
- Replaced "persist everything" example to persisting Heating_Mode, etc..."
- Added example of how default works.
* Finishes "nit" pass through Persistence article
- Numerous small changes to improve readability
* Expand explanation of how one may specify persistence for an Item
- Existing text was not clear about the syntax one would use with a Persistence Extension in order to specify a persistence store in cases where multiple stores are available.
- Clarified language and added an example.
* Correct formating of Persistence Extensions
- Removed extra lines
- Added code fences
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Format Persistence Extensions as a table
- Changed Persistence Extensions section from a non-enumerated list to a table
- Fixed a spelling error in the section on restoring items after a restart
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Fix markdown table style
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Updated mismatching Screenshots for the kitchen temperature Item
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
* Added MapView Sitemap element (includes update of the demo sitemap comment)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
* Corrected demo sitemap comment for kichen temperature too.
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
* Changes due to Review from @ThomDietrich.
Generalized Screenshot dimesnions.
Added link to the OSM page.
Corrected Mapview spelling.
Moved Mapview section to another position based on the popularity.
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
* Sitemaps: improve comprehension
- made changes to improve comprehension in introduction
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Concepts: improve readability
- A few minor word changes are recommended
- Some slight changes to punctuation
* Special Element Sitemap: improve comprehension
- Eliminated redundant statement about sitemapname and filename
- Introduced the term "shall", which indicates that no other choice except the one described is acceptable
* Element Types: improve comprehension
- numerous changes to wording to improve comprehension
- Addressed PR #523 regarding HLS video element
* Mappings: improve comprehension
- some changes to improve reader comprehension
* Mapping: Add reference to Items/command-vs-status
- Removed text in mapping article that mentions command vs. status
- Added command vs. status to my PR on items.md
- Added reference to the items.md section in this document.
This way we have only one place where this point is discussed.
* Color: improve comprehension
- various changes to increase comprehension
* Address comments received
- "Renders an Item as a ON/OFF..." changed to "Renders an Item as an ON/OFF..."
- "Renders an Item in as text changed to "Renders an Item as text".
- Capitalize Item in two occurances
- Remove term, "However..."
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Update persistence.md
- updates persistence.md by adding content from old wiki article
- removes references to old wiki article
- addresses #524
* Address comments from @ThomDietrich
- See GitHub Conversation page for comments addressed.
* Capitalize all instances of "Item"
- Capitalized all instances of "Item"
- Did NOT capitalize all instances of "items"
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)
* 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)
fixes misconfigured links to "Linux article" and "openHABian" in "Networks preparation" chapter
Simple fix exception: Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
The change of the code is at https://github.com/eclipse/smarthome/pull/3001
After this commit, the end user can find the documentation about how to react
to thing status change in the rule.
Bug: #517
Incorporate more pull request feedback.
Signed-off-by: Maoliang Huang <hellomao@outlook.com>
* Add Linux/MacOSX backup and restore instructions
Signed-off-by: Ben Clark <ben@benjyc.uk>
* Change to absolute path references
Signed-off-by: Ben Clark <ben@benjyc.uk>
* add section on type conversion
Addressing issue #472 and incorporating discussions from PR #469; work is based in contributions by @rkoshak https://community.openhab.org/t/type-conversions/32684
Fixed html anchors; changed text regarding example rules at the end to match new content
* added more webhooks, fixed URL
Added some more webhooks
Fixed URL to use {{base}}
* more text clean-up
Tightening of text, adherence to one line per sentence rule, etc
* moved text, adjusted heading levels, added example
Moved proposed text to immediately after "Manipulating item states", adjusted header levels to match new location, added example to PointType using strings
* improved formatting, common structure, switch text
Added blank lines around code blocks, added text to Switch Item to make it stand-alone, improved common structure; deleted all examples of use of postUpdate and sendCommand as they are already dealt with in section above.
Signed-off-by: Markus Lipp lipp.markus@gmail.com (github: LightIsLife)
* Add transformations section to rules-dsl
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Attend to comments, part 1
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Attend to comments, part 2
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Attend to comments, part 3
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Rename collection folders
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Change all occurences of addons and repos
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Add further corrections
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Remove temporary directories after processing
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Reduce addons menus, show current uncond.
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Fix typo
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Remove redundant addons from permalinks
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Sort UI menu entries correctly
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Split maven command
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
Closes#200
* initial edits
Added detail to iOS app page, including feature list, screenshots, and
brief setup instructions
* Initial edits
Reference issue 200, added feature list, screenshots, and getting
started instructions.
* Updates per review
Fixed some grammar and formatting issues, provided more accurate
description of app’s remote capabilities, and fixed image width display.
Signed-off-by: Tom Nerison captomner@gmail.com (github: dome2048)
* Add a few corrections
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* describe REST API
describe the value of the REST API and showcase the possibilities; replacing entire current content;
Signed-off-by: Markus Lipp lipp.markus@gmail.com (github: LightIsLife)
* addressing review comments
Addressing all review comments:
- changed generic ip
- adapted opening sentence
- linked to OH2 security chapter
- re-added comment on push-service
various editorial edits
Signed-off-by: Markus Lipp lipp.markus@gmail.com (github: LightIsLife)
* typos and grammar fixes from review
Fixed typos and grammar mistakes; added sentence that all curl and other commands are displayed in REST API as a response to "Try me out"
Signed-off-by: Markus Lipp lipp.markus@gmail.com (github: LightIsLife)
* more typo, style and grammar fixes
Missed some typos, re-arranged a few sentences for better flow; fixed punctuation (hopefully)
* intro more concise; review comments addressed
Signed-off-by: Markus Lipp lipp.markus@gmail.com (github: LightIsLife)
* Add general usage description to Transformations
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Update transformations.md
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Update transformations.md
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Add content to transform config article
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* 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)
* Adding description on using sendCommand/postUpdate
The use of sendCommand and postUpdate in rules is explained with an emphasis on discouraging the generic method sendCommand(Item,arg) over the method Item.sendCommand(arg) that provides much more reliable type conversions. Details as to the background have been added
Signed-off-by: lipp.markus@gmail.com (github: LightIsLife)
* Adding description on using sendCommand/postUpdate fixes#185#469
Addressing comments by @rkoshak on commit 042dae745c
Signed-off-by: lipp.markus@gmail.com (github: LightIsLife)
* Updating language/editorial changes
Some editorial changes throughout, and added more consistency in the use of "" where new_state has to be a string (in actions) and no quotation marks where this is not mandated (in methods).
Signed-off-by: Markus Lipp <lipp.markus@gmail.com> (github: LightIsLife)
* Addressing comments made
Addressing all comments by @ThomDietrich: sentences are shortened and simplifies, heading capitalized and modified, text overall slightly shortened, etc
* fixed typo
just fixing a few typos
* made sentences shorter
Sentences shortened to address comments received
* one line per sentence reformatting
Adjustment as per style convention to each sentence begins on its own line
* Add some further clarification
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* moved section to scripts, deleted details
Addressing comments by @thomdietrich.
Moved the whole new section (Manipulating item states) into exisiting section "Scripts"
Deleted the paras under "Details"
bgilmer77
Jerome L
Kai Kreuzer
Christian Häussler
Thomas Dietrich
Eric Schiesser
Holger Reichert
sihui
kceiw
Ben Clark
Markus Lipp
dome2048
mueller-ma
Svilen
Hakan Tandogan