Commit Graph

45 Commits (42d289d92454a6a64f9e40efd88f28e5a54d3b30)

Author SHA1 Message Date
cat101 6cd16b3fa0 Switch elements cannot have nested groups (#1121)
* Switch elements cannot have nested groups

This is a known issue already mentioned here https://github.com/openhab/openhab-docs/issues/491

* Added sign off

Signed-off-by: Matias Cuenca-Acuna (cat101@somewhere.com)
2019-12-28 19:04:45 +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
mueller-ma d31cdb8581 Add pink and gold to supported colors (#1094)
https://github.com/openhab/openhab-android/pull/1703
https://github.com/openhab/openhab-android/issues/1640#issuecomment-558827596

Signed-off-by: mueller-ma <mueller-ma@users.noreply.github.com>
2019-11-28 12:32:29 +01:00
mueller-ma 6f22499445 [Sitemaps] Update punctuation (#1086)
Signed-off-by: mueller-ma <mueller-ma@users.noreply.github.com>
2019-11-20 22:09:09 +01:00
mueller-ma cf1b6f7371 [Sitemaps] Update switchSupport Slider parameter (#1085)
The Android app sends `ON` or `OFF`. Depending on the binding, `ON` can stand for "latest non-zero brightness" or for `100`.

Signed-off-by: mueller-ma <mueller-ma@users.noreply.github.com>
2019-11-20 19:15:02 +01:00
blilleike b52f46a66a Explained Colorpicker for sitemaps (#988) (#1042)
Switched to directly addressing the user (you) instead of "the user".
Added information on behaviour based on what a z-wave rgbw does. 
I think a hue colored lamp behaves similar (not restoring previous brightness).

Signed-off-by: Björn Lilleike <blilleike@incremental.plus>
2019-09-07 10:29:33 +02:00
mueller-ma 1ecc329095 Fix Sitemap color table (#1035)
* Fix Sitemap color table

Fixes #960

Signed-off-by: mueller-ma <mueller-ma@users.noreply.github.com>

* Use divs

Signed-off-by: mueller-ma <mueller-ma@users.noreply.github.com>

* Update example

Signed-off-by: mueller-ma <mueller-ma@users.noreply.github.com>
2019-09-01 15:35:46 +02:00
Søren Thorsen c0d08ecb4f When using sendFrequency in Colorpicker, the value should not be in "". If you do you will see this `warning: 2019-07-11 20:57:02.024 [WARN ] [el.core.internal.ModelRepositoryImpl] - Configuration model 'groundfloor.sitemap' has errors, therefore ignoring it: [31,91]: mismatched input '"20"' expecting RULE_INT` (#1017)
Line 31 from groundfloor.sitemap:
```
Colorpicker item=cinema_led_strip_color label="Cinema LED Strip Color[]" sendFrequency="20"
```

Signed-off-by: Soren Thorsen <st@debian-linux.dk>
2019-07-14 14:18:48 +02:00
Jerome Luckenbach cea408306b
Removed todo elements in sitemap.md (#959)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2019-05-18 20:41:47 +02:00
mueller-ma 88ccc6b58b Sitemaps: Fix links (#949)
* Sitemaps: Fix links

And change "openHAB Android App" to "openHAB App for Android"

> "Android", or anything confusingly similar to "Android", cannot be used in names of applications or accessory products, including phones, tablets, TVs, speakers, headphones, watches, and other devices. Instead, use "for Android".

from https://developer.android.com/distribute/marketing-tools/brand-guidelines?hl=en

* Fix BasicUI Link
2019-05-03 18:48:23 +02:00
mueller-ma 1c10caf290 Fix link anchor in Items (#948) 2019-04-24 17:34:35 +02:00
Markus Lipp 428452ce7f Fix links (#865)
* Fixed links in uis.md

Multiple dead links fixed

* Fix links

multiple links to addons page fixed

* Delete reference to non-existing doc page

Reorg of docs made the referenced chapter obsolete

* Fixed multiple links

various links fixed

* Fixed links

links to section addons fixed
Deleted reference to yahooweather binding (now obsolete) as example for binding that requires manual thing definition.

* link fixed

link to addons section fixed

* fixed link

fixed link to UI selection screen

* Fix link

Fixed link to addons section

* Fix links, update example

Signed-off-by: Markus Lipp lipp_markus@gmail.com (github: LightIsLife)

Links to addon section and others fixed.
Old example using the now obsolete Yahooweather binding has been replaced with an example using the network binding

* delete link habpanel.md

Deleted inexisitng link

* Fix links index.md

Fixed links

* Fix link sitemaps.md  (code review)

* Update installation/windows.md (Code review)

Co-Authored-By: LightIsLife <lipp.markus@gmail.com>

* Fix typo migration.md (Code review)

* Fixed typo migration.md (code review)

* Update qnap.md
2019-01-15 19:18:58 +01:00
Jerome Luckenbach ae90389d40
Refactoring of nearly all markdown tables. (#869)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2019-01-13 14:25:05 +01:00
Florian c7fe625c73 Add minValue, maxValue and step to slider documentation (#855)
This is a new feature in ESH, added with PR #6777.

Signed-off-by: Florian <florian.schmidt.welzow@t-online.de>
2019-01-08 18:57:22 +01:00
vzorglub 039399b080 Update sitemaps.md (#818)
Corrected spelling typo
2018-12-01 11:01:11 +01:00
patmalcolm91 bafa211635 Update sitemaps.md (#787)
Fixed two minor typos.
2018-10-14 11:34:24 +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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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 5206aa0c26 [Sitemaps] Add filename warning (#251)
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-01-25 08:34:03 +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
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 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 29b9ac1c7c Move articles, adapt menu
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00