OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added detailed rules on capitalization of labels (#1071) 

Signed-off-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
pull/1073/head
Hilbrand Bouwkamp 2019-11-06 22:43:56 +01:00 committed by Jerome Luckenbach
parent c211fbe8d0
commit 1aded5aa32
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
developers/bindings/thing-xml.md
View File

@ -336,7 +336,7 @@ public class ExampleDynamicStateDescriptionProvider implements DynamicStateDescr
}
```
##### Exampla code for a `DynamicStateDescriptionProvider` implementation which extends the `BaseDynamicStateDescriptionProvider`
##### Example code for a `DynamicStateDescriptionProvider` implementation which extends the `BaseDynamicStateDescriptionProvider`
```java
@Component(service = { DynamicStateDescriptionProvider.class, ExampleDynamicStateDescriptionProvider.class })
@ -521,6 +521,12 @@ A new discovery would then automatically find this device again and add it to th
The label and descriptions for things, channels and config descriptions should follow the following format.
The label should be short so that for most UIs it does not spread across multiple lines.
Labels should be capitalized using the following rules:
* Always capitalize the first and the last word.
* Lowercase articles, coordinating conjunctions, and prepositions (`a, an, the, and, as, but, by, for, from, in, into, like, near, nor, of, onto, or, out, over, past, so, till, to, up, upon, with, yet`).
* Capitalize all other words.
* Brand- or product names that starts with a lowercase character can be written using their official spelling.
The description can contain longer text to describe the thing in more detail.
Limited use of HTML tags is permitted to enhance the description - if a long description is provided, the first line should be kept short, and a line break (```<br />```) placed at the end of the line to allow UIs to display a short description in limited space.