From ae90389d4095bb72066d530088314c12836dc580 Mon Sep 17 00:00:00 2001 From: Jerome Luckenbach Date: Sun, 13 Jan 2019 14:25:05 +0100 Subject: [PATCH] Refactoring of nearly all markdown tables. (#869) Signed-off-by: Jerome Luckenbach --- addons/uis.md | 28 ++++---- addons/voices.md | 6 +- administration/jsondb.md | 14 ++-- administration/logging.md | 18 ++--- administration/runtime.md | 100 +++++++++++++------------- appendix/contributing.md | 14 ++-- configuration/habpanel.md | 56 +++++++-------- configuration/items.md | 108 ++++++++++++++-------------- configuration/multimedia.md | 14 ++-- configuration/persistence.md | 26 +++---- configuration/rules-dsl.md | 20 +++--- configuration/sitemaps.md | 70 +++++++++--------- developers/prerequisites/equinox.md | 18 ++--- developers/prerequisites/osgi.md | 26 +++---- installation/index.md | 10 +-- 15 files changed, 264 insertions(+), 264 deletions(-) diff --git a/addons/uis.md b/addons/uis.md index cec1982e1..197d9f3cd 100644 --- a/addons/uis.md +++ b/addons/uis.md @@ -9,18 +9,18 @@ title: User Interfaces openHAB offers a variety of frontends for user interaction, from administrative web frontends to dedicated smartphone apps. -| Web Application | Description | -|-----------------|---------------| -| [Basic UI]({{base}}/addons/uis/basic/readme.html) | The Basic UI is an HTML5 web application in Material Design, designed for operating openHAB. | -| [Classic UI]({{base}}/addons/uis/classic/readme.html) | The Classic UI is the original openHAB 1.x webui, designed for operating openHAB. | -| [HABmin]({{base}}/addons/uis/habmin/readme.html) | HABmin is a modern, professional and portable user interface for openHAB, providing both user and administrative functions. | -| [HABPanel]({{base}}/addons/uis/habpanel/readme.html) | HABPanel is a lightweight dashboard interface for openHAB. | -| [Paper UI]({{base}}/addons/uis/paper/readme.html) | The Paper UI is an AngularJS-based HTML5 web application in Material Design, designed for setup and administration purposes. | +| Web Application | Description | +|-------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| +| [Basic UI]({{base}}/addons/uis/basic/readme.html) | The Basic UI is an HTML5 web application in Material Design, designed for operating openHAB. | +| [Classic UI]({{base}}/addons/uis/classic/readme.html) | The Classic UI is the original openHAB 1.x webui, designed for operating openHAB. | +| [HABmin]({{base}}/addons/uis/habmin/readme.html) | HABmin is a modern, professional and portable user interface for openHAB, providing both user and administrative functions. | +| [HABPanel]({{base}}/addons/uis/habpanel/readme.html) | HABPanel is a lightweight dashboard interface for openHAB. | +| [Paper UI]({{base}}/addons/uis/paper/readme.html) | The Paper UI is an AngularJS-based HTML5 web application in Material Design, designed for setup and administration purposes. | -| App | Description | -|---------|----------------------| -| [Android App]({{base}}/addons/uis/apps/android.html) | The native Android app to access openHAB on the go. | -| [iOS App]({{base}}/addons/uis/apps/ios.html) | The native iOS app to access openHAB on the go. | +| App | Description | +|---------------------------------------------------------|--------------------------------------------------------| +| [Android App]({{base}}/addons/uis/apps/android.html) | The native Android app to access openHAB on the go. | +| [iOS App]({{base}}/addons/uis/apps/ios.html) | The native iOS app to access openHAB on the go. | | [Windows 10 App]({{base}}/addons/uis/apps/windows.html) | The native Windows 10 app to access openHAB on the go. | ## Iconsets @@ -32,6 +32,6 @@ Currently only the Classic Icon Set is provided. Addition of personal icons and customization of the existing ones is supported and encouraged. See the instructions about [Custom Icons and Custom Dynamic Icons]({{base}}/configuration/items.html#icons) for more details. -| Iconset | Description | -|---------|----------------------| -| [Classic Icons]({{base}}/addons/iconsets/classic/readme.html) | This is a modernized version of the original icon set of openHAB 1. | +| Iconset | Description | +|-----------------------------------------------------------|---------------------------------------------------------------------| +| [Classic Icons]({{base}}/configuration/iconsets/classic/) | This is a modernized version of the original icon set of openHAB 1. | diff --git a/addons/voices.md b/addons/voices.md index 50a2fe532..864cabc15 100644 --- a/addons/voices.md +++ b/addons/voices.md @@ -7,7 +7,7 @@ title: Voice Services # Available Voice Services -| Voice Service | Description | -|---------------|-------------| -{% for voice in site.addons_voices %}| [{% if voice.logo %}{% else %}{{ voice.label }}{% endif %}]({{base}}{{ voice.url }}) | {{ voice.description }} | +| Voice Service | Description | +|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| {% for voice in site.addons_voices %} | [{% if voice.logo %}{% else %}{{ voice.label }}{% endif %}]({{base}}{{ voice.url }}) | {% endfor %} diff --git a/administration/jsondb.md b/administration/jsondb.md index 761180798..f7ba9be92 100644 --- a/administration/jsondb.md +++ b/administration/jsondb.md @@ -82,13 +82,13 @@ The full directory path depends on the installation method: Within the `OPENHAB_USERDATA/jsondb/` directory, you will find the following files: -| Filename | _Contents_ | -|------------------------------------------------------------------|-----------------------------------------| -| org.eclipse.smarthome.config.discovery.**DiscoveryResult.json** | _Results of Paper UI Discovery_ | -| org.eclipse.smarthome.core.items.**Item.json** | _Items configurations_ | -| org.eclipse.smarthome.core.thing.link.**ItemChannelLink.json** | _Item to Channel Link configurations_ | -| org.eclipse.smarthome.core.thing.link.**ItemThingLink.json** | _Item to Thing Link configurations_ | -| org.eclipse.smarthome.core.thing.**Thing.json** | _Things configurations_ | +| Filename | _Contents_ | +|-----------------------------------------------------------------|---------------------------------------| +| org.eclipse.smarthome.config.discovery.**DiscoveryResult.json** | _Results of Paper UI Discovery_ | +| org.eclipse.smarthome.core.items.**Item.json** | _Items configurations_ | +| org.eclipse.smarthome.core.thing.link.**ItemChannelLink.json** | _Item to Channel Link configurations_ | +| org.eclipse.smarthome.core.thing.link.**ItemThingLink.json** | _Item to Thing Link configurations_ | +| org.eclipse.smarthome.core.thing.**Thing.json** | _Things configurations_ | ## Example Use diff --git a/administration/logging.md b/administration/logging.md index 587f25451..85b0cd0d7 100644 --- a/administration/logging.md +++ b/administration/logging.md @@ -77,15 +77,15 @@ log:set LEVEL package.subpackage The **what** is defined by `package.subpackage` and is in most cases a binding (like `org.openhab.binding.zwave`). The **detail** of logging is defined by one of the following levels: -| Log Level | Log Weight | When it should be used | -|---------------------|---------------|-----------------------------------------------------------------------------------------| -| OFF | 0 | When no events will be logged | -| ERROR | 200 | When an error in the application, possibly recoverable | -| WARN | 300 | When an event that might possible lead to an error | -| INFO | 400 | When an event for informational purposes | -| DEBUG | 500 | When a general debugging event required | -| TRACE | 600 | When a fine grained debug message, typically capturing the flow through the application | -| ALL | MAX | When all events should be logged | +| Log Level | Log Weight | When it should be used | +|-----------|------------|-----------------------------------------------------------------------------------------| +| OFF | 0 | When no events will be logged | +| ERROR | 200 | When an error in the application, possibly recoverable | +| WARN | 300 | When an event that might possible lead to an error | +| INFO | 400 | When an event for informational purposes | +| DEBUG | 500 | When a general debugging event required | +| TRACE | 600 | When a fine grained debug message, typically capturing the flow through the application | +| ALL | MAX | When all events should be logged | The levels build a hierarchy with **ERROR** logging critical messages only and **DEBUG** logging nearly everything. **DEBUG** combines all logs from weight 100 to 500, while **TRACE** adds further messages in addition to what **DEBUG** displays. diff --git a/administration/runtime.md b/administration/runtime.md index 348dc4efa..2f0f5e9fb 100644 --- a/administration/runtime.md +++ b/administration/runtime.md @@ -42,77 +42,77 @@ Usage: smarthome:send - sends a command for an item ### Items -| Command | Description | -|---------|-------------| -| `smarthome:status ` | shows the current status of an item -| `smarthome:update ` | sends a status update for an item -| `smarthome:send ` | sends a command for an item -| `smarthome:items list []` | lists names and types of all items (matching the pattern, if given) -| `smarthome:items clear` | removes all items -| `smarthome:items remove ` | removes the given item +| Command | Description | +|-------------------------------------|---------------------------------------------------------------------| +| `smarthome:status ` | shows the current status of an item | +| `smarthome:update ` | sends a status update for an item | +| `smarthome:send ` | sends a command for an item | +| `smarthome:items list []` | lists names and types of all items (matching the pattern, if given) | +| `smarthome:items clear` | removes all items | +| `smarthome:items remove ` | removes the given item | ### Discovery -| Command | Description | -|---------|-------------| -| `smarthome:discovery start ` | runs a discovery on a given thing type or binding -| `smarthome:discovery enableBackgroundDiscovery ` | enables background discovery for the discovery service with the given PID -| `smarthome:discovery disableBackgroundDiscovery ` | disables background discovery for the discovery service with the given PID +| Command | Description | +|--------------------------------------------------------|----------------------------------------------------------------------------| +| `smarthome:discovery start ` | runs a discovery on a given thing type or binding | +| `smarthome:discovery enableBackgroundDiscovery ` | enables background discovery for the discovery service with the given PID | +| `smarthome:discovery disableBackgroundDiscovery ` | disables background discovery for the discovery service with the given PID | ### Inbox -| Command | Description | -|---------|-------------| -| `smarthome:inbox` | lists all current inbox entries -| `smarthome:inbox listignored` | lists all ignored inbox entries -| `smarthome:inbox approve