Commit Graph

201 Commits (faf4bb1b51f672a7e2fa787af52217d4bbd18e34)

Author SHA1 Message Date
Patrick Fink 9c1fd1f6aa Fix typo (#828)
Signed-off-by: Patrick Fink <mail@pfink.de>
2018-12-17 00:26:06 +01:00
Yannick Schaus c47db236d1 Fix syntax error (#826)
Prevents `{{base}}` from being replaced by the website prepare-docs script.
2018-12-16 09:06:22 +01:00
Patrick Fink 7d271b8d8f Add initial documentation for profiles (#798)
* Add initial documentation for profiles (WIP)

Signed-off-by: Patrick Fink <mail@pfink.de>

* Style guide compliance

Signed-off-by: Patrick Fink <mail@pfink.de>

* Convert profile descriptions into a table and add `rawbutton-toggle-switch` Profile

Signed-off-by: Patrick Fink <mail@pfink.de>

* Add missing profiles

Signed-off-by: Patrick Fink <mail@pfink.de>

* Proofread

Signed-off-by: Patrick Fink <mail@pfink.de>

* Add profile usage example

Signed-off-by: Patrick Fink <mail@pfink.de>

* Style improvements

Signed-off-by: Patrick Fink <mail@pfink.de>

* Improve offset description

Signed-off-by: Patrick Fink <mail@pfink.de>

* Improve syntax scheme

Signed-off-by: Patrick Fink <mail@pfink.de>

* Removed double sentence

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2018-12-16 09:04:34 +01:00
Dmitry Kann 90ff8b7b04 More straightforward example rules_refresh.sh (#820)
* More straightforward example rules_refresh.sh

* Use environment var for config directory location

Signed-off-by: Dmitry Kann <yktooo@gmail.com> (github: yktoo)
2018-12-04 06:54:07 -05:00
Rossko57 018079c083 Update items.md (#799)
* Update items.md

extra detail for numeric dynamic icons

* Update items.md

Okeydoke, I have suggested a similar form of words

* Update items.md

akk, typo fixed.  Also tidied blank line.
2018-12-01 22:18:32 +01:00
Christoph Weitkamp 61222b4de1 Update items.md (#819)
- Fixed links to bindings.

Signed-off-by: Christoph Weitkamp github@christophweitkamp.de
2018-12-01 22:16:50 +01:00
vzorglub 039399b080 Update sitemaps.md (#818)
Corrected spelling typo
2018-12-01 11:01:11 +01:00
cubistico 0e418f75c2 Update editors.md (#816)
* Update editors.md

Added BBEdit to the list

Signed-off-by: Metin Savignano ms@savignano.net (github: cubistico)

* Update editors.md

Added BBEdit to the list, added a new line

Signed-off-by: Metin Savignano ms@savignano.net (github: cubistico)
2018-11-21 23:04:17 +01:00
Markus Storm 0d807829bc minor clarifications to Thing/Items config (#807)
* minor clarifications

* "*" => "R" for recommended options

* bad link to Homebuilder

* Update index.md

* wording improved

Signed-off-by: Markus Storm markus.storm@gmx.net (github: mstormi)
2018-11-09 18:42:46 +01:00
Filippo Fontanelli 26c10bef12 Fix typos link to reference (#805) 2018-11-05 20:53:05 +01:00
Filippo Fontanelli 438d6a34b3 Fix typos on file path (#804) 2018-11-05 20:52:50 +01:00
Patrick Fink 227196c739 Fix indent and section names in binding config (#795)
Signed-off-by: Patrick Fink <mail@pfink.de>
2018-10-22 19:39:13 +02:00
Sinclair-John cc01c8f81d Fix typo (#791)
Add missing "
2018-10-20 09:31:40 +02:00
Leroy Förster f03cd1ff75 Fix math for converting ColorItem HSBTypes to RGB (#743)
Added a step to divide by 100, changed 16^2 to 2^16-1 and fixed the example.

Signed-off-by: Leroy Förster <gersilex@email.com> (github: gersilex)
2018-10-15 19:04:50 +02:00
patmalcolm91 bafa211635 Update sitemaps.md (#787)
Fixed two minor typos.
2018-10-14 11:34:24 +02:00
imtheuser 209ad63600 Updated Section DateTime Item (#784)
* Updated Section DateTime Item

The program code suggested in the documentation in section "// Convert DateTimeType to Joda DateTime" did not work for me.
@rkoshak proposed two options in this post:
https://community.openhab.org/t/error-timeinmillis-is-not-a-member-of-java-time-zoneddatetime/53079/3
Both worked for me.
I have therefore replaced the existing code with rlkoshak's two options.

* Update rules-dsl.md

Signed-off-by: Rudolf Allgaier <meinpcpostfach@yahoo.de>
2018-10-14 11:30:00 +02:00
Christoph Weitkamp f35adf387a Added example for Location Item pattern (#774)
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2018-10-01 17:21:17 +02:00
Wouter Born 2803603919 Fix configuration file path references (#779)
* Replace 'config/' and 'conf/' with '$OPENHAB_CONF/'

Signed-off-by: Wouter Born <eclipse@maindrain.net>

* Replace ${openhab.home} with $OPENHAB_HOME in compatibilitylayer.md

Signed-off-by: Wouter Born <eclipse@maindrain.net>
2018-10-01 17:19:56 +02:00
Henning Treu 4e8ac7a789 Change group function EQUAL to EQUALITY (#783)
Relates to https://github.com/eclipse/smarthome/pull/6278.

Signed-off-by: Henning Treu <henning.treu@telekom.de>
2018-10-01 17:13:49 +02:00
Wouter Born 580f30917c Rename all variants to macOS (#778)
Signed-off-by: Wouter Born <eclipse@maindrain.net>
2018-09-18 19:35:39 +02:00
Wouter Born 35a0986f6e Fix add-ons file path references (#780)
The add-ons JAR and KAR files are stored in a directory named "addons" and not "add-ons".

Signed-off-by: Wouter Born <eclipse@maindrain.net>
2018-09-18 19:32:03 +02:00
Scott Rushworth 813e1e5ea0 Corrected Thing Status Action link (#777) 2018-09-18 19:29:31 +02:00
Markus Storm 6dc2cae7d9 added recommendations which interfaces to use (#757)
* added recommendations which interfaces to use 

Signed-off-by: Markus Storm markus.storm@gmx.net (github: mstormi)

* Beautification

Signed-off-by: Markus Storm markus.storm@gmx.net (github: mstormi)

* Confectrician's review

* linebreak removed

* addons link corrected

* typo

* Reworked recommendations table

* minor recommendation table change

* VS code extensions for syntax checking of items and sitemaps

* addons link corrected

* minor wording changes

* clarify recommendations

incorporated 5iver's comments
added recommendation column
wording changed to clarify conflict files vs. UI

* simplified comments in table

* typo

* changed recommendation on addons

* improved column naming

* beautification

* fixed links

* removed include directive

* typo

* most OH1 bindings require config in *.cfg

* Added homebuilder to comparison

* small enhancement on Homebuilder

* Update index.md
2018-09-14 00:09:07 +02:00
Raj Shah 67cd769af3 FIX TYPO IN ITEMS CONFIGURATION (#772) 2018-09-04 09:46:50 +02:00
Rosi2143 95d20a7978 replace .calendar with .zonedDateTime (#762)
getCalender() is deprecated getZonedDateTime() should be used
2018-09-04 09:46:22 +02:00
William Leemans 2e087ec708 wrong method (#771) 2018-09-04 09:45:13 +02:00
Christoph Weitkamp df1a5d2949 Added 'playStream()' function (#767)
- Added 'playStream()' function
- Fixed linter errors

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2018-09-01 16:08:48 +02:00
Richard Koshak 1b8ce6d7ce Added documentation for Member of Rule triggers (#759)
This applies to OH 2.3, not sure how to back port it.

While I was here, I also added a warning that if one uses received command, one cannot use ItemName.state and should instead use receivedCommand.

Signed off by Richard Koshak <rlkoshak@gmail.com>

Addresses #758
2018-08-19 17:32:05 +02:00
Arnold 0a7386d7b7 Update items.md (#760)
Fixed the link to the classic icons
2018-08-19 17:29:13 +02:00
mgf909 e2f5ceec83 Update addons.md (#753)
fix typo
2018-08-07 11:51:37 +02:00
Scott Rushworth d05ca45cc4 Update jsr223-jython.md to include changes form ESH PR #5953 (#751)
Signed-off-by: Scott Rushworth openhab@5iver.com (github: openahb-5iver)
2018-08-06 23:40:12 +02:00
Thomas Dietrich 8ecb3f9055 [Sitemap] Remove duplicate sentence (#747)
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2018-07-17 21:38:29 +02:00
Sam B 5079461954 Typo "MyTimes" instead of "MyItems" (#744) 2018-07-15 12:25:25 +02:00
Christoph Weitkamp b7814c7a8b Moved documentation for audio & voice actions to multimedia section (#742)
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2018-07-14 08:30:11 +02:00
Jerome Luckenbach c2293a1eff
Fixed some links. (#741)
* Fixed some links. Closes #732.

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

* Added Anchors.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2018-07-13 22:14:47 +02:00
Josar 0987df46f6 items.md: override labels (#738)
* 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>
2018-07-12 16:43:21 +02:00
Scott Rushworth cb42e0abe4 Update jsr223.md (#739)
Signed-off-by: Scott Rushworth openhab@5iver.com (github: openhab-5iver)
2018-07-12 13:35:25 +02:00
Jerome Luckenbach 0b51686ea6
Fixed wrong url hash
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2018-07-08 23:04:27 +02:00
Dom Quixote e63e744ce7 Clarify Contact Items (#698)
* 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>
2018-07-08 16:39:24 +02:00
Mark Herwege f9b4d3af7f Replace Smarthome designer by VS Code Extension (#726) 2018-07-08 16:39:24 +02:00
Christoph Weitkamp 1f46424e1e [configuration] Revert #723 partially (#724)
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2018-07-08 16:39:24 +02:00
Christoph Weitkamp 95e3d0aa91 Added 'everyMinute' strategy to examples (#723)
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2018-07-08 16:39:24 +02:00
Yannick Schaus 8da1ebcfc3 Fix link to MQTT doc in configuration/addons.md
Signed-off-by: Yannick Schaus <habpanel@schaus.net>
2018-06-14 17:47:10 +02:00
Jerome L 876b9a8e60
Improved addons title and url. (#718)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2018-06-13 15:09:20 +02:00
Yannick Schaus 7cc4ae5d40 Add-ons installation: correct links to mqtt doc (#719)
Signed-off-by: Yannick Schaus <github@schaus.net>
2018-06-13 15:09:08 +02:00
Jerome L b1c16a3179
[configuration/addons.md] Initial commit (Moved from deprecated addons page) (#715)
* Moved addons installation article to a new page and edited headline hierarchy.

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

* s/{{base}}/\/docs/g

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

* s/images/.\/images/g

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2018-06-13 14:17:56 +02:00
Kai Kreuzer 76a85507d9 [configuration/rules-dsl.md]fixed formatting (#692)
* fixed formatting

* sentences on new lines, also escaped single units
2018-06-03 11:30:51 +02:00
Kai Kreuzer e84accec22
updated generated content
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2018-05-27 11:26:49 +02:00
Stefan Triller 20de280a6a Document new transformRaw command in rules (#687)
* Document new transformRaw command in rules

Signed-off-by: Stefan Triller <stefan.triller@telekom.de>
2018-05-25 16:41:58 +02:00
Yannick Schaus 65ace38eec Remove space in group aggregation function example (#683)
Signed-off-by: Yannick Schaus <github@schaus.net>
2018-05-22 19:31:52 +02:00
Ben Clark af38f4135f Correct link in sitemaps page (#679)
Signed-off-by: Ben Clark <ben@benjyc.uk>
2018-05-21 18:53:46 +02:00
Henning Treu f5eded6370 Add QuantityType conversion to rules documentation (#675)
Signed-off-by: Henning Treu <henning.treu@telekom.de>
2018-05-14 20:47:40 +02:00
Thomas Karl Pietrowski 19b628d62d [configuration/items.md] Correcting label in table of types (#667)
Signed-off-by: Thomas Karl Pietrowski thopiekar@gmail.com (github: thopiekar)
2018-04-18 14:15:44 +02:00
Hoernchen20 3bdd2e13f4 [configuration/persistence.md]Update persistence.md (#654)
Update the "rules_refresh.sh " script to a working one. There was a high comma too much and i think in this version, the for loop is more readable for beginners.
2018-04-07 10:13:25 +02:00
Rossko57 c2ed4f9d5b [configuration/items.md] Item names must start with alpha (#653)
Empirically, Item names starting with numbers do not work in rules.
Not clear to me if that is by design or a deficiency.
See forum https://community.openhab.org/t/rule-with-item-that-starts-with-a-number-not-running/41608/7
2018-03-20 09:41:28 +01:00
Christoph Weitkamp 229544ad4b Documentation for new parameter to adjust the volume (#644)
* Added parameter to adjust the volume

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>

* Added 'volume' parameter in the runtime section

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>

* Removed volume parameter for 'stream()' methods

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2018-03-14 14:20:47 +01:00
amorsillo 9e9413cc9b [Config] Add JsonDB link and clarify write direction (#621)
Clarify that GUI configuration operations are not hidden away in a binary database.

Signed-off-by: Andrew Morsillo <imagio@protonmail.com> (github: AndrewMorsillo)
2018-02-06 13:53:15 +01:00
RunarHanssen 2b211b3cea Update persistence.md (#631) 2018-01-21 22:14:11 +01:00
Kai Kreuzer 2defd2204f
updated generated content
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2018-01-18 10:39:19 +01:00
ConfusedTA 5597733082 [configuration/rules-dsl.md] Textual Rules -> Rule Name Uniqueness (#627)
* Textual Rules -> Rule Name Uniqueness

Add information on requirement for uniqueness of rule names.

Signed-off-by: Garry Mitchell garrymitchell@my105e.com (github: ConfusedTA)

* Textual Rules -> Rule Name Uniqueness

Amended per suggestions to include rule details as a list, tweak of wording, and amendment of sample rules to follow suggestion of wrapping quotes around rule names.

Signed-off-by: Garry Mitchell garrymitchell@my105e.com (github: ConfusedTA)

* Textual Rules -> Rule Name Uniqueness

Amend rule syntax, make syntax sections into a list.

Signed-off-by: Garry Mitchell garrymitchell@my105e.com (github: ConfusedTA)

* Textual Rules -> Rule Name Uniqueness

Updated based upon suggestions to further clarify points.

Signed-off-by: Garry Mitchell garrymitchell@my105e.com (github: ConfusedTA)

* Update rules-dsl.md
2018-01-16 17:14:06 +01:00
Thomas Dietrich c4db6d7786 Adopt openhab-android repo name, fixes #613
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2018-01-07 17:38:02 +01:00
mod42 d2c3b160be [rules-dsl.md] Changed some typos in the createTimer sample code (#608) 2017-12-30 20:05:36 +01:00
Jason Jones 05b1e854c1 Added triggeringItem to Implicit Variables section
Signed-off-by: Jason Jones <jmsjones@gmail.com>
2017-12-30 14:23:21 +01:00
Gabriel Klein 0c1331cbf1 Added some documentation on how to have access to the REST API documentation. (#595)
Signed-off-by: Gabriel Klein <gabriel.klein@nuage.ch> (github: gabrielklein)
2017-12-19 10:08:52 -05:00
Thomas Dietrich 190bd935f9 Add Home Builder and Android app articles from external repos (#594)
* Add homebuilder to maven chain
* Add android app docs to maven chain
* Correct homebuilder URL
* Introduce maven logging into process script
* Fix linter warnings in update script
* Add first copy of homebuilder article
* Add Home Builder to menu and packages

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-12-16 22:04:24 +01:00
Kai Kreuzer a459e002c1 [configuration/editors.md] removed designer from the editor list and moved network preparations … (#592)
* removed designer from the editor list and moved network preparations to the top as this is relevant for all editors

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

* addressed review feedback

Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-12-16 15:57:50 +01:00
Mike Kolcun cd63216c95 [configuration/items.md]Fix broken links, remove absolute links (#580)
* 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
2017-11-29 15:46:09 +01:00
Thomas Dietrich 081d045d07 [Sitemaps] Remove iOS colors warning (#574)
Related to https://github.com/openhab/openhab.ios/pull/131

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-11-23 17:54:15 +01:00
Jerome L d91a7e9c7c
[rulse-dsl.md]Added trigger channel section (#572)
* Added trigger channel section to rules-dsl.md

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

* Review based changes

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

* Adressed last Review comments

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2017-11-22 18:34:22 +01:00
axxelG 6b900fc36a [configuration/persistence.md]Fixed broken link to rules article (#571)
Fixed one broken url to the rules-dsl.md file
2017-11-19 21:04:22 +01:00
Kai Kreuzer 409fdaa5b6 [Editors] Update Designer download information (#568)
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-11-16 18:39:10 +01:00
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