[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)pull/485/head
Jerome L
Thomas Dietrich
parent
e13c4885af
commit
0cd2cd15c0
|
|
@ -28,7 +28,6 @@
|
|||
<li><a href="{{docu}}/installation/synology.html">Synology DiskStation</a></li>
|
||||
<li><a href="{{docu}}/installation/qnap.html">QNAP NAS</a></li>
|
||||
<hr />
|
||||
<li><a href="{{docu}}/installation/designer.html">SmartHome Designer</a></li>
|
||||
<li><a href="{{docu}}/installation/security.html">Security & Remote Access</a></li>
|
||||
<li><a href="http://www.myopenhab.org">myopenHAB</a></li>
|
||||
</ul>
|
||||
|
|
@ -55,6 +54,7 @@
|
|||
<li><a href="{{docu}}/configuration/paperui.html">Paper UI</a></li>
|
||||
<li><a href="{{docu}}/configuration/habmin.html">HABmin</a></li>
|
||||
<li><a href="{{docu}}/configuration/rules-ng.html">Rules (Experimental)</a></li>
|
||||
<li><a href="{{docu}}/configuration/editors.html">Editors</a></li>
|
||||
<hr />
|
||||
<li><a href="{{docu}}/configuration/multimedia.html">Audio & Voice</a></li>
|
||||
</ul>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,122 @@
|
|||
---
|
||||
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.
|
||||
This documentation page can give you some guidance in choosing the right one for you and setting it up.
|
||||
|
||||
{::options toc_levels="2"/}
|
||||
|
||||
- TOC
|
||||
{:toc}
|
||||
|
||||
{: #openhab-vscode}
|
||||
## openHAB VS Code Extension
|
||||
|
||||
openHAB VS Code is an extension for the [Visual Studio Code](https://code.visualstudio.com) editor.
|
||||
|
||||
|
||||
|
||||
### Installation
|
||||
|
||||
1. Download the latest release from [openhab-vscode](https://github.com/openhab/openhab-vscode/releases)
|
||||
2. Install the extension with one of the following methods
|
||||
- Open command line in the same folder you downloaded the extension
|
||||
Type the following command:
|
||||
```shell
|
||||
code --install-extension openhab-0.0.2.vsix
|
||||
```
|
||||
- Go to the extensions area and install the extension like showed in the screenshot:
|
||||
|
||||
|
||||
Currently openhab-vscode isn't yet listed in [Microsoft Visual Studio Marketplace](https://marketplace.visualstudio.com/vscode), but the contributors are working on it already.
|
||||
|
||||
[Visit the Extensions GitHub Page for further Informations](https://github.com/openhab/openhab-vscode/blob/master/README.md "GitHub Repo for the VS Code Extension")
|
||||
|
||||
{: #esh-designer}
|
||||
## Eclipse SmartHome Designer
|
||||
|
||||
The Eclipse SmartHome Designer is a specialized version of the [Eclipse](http://www.eclipse.org) IDE for openHAB.
|
||||
Just like known from other IDEs, the Designer allows to browse and edit the configuration files of your openHAB setup, with the advantage of syntax highlighting, syntax checking and autocompletion.
|
||||
|
||||
### Network Preparations
|
||||
|
||||
If your openHAB instance is set up on a different device or a dedicated system, the Designer can be installed and executed on your personal PC or Mac.
|
||||
The Designer needs to be able to access the configuration files on the remote openHAB host.
|
||||
|
||||
You have to have a [network share](https://en.wikipedia.org/wiki/Shared_resource) set up on the remote host and mounted on your local device.
|
||||
Steps needed to so are specific to the hosts operation system.
|
||||
How to setup and use Samba on a Linux system is described in the [Linux article](linux.html#network-sharing).
|
||||
If you are using [openHABian](openhabian.html), the needed set of network shares is already configured for you, you just need to mount them locally.
|
||||
|
||||
*Attention Windows users:* Directly accessing network shares (UNC paths) is not supported. Please be sure to mount the network share to a drive letter prior to using the SmartHome Designer.
|
||||
|
||||
### Setup
|
||||
|
||||
- Get the latest version from: [Eclipse SmartHome Designer Downloads](https://github.com/eclipse/smarthome/blob/master/docs/documentation/community/downloads.md#designer-builds)
|
||||
(*Note:* the "Snapshot" build is currently not recommended for daily use)
|
||||
|
||||
The downloaded `.zip` archive contains the Designer executable.
|
||||
|
||||
- **Windows**: Extract the archive to a path of your choosing, e.g. `C:\designer`
|
||||
- **Linux**: Extract the archive to a path of your choosing, e.g. `/opt/designer`
|
||||
- **Max OSX**: Extract the archive to your applications folder
|
||||
|
||||
### First Launch
|
||||
|
||||
After launching the Designer executable you will see an empty configuration file pane on the top left.
|
||||
|
||||
|
||||
|
||||
Click on the "Select a configuration folder" icon at the top right of the configuration window and navigate to your openHAB configuration folder (containing `items`, `rules`, ...).
|
||||
|
||||
|
||||
|
||||
The configuration pane should now list the different configuration folders:
|
||||
|
||||
|
||||
|
||||
### Usage
|
||||
|
||||
You can now start to create and modify your configuration files.
|
||||
Changes are automatically loaded by the openHAB runtime.
|
||||
More details about the syntax of the different configuration files can be found in the [Configuration]({{base}}/configuration/index.html) chapter.
|
||||
|
||||
Hint: Press `<Ctrl + N>` to create a new file.
|
||||
|
||||
{: #others}
|
||||
## Other Editor Integrations
|
||||
|
||||
The here summarized projects provide syntax highlighting for different text editors, but have no _on top_ functionality like the two tools above.
|
||||
|
||||
### mcedit
|
||||
|
||||
mcedit is an editor which comes with mc (Midnight Commander).
|
||||
You can find the syntax files and installation instructions on [openhab-mcedit](https://github.com/CWempe/openhab-mcedit).
|
||||
|
||||
{: #notepadpp}
|
||||
### Notepad++
|
||||
|
||||
Notepad++ is a free source code editor for Windows.
|
||||
Version 6.2 or above is required.
|
||||
You can find the syntax files on [openhab-samples](https://github.com/thefrip/openhab-samples) and install the files like it is described in the [editors documentation](http://docs.notepad-plus-plus.org/index.php/User_Defined_Language_Files#How_to_install_user_defined_language_files).
|
||||
|
||||
### Vim
|
||||
|
||||
Vim is a text editor in Linux systems.
|
||||
You can find the syntax file and installation instructions on [openhab-vim](https://github.com/cyberkov/openhab-vim).
|
||||
|
||||
### Nano
|
||||
|
||||
Nano is a common editor in Linux systems.
|
||||
You can find the syntax file and installation instructions on [openhabnano](https://github.com/airix1/openhabnano).
|
||||
|
||||
### Textwrangler
|
||||
|
||||
Textwrangler is a text and code editor for MAC OS X.
|
||||
You can find the syntax file and installation instructions on [openhab-syntax-textwrangler](https://github.com/GrisoMG/openhab-syntax-textwrangler).
|
||||
|
Before Width: | Height: | Size: 143 KiB After Width: | Height: | Size: 143 KiB |
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
|
Before Width: | Height: | Size: 75 KiB After Width: | Height: | Size: 75 KiB |
|
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.6 MiB |
|
|
@ -47,7 +47,7 @@ There are two methods for defining Items:
|
|||
The following content will discuss details of item definition on the example of `.items` files.
|
||||
|
||||
**Editor Recommendation:**
|
||||
It's recommended to edit `.items` files using the [Eclipse SmartHome Designer]({{base}}/installation/designer.html).
|
||||
It's recommended to edit `.items` files using the [Eclipse SmartHome Designer]({{base}}/configuration/editors.html#eclipse-smarthome-designer).
|
||||
Doing so you will have full IDE support like syntax checking, context assist, etc.
|
||||
|
||||
## Item Definition and Syntax
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ It therefore makes sense to have different rule files for different use-cases or
|
|||
|
||||
### IDE Support
|
||||
|
||||
The [Eclipse SmartHome Designer]({{base}}/installation/designer.html) offers support for rules building.
|
||||
The [Eclipse SmartHome Designer]({{base}}/configuration/editors.html#eclipse-smarthome-designer) offers support for rules building.
|
||||
It includes syntax checks and coloring, validation with error markers, content assist (Ctrl+Space) incl. templates etc.
|
||||
This makes the creation of rules very easy!
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ This page is structured as follows:
|
|||
|
||||
The definition of Sitemaps happens declaratively in a file with a clear syntax, described below.
|
||||
A Sitemap definition file is stored in the folder `<openhab_config>/sitemaps` and has to have the `.sitemap` filename extension.
|
||||
For easy editing, the [openHAB Designer]({{base}}/installation/designer.html) brings full IDE support for these files.
|
||||
For easy editing, the [Eclipse SmartHome Designer]({{base}}/configuration/editors.html#eclipse-smarthome-designer) brings full IDE support for these files.
|
||||
|
||||
The openHAB runtime comes with a demo configuration package containing a [`demo.sitemap`](https://github.com/openhab/openhab-distro/blob/master/features/distro-resources/src/main/resources/sitemaps/demo.sitemap),
|
||||
which should let you easily understand possible elements and structures.
|
||||
|
|
|
|||
|
|
@ -1,56 +1,7 @@
|
|||
---
|
||||
layout: documentation
|
||||
title: SmartHome Designer
|
||||
layout: redirected
|
||||
sitemap: false
|
||||
redirect_to: /configuration/editors.html
|
||||
---
|
||||
|
||||
{% include base.html %}
|
||||
|
||||
# Eclipse SmartHome Designer
|
||||
|
||||
The Eclipse SmartHome Designer is a specialized version of the [Eclipse](http://www.eclipse.org) IDE for openHAB.
|
||||
Just like known from other IDEs, the Designer allows to browse and edit the configuration files of your openHAB setup, with the advantage of syntax highlighting, syntax checking and autocompletion.
|
||||
|
||||
## Network Preparations
|
||||
|
||||
If your openHAB instance is set up on a different device or a dedicated system, the Designer can be installed and executed on your personal PC or Mac.
|
||||
The Designer needs to be able to access the configuration files on the remote openHAB host.
|
||||
|
||||
You have to have a [network share](https://en.wikipedia.org/wiki/Shared_resource) set up on the remote host and mounted on your local device.
|
||||
Steps needed to so are specific to the hosts operation system.
|
||||
How to setup and use Samba on a Linux system is described in the [Linux article](linux.html#network-sharing).
|
||||
If you are using [openHABian](openhabian.html), the needed set of network shares is already configured for you, you just need to mount them locally.
|
||||
|
||||
*Attention Windows users:* Directly accessing network shares (UNC paths) is not supported. Please be sure to mount the network share to a drive letter prior to using the SmartHome Designer.
|
||||
|
||||
## Setup
|
||||
|
||||
- Get the latest version from: [Eclipse SmartHome Designer Downloads](https://github.com/eclipse/smarthome/blob/master/docs/documentation/community/downloads.md#designer-builds)
|
||||
(*Note:* the "Snapshot" build is currently not recommended for daily use)
|
||||
|
||||
The downloaded `.zip` archive contains the Designer executable.
|
||||
|
||||
- **Windows**: Extract the archive to a path of your choosing, e.g. `C:\designer`
|
||||
- **Linux**: Extract the archive to a path of your choosing, e.g. `/opt/designer`
|
||||
- **Max OSX**: Extract the archive to your applications folder
|
||||
|
||||
## First Launch
|
||||
|
||||
After launching the Designer executable you will see an empty configuration file pane on the top left.
|
||||
|
||||
|
||||
|
||||
Click on the "Select a configuration folder" icon at the top right of the configuration window and navigate to your openHAB configuration folder (containing `items`, `rules`, ...).
|
||||
|
||||
|
||||
|
||||
The configuration pane should now list the different configuration folders:
|
||||
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
You can now start to create and modify your configuration files.
|
||||
Changes are automatically loaded by the openHAB runtime.
|
||||
More details about the syntax of the different configuration files can be found in the [Configuration]({{base}}/configuration/index.html) chapter.
|
||||
|
||||
Hint: Press `<Ctrl + N>` to create a new file.
|
||||
<!-- Note to authors: This file was created in August 2017. Feel free to remove it after a few months... -->
|
||||
|
|
@ -694,7 +694,7 @@ openHAB depends on configuration files and folders with custom content (details
|
|||
Because your openHAB installation most probably is stored on a remote device, being able to easily access and modify these files from your local PC or Mac is important.
|
||||
Therefore setting up a [Samba](https://en.wikipedia.org/wiki/Samba_%28software%29) network share is **highly recommended**.
|
||||
|
||||
The [Eclipse SmartHome Designer]({{base}}/installation/designer.html) software does also depend on a mounted share to access the openHAB configuration files.
|
||||
The [Eclipse SmartHome Designer]({{base}}/configuration/editors.html#eclipse-smarthome-designer) software does also depend on a mounted share to access the openHAB configuration files.
|
||||
|
||||
We will now guide you through the Samba network shares setup process.
|
||||
Start by installing Samba.
|
||||
|
|
|
|||
Loading…
Reference in New Issue