Commit Graph

157 Commits (b087d15dff77f31393a5a8f5879610fd3ae4d2df)

Author SHA1 Message Date
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
Thomas Dietrich f484c210f1 Remove redundant/outdated content (#271)
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-01-25 15:11:56 +01:00
Thomas Dietrich 5206aa0c26 [Sitemaps] Add filename warning (#251)
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-01-25 08:34:03 +01:00
Thomas Dietrich 72ab48f67e [Configuration] Add overview 1st draft (#252)
* Add motivational intro part to config

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

* Add overview table and other details

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-01-23 02:38:58 +01:00
Thomas Dietrich 4e6a5439c6 Enhance DSL rules for say and interpret (#206)
* Enhance DSL rules for say and interpret

Submitted for publication by Laurent Garnier <lg.hc@free.fr> (github:lolodomo)
Submitted at https://github.com/openhab/openhab-docs/pull/149

Closes #149

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

* Update multimedia.md

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-01-17 13:48:44 +01:00
itheiss 07b0c627d6 [Items] Revise item tagging, closes #158 (#209)
Accepting unsigned work following the "Small patch exception".

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-01-16 13:13:00 +01:00
Patrick Fink 52d7927563 [Sitemaps] Add 'Default' element type (#159)
Signed-off-by: Patrick Fink <mail@pfink.de>
2017-01-15 16:51:35 +01:00
Patrick Fink 37d9a43dc5 [Items] Add documentation for item tagging (#158)
Signed-off-by: Patrick Fink <mail@pfink.de>
2017-01-15 16:50:13 +01:00
Kai Kreuzer 8acf8da18e [initial] Add detailed description of initial setup packages (#181)
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-01-09 18:49:30 +01:00
Thomas Dietrich 30973ce2aa Fix Configuration links, add apps
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich 3d62a6c003 Move unused PaperUI content
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich a357a6e724 Move sitemaps images, fix references
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich 9afbbec26b Update restdocs.md
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich 48ec0b2240 Add Initial Setup Packages article
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich cde493073d Add REST API article
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich bf56e0c08c Add openHABian and Synology to Inst. overview 2016-12-14 19:05:17 +01:00
Thomas Dietrich e42cdab1e2 Fix links in items and sitemaps articles
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich a5802e3d94 Add further rearrangements and fixes
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich 9bed397100 Add ui-based configuration article
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich c87cd8c42c Add placeholder articles 2016-12-14 19:05:17 +01:00
Thomas Dietrich 7eebdc94a8 Add redirect files
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich 29b9ac1c7c Move articles, adapt menu
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Ben Clark b7b38c9081 [nginx] Remove proxy_buffering in config examples (#126)
SSEs are now supported through a proxy using buffering. IMHO we should recommend the defaults (buffering=on).

Resolves #115

Signed-off-by: Ben Clark <ben@benjyc.uk>
2016-11-02 16:48:44 +01:00
Ben Clark 26dc4daafd Replace and fix invalid links (#119)
* Replace current broken/absolute links

* Removed accidental duplicate
2016-10-20 15:58:03 +02:00
Ben Clark b3163e1929 [nginx] add optional HTTPS configuration (#108)
* Added optional HTTPS configurations

Based on feedback I received and previously made questions around the community forums.

Plus corrected spelling mistakes.

* Added requested changes

- Added further reading
- Suggested that the configuration file be named openhab instead of default
- Suggested to use SSL Labs' site first.
- Used NGINX formatting.
2016-09-29 19:45:32 +02:00
Ben Clark 7267109083 Address problems with nginx configuration example (#99)
* Address problems with nginx configuration example

Include X-Forwarded Protocol
Disable Proxy buffering by default

* Updated Reverse Proxy page with tutorial

Removed reference to Jetty, replaced file with NGINX

* Added domain independant instructions

Also a short section about getting a domain name.

* Suggested removing HSTS if sticking to HTTP

* Fix typo
2016-09-28 15:04:00 +02:00
Thomas Dietrich 228e74fa83 Add title to most pages, fixes (#60)
minor spelling and format inconsistencies
upper case headlines
deletes spaces and lines at the end

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-08-05 12:10:20 +02:00
Kai Kreuzer fc4eb2deb8 reverted _source folder again as it does not seem to be supported by Github Pages
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-05-30 14:50:02 +02:00
Kai Kreuzer 1aa61facd5 introduced _source folder
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-05-30 10:59:32 +02:00
Kai Kreuzer e7d2340092 updated structure
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-05-30 10:30:54 +02:00
Kai Kreuzer 77b072fcd8 removed src folder
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-05-14 21:23:24 +02:00