Commit Graph

49 Commits (303a37cdd2c5709e22aba0b36e45dc058f1a7386)

Author SHA1 Message Date
Wouter Born c9c5f3564d
Fix broken Javadoc link (#1362)
Signed-off-by: Wouter Born <github@maindrain.net>
2020-12-22 12:13:19 +01:00
Christoph Weitkamp 01c2a2d0c0
Added documatation abput Hysteresis Profile (#1332)
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2020-12-19 19:57:34 +01:00
Wouter Born ca1fd0536e
Update Java 11 references (#1312)
Fixes #1161

Signed-off-by: Wouter Born <github@maindrain.net>
2020-12-13 21:16:06 +01:00
Jerome Luckenbach f41c4d698e
[WIP] OH3 preparations (2/x) (#1308)
* Add new installation gif.

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

* Next bulk edits for OH3. Inital start commit.

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

* Needed changes for items page.

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

* Changes needed for the contribution article.

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

* Reintroduced the already up to date expire information. Sorry @kaikreuzer. :P

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

* Incorporate improvements from #1257 by @Rossko57

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2020-12-13 19:09:43 +01:00
Kai Kreuzer 7ee847acc0
added expire documentation (#1293)
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2020-11-28 23:12:42 +01:00
Yannick Schaus d72156a6c0
Merge 2.5.x into main (#1266)
* Update README (2.5.x) (#1153)

Change branch name.

Signed-off-by: Yannick Schaus <github@schaus.net>

* Update items.md (#1156)

* Added var and VA units to UoM (#1146)

VA (Volt-Ampere - apparent power) and var (Volt-Ampere reactive) are used to measure power and energy consumption in AC circuits.


Signed-off-by: Nagy Attila Gabor <mrbig@sneaker.hu>

* Fix filepath to keystore (#1148)

Default openHAB userdata environment variable should be `$OPENHAB_USERDATA`, not `$USER_DATA` shouldn't it? At least, this is the default on my fresh openHABian and also the most popular variant to find in the docs.

* Slight language corrections (#1150)

I think it reads better this way

Signed-off-by: Richard Davies <rwdrich@gmail.com>

* additional example for non default persistence service (#1152)

For me it was confusing how to pass on the serviceId into methods that already had an argument. An extra example is always good.

Signed-off-by: jaco <jaco.waes@gmail.com>

* Adding 12 new logos for OH Add-Ons page on website (#1158)

Signed-off-by: bracklanna bracklanna@users.noreply.github.com

* Added missing preset variables (#1104)

* Added missing preset variables

Signed-off-by: Scott Rushworth <openhab@5iver.com>

* Cleaned up blank lines, fixed table, and added file name for SimpleRule

Signed-off-by: Scott Rushworth <openhab@5iver.com>

* Fix broken link (#1165)

* Added Hotlink from "label" section to "state presentation" (#1167)

* 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>

* Update index.md (#1170)

Link appears to be wrong and does not work when I click on it in Edge. Loads the same page again instead of loading the correct new page from the hyperlink.

https://www.openhab.org/docs/developer/guidelines.html

* Added Airthings logo (#1171)

* typo in exambp (#1172)

`Temperature.averageSince(now.minusMinutes(5),"influxdb")`

* file.encoding=UTF-8 (#1173)

* Update demo URL and add demo.rules URL (#1174)

Based on: https://community.openhab.org/t/demo-setup-missing/94850
Old Link is broken leading to 404.
The link to the demo.rules on github is an extra :)

* Replace outdated zulu.org link. (#1177)

* Replace outdated zulu.org link.

As of 3/23/2020 zulu.org has an SSL cert that expired on 9/28/2019. Changed link to azul.com/downloads, since that appears to be the new official source.

Signed-off-by: Billy Stevens <contact@wasv.me>

* Changed all http links to https for installation/index.md.

All changed links working, tested on 3/24/2020.

Signed-off-by: Billy Stevens <contact@wasv.me>

* Minor language tweak (#1178)

* Ending an active scan/stopScan (#1179)

Signed-off-by: Mark Theiding <mark.theiding@gmail.com>

* Add files via upload (#1184)

* Update persistence.md (#1185)

Clarify return objects for max/min rules extensions.

Signed-off-by: Ross Kennedy rossko@culzean.clara.co.uk

* Update things.md (#1186)

Amended example code to include using label and location when defining a Thing with a bridge that is defined elsewhere.

* Correct typos (#1190)

* Correct usage of its/it's

"It's" is always a contraction of "it is" or "it has".  "Its" is a
possessive.  Correct a few places where they were used backwards.

Signed-off-by: Bjorn Helgaas <bjorn@helgaas.com>

* Correct "Z-Wave" spelling

Per https://www.z-wave.com/, the canonical spelling appears to be "Z-Wave".
Most places use "Z-Wave" already; change the remaining references to match.

Signed-off-by: Bjorn Helgaas <bjorn@helgaas.com>

* Correct typos and grammatical errors

Correct some typos and grammatical errors.

Signed-off-by: Bjorn Helgaas <bjorn@helgaas.com>

* Update sitemap.md section charts (#1191)

I observed that the unique first word in the labels of items charted in a group isn't causing an empty chart anymore. I'm on openHAB 2.5.1.

Signed-off-by: Juergen Baginski opus42@gmx.de

* Add image for insteon binding (#1196)

Signed-off-by: Rob Nielsen <rob.nielsen@yahoo.com>

* typo (#1198)

Signed-off-by: Mark Theiding <mark.theiding@gmail.com>

* Installation details (#1197)

Added more details around the installation and configuration process.
Fixed that engine no longer logs "Activated scripting support..."

Signed-off-by: Mark Theiding <mark.theiding@gmail.com>

* Update sitemaps.md (#1202)

Added full item definition for usage of visibility. See https://community.openhab.org/t/sitemap-visibility-basic-ui/97304/9

* Updated ecobee logo (https://brand.ecobee.com/) (#1203)

Signed-off-by: Rob Nielsen <rob.nielsen@yahoo.com>

* tutorial: Fix description of sitemap 'type' (#1204)

In the tutorial, the generic sitemap description says that ItemType has
to be the same as the type defined in default.items.
Looking at
https://www.openhab.org/docs/configuration/items.html#type and
https://www.openhab.org/docs/configuration/sitemaps.html#element-types
this is incorrect as they take different values.
The example is even mislading as `Switch` is one of the only types which
is common between items and sitemaps. Might be better to describe
`Default` instead.

Signed-off-by: Christophe Fergeau <cfergeau@redhat.com>

* Added information about DateTime Group functions LATEST/EARLIEST (#1206)

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

* Add section for documentation contributions (#1205)

Hopefully this will lower the hurdle for people to submit documentation contributions. I know from myself that I didn't submit various documentation improvements, because I didn't know git and thought it would be a much more involved process. 
Ideally there would be a separate documentation section, but submitting this under the development contribution page for now (as per discussion with @Confectrician in https://github.com/openhab/openhab-docs/pull/1179#issuecomment-605642091).
Note that I am addressing the issue of DCO failures wrt specifying the full name that I ran into myself in https://github.com/openhab/openhab-docs/pull/1197#issuecomment-615597308. I found a good discussion of the issue at https://github.com/probot/dco/issues/43.

Signed-off-by: Mark Theiding <mark.theiding@gmail.com>

* fix typo (#1209)

* 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

* Line 115 broken link - should be: (#1217)

* Line 115 broken link - should be:

({{base}}/docs/configuration/sitemaps.html#element-types)

was:
({{base}}/configuration/configuration/sitemaps.html#element-types)

* Removed diplicated docs breadcrumb

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

Co-authored-by: Jerome Luckenbach <github@luckenba.ch>

* add missing space between words (#1212)

* Update configuration.md (#1215)

I'm a beginner myself. Though I liked this tutorial very much, it took me some time trying and erroring and finally reading forum posts to get behind this. I didn't even know there was something like a more modern ping. So maybe others are happy to learn this right from the beginning.

* Remove architecture from Docker tags (#1220)

Docker automatically detects the architecture and downloads the appropriate image (openhab/openhab-docker#213).
BuildKit will no longer generate new tags having the architecture (openhab/openhab-docker#293).

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

* slight readability improvements (#1221)

* slight readability improvements

* Update introduction.md

* Update introduction.md

* minor wording update

* Update eclipse.md (#1225)

Clarifying that it's no longer possible to make changes in the Core Framework for 2.5.x.

Signed-off-by: Mark Theiding <mark.theiding@gmail.com>

* [fmiweather] logo for FMI Weather binding (#929)

Signed-off-by: Sami Salonen <ssalonen@gmail.com>

* Update eclipse.md (#1226)

Added additional structure around install, run, debug and update steps. Provided more pointers to interactions with Eclipse, Maven and Git.

Signed-off-by: Mark Theiding <mark.theiding@gmail.com>

* Update contributing.md (#1227)

Need to escape \< and \> in the sign off message format so users see them explicitly in the Contributing to the Documentation section. 

Signed-off-by: Mark Theiding <mark.theiding@gmail.com>

* Update contributing.md (#1228)

Small refinement on documentation change submission flow. 

Signed-off-by: Mark Theiding <mark.theiding@gmail.com>

* Add doc folder to the binding directory structure (#1230)

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

* Make Subheadings Use Proper Subheading Syntax (#1234)

This way they render out as proper markdown and don't look weird on the website

Signed-off-by: Stefan Zabka <zabkaste@informatik.hu-berlin.de>

* Remove unnecessary isCancelled() from code example (#1235)

Cancelling an already canceled task has no effect. IMHO this check is not necesssary and removal would simplify the code. I came to this because I saw this pattern in many bindings during reviewing.

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

* Update thing-xml.md (#1236)

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

* Fix broken ESH links (#1231)

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

* Update logging.md (#1238)

Add information on how to find out the symbolic names of the bundles

* Remove Apache Commons from Default Libraries (#1229)

See openhab/openhab-addons#7722
Signed-off-by: Fabian Wolter <git@fabian-wolter.de>

* Update introduction.md (#1239)

* Update introduction.md

Signed-off-by: Markus Storm markus.storm@gmx.net

* Update introduction.md

* Revise Java recommendations (#1240)

* Revise Java recommendations

* Delete pine.md

Do not recommend PINE, it's not supported any longer by openHABian.

* Removed sidebar link in config

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

Co-authored-by: Jerome Luckenbach <github@luckenba.ch>

* Update security.md (#1241)

Been using FreeDNS for many years (ever since all these companies got rid of their free tiers) and never an issue!

* Fix DecimalType hex conversion example (#1243)

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

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

* Fix typo (#1244)

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

* Update persistence.md (#1246)

Fixes link to quartz docs page.

* Revision. (openhab#1187) (#1237)

* Revision. (openhab#1187)

- Update of screenshots, removal of old screenshots
- Chapters for better formatting
- Removal of ZWave chapter (one example of adding things should be enough IMHO)
- Adding items in simple mode and in "manual" mode

Signed-off-by: Sascha Billian <sascha.billian@googlemail.com>

* Use one line per sentence
Signed-off-by: Sascha Billian <sascha.billian@googlemail.com>

Co-authored-by: Jerome Luckenbach <github@luckenba.ch>

* Add notes for configuring Synology Diskstation (#1219)

* Add notes for configuring Synology Diskstation

I have a working set up for SSL enabled remote access on a Synology diskstation, taking advantage of the GUI as much as possible, to ensure automatic renewal of certs from Let's Encrypt, etc. It took me about 8 hours to suss it all out, but it could be achieved in about 30 mins if you knew exactly what to do... may not be widely useful, but since Synology is officially supported, I figured this might be a good addition.

There's also a minor error in the 'allow' masks - these should be 192.168.0.0/24 to allow access to anything in the 192.168.0.xxx range.

* Updated to use one line per sentence

Updated to use one line per sentence - sorry for the delay!

* Update security.md

* Updated for one line per sentence

Updated for one line per sentence

Signed-off-by: Andrew Mills mills@prettymachine.co.nz

* Bad subnet (#1245)

Nginx warns about low address bits of `192.168.0.1/24` because they are meaningless.
The correct subnet mask should be `192.168.0.0/24`

Signed-off-by: Olivier Béraud <olivierberaud@free.fr>

* Fixed broken images. (#1247)

* Fixed broken images.

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

* Fix image path

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

* [documentation] clarification of representation property (#1248)

* [documentation] clarification of representation property

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentation] typo

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentation] adopt suggestions of reviewers

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentation] commas

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentation] typo

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentation] addopted suggestions of @bobadair

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentation] typo

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentaion] example added back

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentaion] simplified text

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentation] typo

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* [documentation] adopted reviewer comment

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* Add Alexa mapping along side a channel mapping (#1249)

* Add Alexa mapping along side a channel mapping

It took me a while to find this https://community.openhab.org/t/tagging-devices-for-alexa-support/98155/3 on the Forum and its not clearly documented in the openHAB Amazon Alexa Smart Home Skill or here in Item Metadata.
I originally suggested this as an update to the openHAB Amazon Alexa Smart Home Skill documentaion, but it fits better here, then other integrations using metadata (e.g. HomeKit or Google Assistant) could refer to it as well.

* Update items.md

* Mention defaults for element type setpoint. (#1250)

Mention defaults for min, max and step value for element type setpoint.

Signed-off-by: Thomas Weiler <toweosp@gmail.com>

* Update index.md (#1251)

I thought 'workl' was probably intended to be 'work'.

* Items - Bedroom_Light written as Light_Bedroom (#1252)

Fix small error which might mislead some readers.

* Added example for time-weighted averages (#1253)

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

* Remove deprecated UIs, Eclipse Marketplace from sidebar

Signed-off-by: Yannick Schaus <github@schaus.net>

* Update branch name in README

Signed-off-by: Yannick Schaus <github@schaus.net>

Co-authored-by: Markus Storm <markus.storm@gmx.net>
Co-authored-by: Nagy Attila Gábor <mrbig@sneaker.hu>
Co-authored-by: Christoph Thiede <38782922+LinqLover@users.noreply.github.com>
Co-authored-by: Richard Davies <rwdrich@gmail.com>
Co-authored-by: jwaes <50528773+jwaes@users.noreply.github.com>
Co-authored-by: bracklanna <16140600+bracklanna@users.noreply.github.com>
Co-authored-by: Scott Rushworth <openhab@5iver.com>
Co-authored-by: cpmeister <mistercpp2000@gmail.com>
Co-authored-by: Ross Kennedy <rossko@culzean.clara.co.uk>
Co-authored-by: Christoph Weitkamp <github@christophweitkamp.de>
Co-authored-by: Skinah <32607303+Skinah@users.noreply.github.com>
Co-authored-by: pali <pauli.anttila@gmail.com>
Co-authored-by: ljsquare <laurens-jan@merkx-ewals.nl>
Co-authored-by: PatrikG <40170469+PatrikG8@users.noreply.github.com>
Co-authored-by: Elias H <E.Hackradt@web.de>
Co-authored-by: Billy Stevens <contact@wasv.me>
Co-authored-by: theiding <mark.theiding@gmail.com>
Co-authored-by: jadcx <60408305+jadcx@users.noreply.github.com>
Co-authored-by: Bjorn Helgaas <bjorn@helgaas.com>
Co-authored-by: Jürgen Baginski <opus42@gmx.de>
Co-authored-by: robnielsen <rob.nielsen@yahoo.com>
Co-authored-by: GumbyMan82 <40233411+GumbyMan82@users.noreply.github.com>
Co-authored-by: Christophe Fergeau <teuf@gnome.org>
Co-authored-by: Paulo "JCranky" Siqueira <paulo.siqueira@gmail.com>
Co-authored-by: Michael Rossner <Schrott.Micha@web.de>
Co-authored-by: BugSmurF <52825547+bugsmurf@users.noreply.github.com>
Co-authored-by: Jerome Luckenbach <github@luckenba.ch>
Co-authored-by: josefscript <64727123+josefscript@users.noreply.github.com>
Co-authored-by: Wouter Born <github@maindrain.net>
Co-authored-by: Sami Salonen <ssalonen@gmail.com>
Co-authored-by: Fabian Wolter <github@fabian-wolter.de>
Co-authored-by: Stefan Zabka <zabkaste@informatik.hu-berlin.de>
Co-authored-by: TRS-80 <25938297+TRSx80@users.noreply.github.com>
Co-authored-by: sihui <10405486+sihui62@users.noreply.github.com>
Co-authored-by: Andrew Mills <amil109@users.noreply.github.com>
Co-authored-by: Olivier Béraud <olivbd@users.noreply.github.com>
Co-authored-by: Andrew Fiddian-Green <software@whitebear.ch>
Co-authored-by: LeeC77 <LeeC77@users.noreply.github.com>
Co-authored-by: Thomas Weiler <18066810+toweosp@users.noreply.github.com>
Co-authored-by: garretcook <garretcook@gmail.com>
Co-authored-by: Michael Fielding <michael.fielding@gmail.com>
2020-09-21 13:29:39 +02:00
Mark Hilbush 82cbb61f9b Add new system profile rawbutton-on-off-switch (#1060)
Signed-off-by: Mark Hilbush <mark@hilbush.com>
2019-10-15 20:05:04 +02:00
AcHub efe12f24f1 Spelling errors (#1041) 2019-09-09 21:59:54 +02:00
Thomas Dietrich edd53f9ecf Improve icon name examples (#1037)
* Improve icon name examples

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

* Update items.md
2019-09-01 15:35:16 +02:00
WardMD90745 d2abc97f48 Corrected bad name to use hyphen (which is not allowed) (#1033) 2019-08-19 21:09:42 +02:00
Marcel Erkel 43f1029c34 Fix typos in items.md (#1005)
Signed-off-by: Marcel Erkel <marcel.erkel@gmail.com>
2019-06-16 09:08:18 +02:00
Christoph Weitkamp e0b4723789 Added documentation about more new profiles (#957)
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2019-05-02 20:47:40 +02:00
Gaël L'hopital 74f75c8004 Adding documentation for timestamp-update and timestamp-change profiles. (#941)
Signed-off-by: Gaël L'hopital <gael@lhopital.org>
2019-04-16 21:24:07 +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
Patrick Fink a9b2469c8e Fix Profile examples (#835)
Signed-off-by: Patrick Fink <mail@pfink.de>
2018-12-30 16:39:59 +01:00
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
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
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
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
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
Raj Shah 67cd769af3 FIX TYPO IN ITEMS CONFIGURATION (#772) 2018-09-04 09:46:50 +02:00
Arnold 0a7386d7b7 Update items.md (#760)
Fixed the link to the classic icons
2018-08-19 17:29:13 +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
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
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
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
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
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
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
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
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
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
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
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
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 37d9a43dc5 [Items] Add documentation for item tagging (#158)
Signed-off-by: Patrick Fink <mail@pfink.de>
2017-01-15 16:50:13 +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