Commit Graph

80 Commits (2b3586399eca74288e040cb6a52e79e5f0c5b402)

Author SHA1 Message Date
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
Thomas Dietrich b2ae52ce68
[Sitemaps] Update editors recommendation (#551)
* Fix syntax error and editors change

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>

* Fix typo

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-11-06 01:31:15 +01:00
Jerome L 77afb85cea [Editors] Add LSP to VS Code section (#550)
* Added Marketplace link.\n Corrected image alt tag.\nImproved installation section to marketplace install.\nAdded section about rule validation with a link to the vscode repo readme file.

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

* Added list item 0 in the installation instructions

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

* Correct list marker

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-11-06 01:29:36 +01:00
bgilmer77 4a51317763 [Sitemaps] Additional improvements (#542)
* Additional improvements to sitemaps.md

-  Addresses most of @ThomDietrich comments in #528
-  See #528 for open items and questions

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

* Address numerous comments in #528

-  This commit addresses all but one of @ThomDietrich comments from #528

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

* Address remaining comments from @ThomDietrich in #542

-  Verified that Slider Items and Setpoint Items do NOT work with Switch Things. Removed text hinting that this was possible.
-  Added back text about visibility working with OR conditions but not with AND conditions

* Remove example from Label and Value Colors section

-  Deleted example and graphic from Label and Value example.  The explanations and the graphic did not match, and contained errors.

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

* Correct error in link in Dynamic Sitemaps section

-  Corrected syntax error in "dynamic icon" link

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

* Correct link syntax in Dynamic Sitemaps section

-  Corrected link syntax (again)

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)
2017-11-05 18:46:18 +01:00
bgilmer77 cd91117882 [Persistence] Add improvements (#535)
* 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)
2017-11-03 18:16:59 +01:00
Jerome L a215d77be9 [Sitemaps] Add MapView, correct mismatching screenshots (#533)
* 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>
2017-10-30 14:47:58 +01:00
bgilmer77 4e66f16eb2 [Sitemaps] Improve comprehension (#528)
* 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)
2017-10-24 14:24:42 +02:00
bgilmer77 177101f25d Add and update persistence article (#527)
* 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)
2017-10-20 13:35:07 +02:00
Kai Kreuzer f1727cae7b
updated generated content
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-10-18 17:08:32 +02:00
Thomas Dietrich f0487deb5d Add new externals, rename addons plural
* openHABian USAGE
* alexa-skill USAGE
* mycroft-skill USAGE
* HABPanel config article

persistence -> persistences
io -> ios

Many minor changes to articles

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de>
2017-10-18 17:04:23 +02:00
Eric Schiesser 825f967966 [Rules] Fix missing "val" in example (#531)
without sign-off. minor patch exception
2017-10-16 18:33:02 +02:00
bgilmer77 f41193eb52 [Items] Add section on Item state, fixes #507 (#515)
* 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)
2017-10-09 12:18:53 +02:00
Holger Reichert 46847e4c1f [Sitemaps] Add description for charts legend parameter (#518)
Signed-off-by: Holger Reichert <mail@h0lger.de>
2017-10-08 19:58:38 +02:00
sihui ac2f8dc7e3 [Editors] Fix internal links (#519)
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)
2017-10-02 15:20:42 +02:00
kceiw a08044120d [Rules] Add chapters on thing status in actions and rules (#463)
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>
2017-09-26 12:08:50 +02:00
Markus Lipp 51a69535ad [Rules] Add section on type conversion, fixes #472 (#483)
* 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)
2017-09-24 22:58:34 +02:00
Thomas Dietrich 787295ff25 Add transformations section to rules-dsl (#513)
* 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>
2017-09-22 21:20:58 +02:00
Thomas Dietrich 826ef4abb4 Distinguish collections, improve update process (#514)
* 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>
2017-09-22 21:05:09 +02:00
Markus Lipp 813eb59f30 [REST API] Add full article, fixes #490 (#508)
* 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)
2017-09-21 23:55:30 +02:00
Thomas Dietrich 07fb3f75a3 [Transformations] Add general usage description (#488)
* 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>
2017-09-21 22:13:32 +02:00
Thomas Dietrich 7c4f3ab0c6 [Sitemaps] Revise article, add element examples (#493)
* Revise sitemap article, add examples

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

* Update selection

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-09-21 19:36:05 +02:00
Thomas Dietrich a8012fd0f0 [Items] Revise complete article (#494)
* 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>
2017-09-19 12:58:59 +02:00
Thomas Dietrich bbcd167f0b
[Items] Clarify Dynamic Icons chapter
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-09-04 01:30:19 +02:00
Thomas Dietrich 3da6cb6364 [Items] Remove invalid mapping info for dyn. icons (#489)
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-09-04 00:47:43 +02:00
Jerome L c51f07d584 [Editors] Small fixes (#485)
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)
2017-08-31 21:03:53 +02:00
Thomas Dietrich ebb74aa0a4 [Configuration] Remove occurance of "Karaf" (#471)
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-08-30 14:01:41 +02:00
Jerome L 0cd2cd15c0 [Configuration] Move Syntax Highlighting page from old wiki (#434)
* 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)
2017-08-27 12:56:55 +02:00
Markus Lipp e13c4885af [Rules DSL]Add sendCommand/postUpdate clarification, fixes #185 (#469)
* 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"
2017-08-27 12:07:33 +02:00
Robert 7e07c372bb [Sitemaps] Note about use of named colors and iOS app (#478)
* Note about use of named colors in iOS app.
Fixes #292

Signed-off-by: Robert van Bregt <robert@robertvanbregt.nl> (github: metbril)

* One line per sentence.

Signed-off-by: Robert van Bregt <robert@robertvanbregt.nl> (github: metbril)
2017-08-19 21:42:44 +02:00
Kai Kreuzer b8dc13d6ad [Sitemap] Clarified that item is mandatory for a group (#470) 2017-08-09 10:24:16 +02:00
Simon Kaufmann b061e1d043 [Rules] Add documentation of early returns (#457)
Signed-off-by: Simon Kaufmann <simon.kfm@googlemail.com>
2017-07-27 13:01:43 +02:00
Thomas Dietrich 7454b15ad5 [Configuration] Add wrongfully deleted services.md (#460)
This was a silly mistake while cleaning up in f18348d0f2

Resolves #459

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-07-26 23:56:04 +02:00
Steve Bate 6775de5567 Added requirement for NG rule engine. (#454)
* Added requirement for NG rule engine.

Signed-off-by: Steve Bate <svc-github@stevebate.net> (github: steve-bate)
2017-07-24 12:23:57 +02:00
Thomas Dietrich f18348d0f2 Correct linter warnings for configuration articles (#444)
* 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>
2017-07-20 18:47:28 +02:00
Steve Bate 7ad0c7ce93 Add initial JSR223 documentation (#428)
Signed-off-by: Steve Bate <svc-github@stevebate.net> (github: steve-bate)
2017-07-14 14:07:51 +02:00
Isaac I.Y. Saito 38ab13f154 [restdoc] Elaborate installation of local rest api doc. (#406)
Being new to OpenHAB, I had to spend half an hour to find how I can install and where I can see the rest api doc.
2017-07-06 17:44:16 +02:00
bgilmer77 efb92a8934 [Rules] Add note on 'System started' trigger (#416)
* Add note on 'System started' trigger

The 'System started' trigger causes actions to execute when the system is started (i.e. a reboot).  But the trigger also fires when alterations are made to any rules files.  This could lead to unanticipated system behavior, since users may expect that the only time the trigger would fire is when the system initializes for the first time.

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

* Clarify description of system-based triggers

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

* Correct openHab to openHAB

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

* Modifed per comments by @ThomDietrich

Signed-off: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)
2017-07-06 17:39:52 +02:00
Kai Kreuzer 4fa5c4b1ec Add documentation about Eclipse IoT Marketplace integration (#415)
* added documentation about Eclipse IoT Marketplace integration

Signed-off-by: Kai Kreuzer <kai@openhab.org>

* addressed review comments

Signed-off-by: Kai Kreuzer <kai@openhab.org>

* fixing the right occurance this time

Signed-off-by: Kai Kreuzer <kai@openhab.org>

* addressed review comments

Signed-off-by: Kai Kreuzer <kai@openhab.org>

* bought a "c"

Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-06-27 18:35:06 +02:00
Stefan Triller d25eba9003 [Items] Corrected default behavior for group functions (#373)
* 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)
2017-06-21 12:42:00 +02:00
Thomas Dietrich 47e4f3121b [Items] Continue items article revision, #250 (#404)
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 #402
Resolves #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>
2017-06-19 17:55:32 +02:00
Richard Koshak 40c8a07e0e [Items] Include first article revision (#250)
* 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)
2017-06-17 18:05:22 +02:00
lolodomo 8f0ccf5d60 [Sitemaps] Chart element: value "2D" accepted as period (#394)
Mention about not working refresh parameter for chart suppressed as it was fixed recently in Basic UI

Signed-off-by: Laurent Garnier <lg.hc@free.fr>
2017-06-14 12:43:01 +02:00
lolodomo d56799feb4 [Sitemaps] Image element can refer to an Image item (#396)
Fix #395

Signed-off-by: Laurent Garnier <lg.hc@free.fr>
2017-06-14 12:41:24 +02:00
Eamonn O'Connell f79c8999f9 [Sitemaps] Fix small typo (#380)
Signed-off-by: Eamonn O'Connell <eamonnoconnell@gmail.com> (github: halfbaked)
2017-05-03 16:00:25 +02:00
Thomas Dietrich a7fd22a985 [Rules] Add a better online generator
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-04-13 14:38:17 +02:00
Eamonn O'Connell 624094ba0c [Rules NG] Update instructions and screenshots (#370)
* Updated Rules Ng document and images to be in sync with current UI, including the
rename from Extensions to Add-ons.

Signed-off-by: Eamonn O'Connell <eamonnoconnell@gmail.com> (github:
halfbaked)

* Improved layout of rules-ng configuration 

Signed-off-by: Eamonn O'Connell <eamonnoconnell@gmail.com> (github:halfbaked)
2017-04-11 11:00:46 +02:00
stephenbonar 4eb2a26748 [Things] Add things.md config page (Closes #312) (#321)
* Added content to the Things.md configuration page (Fixes #312)

-Added an introduction section
-Added a things definition section
-Added a discovery based definition subsection
-Added a file based definition subsection
-Added a syntax subsection

Signed-off-by: Stephen Bonar <contactme@stephenbonar.com> (github: stephenbonar)

* Revision of the article

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-03-07 15:44:55 +01:00
ShaunCurrier fa1db4a1d6 [Sitemap] Fix demo.sitemap link (#348) (#349)
Before fix, link was 404.
Signed-off-by: Shaun Currier <shaun.currier@gmail.com> (github: ShaunCurrier)
2017-02-26 14:26:09 +01:00
Angelos Fountoulakis e6b38b21d2 [Sitemaps] Remove `item` parameter for Frame (#310)
Closes: #306

Signed-off-by: Angelos agf@itcs.ro (github: AngelosF)
2017-02-08 10:33:08 +01:00
Thomas Dietrich b41c4b1f40 [Configuration] Update overview after 1st draft (#253)
* Remove all draft notes

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

* Update index.md

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

* Remove other UIs

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

* Fix case and linebreak

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-01-31 18:41:44 +01:00