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

Fix Markdown. Remove Jenkins base tags. (#1497) 

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
pull/1498/head
Jerome Luckenbach 2021-02-24 21:08:19 +01:00 committed by GitHub
parent beac270987
commit ae9bdd76ec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
76 changed files with 8 additions and 156 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
addons/actions.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Actions
---
{% include base.html %}
# Actions
Actions are predefined methods that are called from openHAB rules and scripts.

2
addons/bindings.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Bindings
---
{% include base.html %}
# Bindings
Bindings connect your smart home's devices and technologies to openHAB.

2
addons/io.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: System Integrations
---
{% include base.html %}
# System Integrations
openHAB supports services that enable integration with various technologies that don't fall into other add-on categories.

2
addons/persistence.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Persistence Services
---
{% include base.html %}
# Persistence Services
Persistence services enable the storage of item states over time.

2
addons/transformations.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Transformations
---
{% include base.html %}
# Transformations
Transformations are used to translate data from a cluttered or technical raw value to a processed or human-readable representation.

2
addons/uis/apps/ios.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: iOS App
---
{% include base.html %}
# iOS App
<!-- https://developer.apple.com/app-store/marketing/guidelines/de/#downloadOnAppstore -->

2
addons/uis/apps/windows.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Windows 10 App
---
{% include base.html %}
# Windows 10 App
We provide a native Windows 10 app for openHAB, compatible with Windows laptops, desktops, tablets and phones (Xbox, Raspberry Pi and Holographic coming soon).

2
addons/voices.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Voice Services
---
{% include base.html %}
# Available Voice Services
| Voice Service | Description |

2
administration/bundles.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Bundle Management
---
{% include base.html %}
# Bundle Management
The [console](console.html) offers various commands to manage bundles, among other things.

2
administration/console.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: The Console
---
{% include base.html %}
# The Console
The console offers the ability to:

2
administration/index.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Advanced Functionality and Administrative Tasks
---
{% include base.html %}
# Advanced Functionality and Administrative Tasks
As a runtime environment openHAB uses [Apache Karaf](https://karaf.apache.org), a modern and polymorphic container for hosting Java applications.

2
administration/jsondb.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: JsonDB Storage
---
{% include base.html %}
# JsonDB Storage
JsonDB provides a system database for storage of configuration data.

2
administration/logging.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Logging
---
{% include base.html %}
# Logging in openHAB
This article describes the logging functionality in openHAB.

2
administration/runtime.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Runtime Commands
---
{% include base.html %}
# Runtime Commands
It is possible to query and even change the state of entities like items or things. Therefore the console offers commands in various areas:

2
administration/serial.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Serial Port Configuration
---
{% include base.html %}
# Serial Port Configuration
Without correct configuration, bindings using serial devices might not be able to open the serial port for communication, and you will see an error message in the logs.

2
appendix/contributing.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Contributing to openHAB
---
{% include base.html %}
# Contributing to openHAB
openHAB is a community effort and everyone can take part in that.

2
appendix/help.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Finding Help and FAQs
---
{% include base.html %}
# Finding Help
openHAB is surrounding by an amazing community helping new users, discussing problems and providing tutorials and examples.

2
concepts/audio.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Audio & Voice
---
{% include base.html %}
# Audio & Voice
Audio and voice features are an important aspect of any smart home solution as it is a very natural way to interact with the user.

2
concepts/categories.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Categories
---
{% include base.html %}
# Categories
Categories in openHAB are used to provide meta information about Things, Channels, etc. UIs can use this information to render specific icons or provide a search functionality to for example filter all Things for a certain category.

2
concepts/discovery.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Thing Discovery
---
{% include base.html %}
# Thing Discovery
Many devices, technologies and systems can be automatically discovered on the network or browsed through some API. It therefore makes a lot of sense to use these features for a smart home solution.

2
concepts/index.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Concepts
---
{% include base.html %}
# Concepts
When first thinking about your home automation system, it may be helpful to bear in mind that there are two ways of thinking about or viewing your system: the physical view and the functional view.

2
concepts/items.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Items
---
{% include base.html %}
# Items
openHAB has a strict separation between the physical world (the "Things", see below) and the application, which is built around the notion of "Items" (also called the virtual layer).

2
concepts/units-of-measurement.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Units Of Measurement
---
{% include base.html %}
# Units Of Measurement
To express measured values in a scientific correct unit the framework supports units of measurement.

2
configuration/editors.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Editors
---
{% include base.html %}
# Editors - Different Ways to Simplify Your Textual Configuration
Currently there are several existing solutions, that can help you configuring your openHAB instance in a textual way.

2
configuration/items.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Items
---
{% include base.html %}
# Items
In openHAB Items represent all properties and capabilities of the user’s home automation.

2
configuration/jsr223.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: JSR223 Scripting
---
{% include base.html %}
# JSR223 Scripting
::: tip Note

2
configuration/multimedia.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Multimedia
---
{% include base.html %}
# Multimedia
## Volume

2
configuration/persistence.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Persistence
---
{% include base.html %}
# Persistence
openHAB can store data over time; this is known as persistence.

2
configuration/restdocs.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: openHAB REST API
---
{% include base.html %}
# openHAB REST API
Through the openHAB [REST API](https://en.wikipedia.org/wiki/REST_API) most aspects of the openHAB system can be readily accessed by other programs.

2
configuration/rules-dsl.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Rules
---
{% include base.html %}
# Textual Rules
"Rules" are used for automating processes: Each rule can be triggered, which invokes a script that performs any kinds of tasks, e.g. turn on lights by modifying your items, do mathematical calculations, start timers etcetera.

2
configuration/services.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Services
---
{% include base.html %}
# Services
{% include contribution-wanted.html %}

2
configuration/things.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Things
---
{% include base.html %}
# Things
[Things]({{base}}/concepts/things.html) represent the physical layer of an openHAB system.

2
configuration/transform.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Transformations Configuration
---
{% include base.html %}
# Transformations Configuration
Transformations are used to translate data from a cluttered or technical raw value to a processed or human-readable representation.

2
developers/audio/index.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: Audio & Voice
---
{% include base.html %}
# Audio & Voice
openHAB provides a modular architecture that enables all kinds of different use cases.

2
developers/bindings/config-xml.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: Configuration Descriptions
---
{% include base.html %}
# Configuration Descriptions
Specific services or bindings usually require a configuration to be operational in a meaningful way.

2
developers/bindings/faq.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: FAQ
---
{% include base.html %}
# Frequently Asked Questions (FAQs)
Here is a list of frequently asked questions around the development of bindings.

8
developers/bindings/index.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: Bindings
---
{% include base.html %}
# Developing a Binding
{:.no_toc}
@ -969,7 +967,7 @@ Binding additional services to a handler can be achieved by implementing the ser
Instead of using the Component annotation your discovery service implements the `ThingHandlerService`.
It should extend the `AbstractDiscoveryService` (which implements `DiscoveryService`) just like a normal service:
```
```java
public class <your binding bridge DiscoveryService> extends AbstractDiscoveryService
implements ThingHandlerService {
```
@ -977,7 +975,7 @@ public class <your binding bridge DiscoveryService> extends AbstractDiscoverySer
The interface `ThingHandlerService` has 2 methods to pass the handler of the bridge.
A typical implementation is:
```
```java
@Override
public void setThingHandler(@Nullable ThingHandler handler) {
if (handler instanceof <your binding handler>) {
@ -997,7 +995,7 @@ The handler can be used to get the bridge UID or to get access to the configured
In the bridge handler you need to activate the thing handler service.
This is done by implementing the `getServices` method in your bridge handler:
```
```java
@Override
public Collection<Class<? extends ThingHandlerService>> getServices() {
return Collections.singleton(<your binding bridge DiscoveryService>.class);

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

@ -3,8 +3,6 @@ layout: developersguide
title: Thing Descriptions
---
{% include base.html %}
# Binding Definitions
{:.no_toc}

2
developers/buildsystem.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: Build System
---
{% include base.html %}
# Build System
The buildsystem is based on maven.

2
developers/contributing.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: Contribution
---
{% include base.html %}
# Contributing to the Development of openHAB
## The Repositories

2
developers/extensionservices/index.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: Extension service
---
{% include base.html %}
# Extension service
openHAB comes with an API that allows implementing a service that manages the installed extensions within a solution.

2
developers/governance.md
View File

@ -4,8 +4,6 @@ title: Governance
license: Parts of this page have been derived from the EPLv2 licensed https://www.eclipse.org/projects/handbook
---
{% include base.html %}
# Governance of the openHAB Project
## Principles

8
developers/guidelines.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: Coding Guidelines
---
{% include base.html %}
# Coding Guidelines
{:.no_toc}
@ -89,9 +87,9 @@ The rules are defined at <https://github.com/openhab/static-code-analysis/tree/m
### Java Coding Style
- The [Java naming conventions](https://java.about.com/od/javasyntax/a/nameconventions.htm) should always be used and are descibed in detail at the link, a quick summary is:
* Channel IDs: `lowerCamelCase`
* Variables: `lowerCamelCase`
* Constants: `ALL_UPPER_CASE`
- Channel IDs: `lowerCamelCase`
- Variables: `lowerCamelCase`
- Constants: `ALL_UPPER_CASE`
- Generics must be used where applicable. See example below:
```java

2
developers/ioservices/index.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: IO Services
---
{% include base.html %}
# Developing an IO Service
TODO

2
developers/module-types/index.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: Automation Modules
---
{% include base.html %}
# Developing Automation Modules
{:.no_toc}

2
developers/osgi/configadmin.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: Configuration Admin
---
{% include base.html %}
# Configuration Admin Service
As defined in the [OSGi Compendium Release 7][OSGi-cmpn] *configuration is the process of defining the configuration data of bundles and assuring that those bundles receive that data when they are active in the OSGi Service Platform.*

2
developers/osgi/equinox.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: Equinox
---
{% include base.html %}
# Equinox
{:.no_toc}

2
developers/osgi/eventadmin.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: Event Admin
---
{% include base.html %}
# Introduction
In a dynamic environment like OSGi, communication with events has a wide variety of use cases.

2
developers/osgi/osgi.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: OSGi
---
{% include base.html %}
# OSGi Overview
{:.no_toc}

2
developers/osgi/osgids.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: OSGi Declarative Services
---
{% include base.html %}
# Declarative Services
{:.no_toc}

2
developers/persistence/index.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: Persistence Service
---
{% include base.html %}
# Developing a Persistence Service
TODO

2
developers/tests.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: Writing tests
---
{% include base.html %}
# Tests
There are two approaches for testing:

2
developers/transformations/index.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: Transformations / Profiles
---
{% include base.html %}
# Developing a Transformation Service
Transformations and Profiles (see next section) are very similar in their nature. Usually

2
developers/utils/events.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: Event Bus
---
{% include base.html %}
# Event Bus
{:.no_toc}

2
developers/utils/i18n.md
View File

@ -3,8 +3,6 @@ layout: developersguide
title: Internationalization
---
{% include base.html %}
# Internationalization
{:.no_toc}

2
installation/armbian.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Armbian
---
{% include base.html %}
# Armbian
## What is Armbian?

2
installation/docker.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Docker
---
{% include base.html %}
# openHAB inside a Docker Container
Docker is the most popular among a collection of tools that provide containerization.

2
installation/index.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Installation Overview
---
{% include base.html %}
# Installation Overview
openHAB is written completely in Java.

2
installation/linux.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: openHAB on Linux
---
{% include base.html %}
# openHAB on Linux
The following instructions will guide you through the process of setting up openHAB and recommended packages for both .DEB (Ubuntu, Debian etc.) and .RPM (RedHat, CentOS, Fedora etc.) Linux systems.

2
installation/macos.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: macOS
---
{% include base.html %}
# Installation on macOS
This page is structured as follows:

2
installation/qnap.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: QNAP NAS
---
{% include base.html %}
# QNAP NAS
The [QNAP NAS](https://www.qnap.com) is a NAS server solution for your home, allowing the installation of additional packages.

2
installation/rasppi.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Raspberry Pi
---
{% include base.html %}
**Contents**
{::options toc_levels="2..4"/}

2
installation/security.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Securing Communication and Access
---
{% include base.html %}
# Securing access to openHAB
openHAB has mainly two ways to be accessed:

2
installation/synology.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Synology DiskStation
---
{% include base.html %}
# Synology DiskStation
The [DiskStation by Synology](https://www.synology.com/en-us/dsm) is a famous NAS server solution for your home, allowing the installation of additional packages.

2
installation/windows.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Windows
---
{% include base.html %}
# openHAB on Windows
The following instructions will guide you through the process of setting up openHAB.

2
search.html
View File

@ -2,7 +2,7 @@
layout: intro
title: openHAB 2 - Search Results
---
{% include base.html %}
<h2>Search Results</h2>
<div id="searchresults">
<div id="gsearch"></div>

2
styleguide.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: openhab-docs Markdown StyleGuide
---
{% include base.html %}
# openHAB Documentation Style Guide
## General Remarks

2
tutorials/getting_started/first_steps.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Getting Started - First Steps
---
{% include base.html %}
# First Steps
The following instructions will guide you through the initial steps after first installing openHAB.

2
tutorials/getting_started/index.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Getting Started - Introduction
---
{% include base.html %}
# Welcome
Welcome to openHAB.

3
tutorials/getting_started/model.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Semantic Model
---
{% include base.html %}
# Semantic Model
Things represent devices and the sensors and actuators of those devices.
@ -209,5 +207,6 @@ This is a table describing the Equipment, Point and Property classes needed to e
| Humidity | Measurement | * | Measurement | Humidity |
This table is based off the sources:
- <https://github.com/openhab/openhab-webui/blob/main/bundles/org.openhab.ui/web/src/components/cards/glance/location/status-badge.vue#L63>
- <https://github.com/openhab/openhab-webui/blob/main/bundles/org.openhab.ui/web/src/components/cards/glance/location/measurement-badge.vue#L48>

2
tutorials/getting_started/persistence.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Persistence
---
{% include base.html %}
# Persistence
There are many times in home automation where one wants to keep, chart, and otherwise use the historic states of their Items.

2
tutorials/getting_started/things_advanced.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Adding Things - Advanced
---
{% include base.html %}
# Adding Things - Advanced
Some bindings and technologies simply do not support automatic discovery.

1
tutorials/getting_started/things_intermediate.md
View File

@ -3,7 +3,6 @@ layout: documentation
title: Adding Things - Intermediate
---
{% include base.html %}
Previous: [Adding Things - Simple]({{base}}/tutorial/things_simple.html)
# Adding Things - Intermediate

2
tutorials/getting_started/things_simple.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Adding Things - Simple
---
{% include base.html %}
# Adding Things - Simple
As covered in the [concepts section]({{base}}/concepts/index.html) of the openHAB Docs, a binding is an add-on to openHAB that understands how to communicate with a specific home automation technology or API.

2
tutorials/index.html
View File

@ -3,8 +3,6 @@ layout: raw
title: Tutorials
---
{% include base.html %}
<div class="container target">
<h1>Tutorials</h1>
<p>Choose one of the options below to learn more about openHAB, either by following along a tutorial or by looking at a few examples.</p>

2
ui/sitemaps.md
View File

@ -3,8 +3,6 @@ layout: documentation
title: Sitemaps
---
{% include base.html %}
# Sitemaps
In openHAB a collection of [Things]({{base}}/concepts/things.html) and [Items]({{base}}/concepts/items.html) represent physical or logical objects in the user's home automation setup.