Commit Graph

33 Commits (final-2.5.x)

Author SHA1 Message Date
Michael Rossner 6c4510dccc
add description of Ephemeris localization support (#1210)
Add a new section to describe the localization support and how-to steps

Signed-off-by: Michael Roßner Schrott.Micha@web.de
2020-05-02 14:02:29 +02:00
Christoph Weitkamp b83f2e4773
Added note about broken action (#1164)
* Added note about broken action

See https://github.com/openhab/openhab-core/issues/1374

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

* Incorporated changes from review

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

* Incorporated changes from review

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2020-03-09 21:05:12 +01:00
Christoph Weitkamp 5653044638 Changed "Joda DateTime" to "ZonedDateTime" (#1140)
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2020-01-14 20:55:51 +01:00
Jerome Luckenbach d4cc7be27e
Introduced many custom containers. (#1117)
* Refactored multiple 'Note:' occurances.

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

* Small fixes

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2019-12-27 16:18:48 +01:00
jimtng 32aeac59d4 [exec-action] Clarify the use of @@ for executeCommandLine action (#1113)
* [exec-action] Clarify the use of @@ for exec command line

Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>

* [exec-action] provided an example for both the simple case and one with space.

Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>

* [exec-action] Split paragraph.

Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>

* Fixed one line per sentence

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

* Added custom container

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

Co-authored-by: Jerome Luckenbach <github@luckenba.ch>
2019-12-27 14:15:08 +01:00
jimtng aa23558e80 [http-actions] Add documentation on new Http actions with headers (#1112)
* [http-actions] Add documentation on new Http actions with headers

Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>

* [http-actions] Add an example for HTTP action

Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>

* [http-actions] Simplify example

Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
2019-12-25 19:36:16 +01:00
Richard Koshak 31537a2f04 Clarification for where to look for other examples (#1107)
It was brought to my attention that the sentence on line 278 was not clear. I've rewritten it to address the confusion.

Signed-off-by: Richard Koshak <rlkoshak@gmail.com>
2019-12-18 22:15:39 +01:00
jimtng 048b1676c2 Fixed one typo "Sting" in HTTP Action (#1096) 2019-12-16 12:59:06 +01:00
Roberto Barbero 1327df9de0 Corrected misspelling (#1080)
Corrected 'concatination' for 'concatenation'
2019-11-14 20:13:16 +01:00
Richard Koshak 273b196a9e Documentation for the new Ephemeris capability. (#1074)
* Documentation for the new Ephemeris capability.

Signed-off-by: Rich Koshak <rlkoshak@gmail.com>

* Addressed comments from Confectician and cweitkamp

Signed-off-by: Rich Koshak <rlkoshak@gmail.com>

* Added to separate dyas of the week with a comma in the list.

Signed-off-by: Rich Koshak <rlkoshak@gmail.com>
2019-11-13 01:24:03 +01:00
maniac103 bfcda52f41 Clarify cloud notification action documentation (#824)
Add more concise parameter description, and document the action variants that accept an icon and a severity level.

Signed-off-by: Danny Baumann <dannybaumann@web.de>
2019-03-10 19:05:10 +01:00
fuslwusl fed161b4ac Fix compare with null to !== instead of != (#867) 2019-01-13 11:50:09 +01:00
vzorglub 3ebc334b70 Added note in Http Actions about timeout parameter (#844) 2019-01-04 15:48:06 +01: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
Richard Koshak 75b3554254 Added docs for missing core actions (#769)
Added description for executeCommandLine, callScript, and transform Actions. 

Addresses #768 

Signed off by Rich Koshal <rlkoshak@gmail.com>
2018-09-01 16:13:52 +02:00
vzorglub a3f8fdd980 Added space before timer Lambda (#745)
Signed-off by Vincent Regaud <vzorglub@gmail.com>
2018-07-15 12:26:06 +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
Tomtibo a3544e1603 Update actions.md (#699) 2018-06-07 08:27:00 +02:00
Kai Kreuzer 33b5b3b782 [addons/actions.md] fixed typo (#672) 2018-05-03 23:22:39 +02:00
Chip Rosenthal 6644c52ffd [addons/actions.md] Fix sentence fragment (#633)
There is a sentence fragment in the "Event Bus Actions" section which makes the text non-understandable.

I added what I believe is the missing text to complete the sentence. Can a subject matter expert review?
2018-01-22 22:57:33 +01:00
Brad Gilmer 3818baba84
[actions] Add notification actions (#587)
* [actions] Add notification actions
- added three notification actions

Signed-off-by: Brad Gilmer <brad@gilmer.tv>

* Correct linter errors

Signed-off-by: Brad Gilmer <brad@gilmer.tv>

* Add a pointer to info at www.myopenhab.org

Signed-off-by: Brad Gilmer <brad@gilmer.tv>

* Correct syntax errors
-  Replaced angle brackets with quotes
-  Still have a problem in jekyll with example code block rendering on my system

Signed-off-by: Brad Gilmer <brad@gilmer.tv>

* Change example and accompanying text

Signed-off-by: Brad Gilmer <brad@gilmer.tv>

* Address @Thomdetrich comments
-  Changed heading to Cloud Notification Actions
-  Changed to refer to openHAB Cloud instance
-  Removed specific reference to myopenHAB.org
-  Deleted example

Signed-off-by: Brad Gilmer <brad@gilmer.tv>

* Add short intro to Installable Actions sectiony

Signed-off-by: Brad Gilmer <brad@gilmer.tv>

* Moved Cloud Actions up to a main heading
- Add example on apartment front door notification

Signed-off-by: Brad Gilmer <brad@gilmer.tv>
2018-01-09 16:42:26 -05:00
Thomas Dietrich f1ff041c71 Update addons article links
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-11-15 07:27:58 +01: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
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
Richard Koshak c6cc435ddd [Actions] Initial addition of core actions. (#397)
* Initial addition of documentation for core actions.

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

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

* Making Thom's requested changes.

- fixed spelling of specified
- added missing itemization * to logging section.
- added missing itemization * to createTimer section

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

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

* Add toc

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-06-28 22:28:33 +02:00
John Cocula aa2ab2cac1 [Add-ons] Generate as Jekyll Collections instead of Jekyll Pages (#355)
* Generate addon docs as Jekyll Collections instead of Jekyll Pages

Simplifies a lot of Jekyll, makes custom addon layout possible.

Signed-off-by: John Cocula <john@cocula.com>

* Adds-on (all but bindings) in user menu

Signed-off-by: John Cocula <john@cocula.com>

* Added openhab-distro submodule

Signed-off-by: John Cocula <john@cocula.com>
2017-03-02 01:08:44 +01:00
John Cocula 0698bf54d9 [Add-ons] Revise add-ons list handling and menu structure (#332)
* Put content on addons/io.md page

Fixes #330

Also:

* Removed manually maintained submenu contents
* Updated and added icons
* Fixed small bug in actions page

Signed-off-by: John Cocula <john@cocula.com>

* Consolidated duplicated code

* Remove errant build output

* Small cleanup

Signed-off-by: John Cocula john@cocula.com
2017-02-19 12:45:47 +01:00
Kai Kreuzer 7a3006da47 [Add-ons] Add logos to add-on lists (#320)
* added logos to add-on lists

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

* - added alt and title texts to img
- moved icon column to front

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

* improved css

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

* added title and alt to all lists

Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-02-14 12:37:02 +01:00
John Cocula 20bee2c357 Actions/bindings/persistence docs track feature naming convention (#297)
* Binding docs track feature naming convention

To keep links to binding docs as they were and to track the feature name of bindings.  The bindings/oh1 and bindings/oh2 subdirectories are now gone.
* Assuming the existing convention of `openhab-${type}-${id}` feature name will always mean the doc goes to `addons/${type}s/${id}`, this commit reflects this for actions, bindings and persistence service names.

This PR supercedes #296.

Signed-off-by: John Cocula <john@cocula.com>
2017-02-06 11:58:32 +01:00
John Cocula bb42557d57 Condense add-ons tables by reining in h4; top align cells (#293)
* Condense add-ons tables; top align cells

Signed-off-by: John Cocula <john@cocula.com>
2017-02-06 08:22:42 +01:00
John Cocula 63b831e528 [Add-ons] Factor OH1 add-on docs into site (#284)
* Factor OH1 addon docs into site, filter lists by source and install status.  Fixes #280

Signed-off-by: John Cocula <john@cocula.com> (github user: watou)

* Fixed typos.

* Add title to front matter for add-ons readmes that don’t already have front matter.

Also clean up new doc directories.

* Add warning comment in modified readmes

* Don’t remove “Persistence” from “Java Persistence API”

* address comments

Signed-off-by: John Cocula <john@cocula.com>
2017-02-04 20:26:08 +01:00
Thomas Dietrich 6a8b9b6443 Add a few introductional lines to Add-ons articles
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich 73f26ab865 Refactor Add-ons
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00