refactor layout pages doc, add interactive background docu #2398
Conversation
✅ Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: Stefan Höhn <[email protected]>
Signed-off-by: Stefan Höhn <[email protected]>
Signed-off-by: Stefan Höhn <[email protected]>
|
@rkoshak Hey, Rich, you might like this new feature. Do you mind reviewing the docs? |
|
I also looked at the generated preview of the docu and again it did a huge step - especially the developer section and the nice way all the information I love - and highly appreciate the work of you and all that contributed! Power is nothing without control - without the docu openHAB would not be an option for many users - this makes it accessible to a wider audience and also after using the system for aprox. 10 years now it is my main place to go if I look for something! Kudos! |
Signed-off-by: Stefan Höhn <[email protected]>
Signed-off-by: Stefan Höhn <[email protected]>
Signed-off-by: Stefan Höhn <[email protected]>
|
I will merge this now, so we do have the documentation available asap. Everyone who wants to provide feedback on the documentation, please still feel free to do so and I will take care of it. |
| @@ -152,9 +152,16 @@ module.exports = [ | |||
| children: [ | |||
| 'ui/', | |||
| 'ui/sitemaps', | |||
| { title: 'Pages', | |||
| { title: 'Page Types', | |||
There was a problem hiding this comment.
Page Types reads a bit awkward, I would rather just name this pages.
| @@ -14,12 +14,21 @@ To do that, openHAB puts different options at your disposal; they are commonly r | |||
|
|
|||
| Several types of pages are available: | |||
|
|
|||
| - [Home Page](index.html#the-home-page) | |||
There was a problem hiding this comment.
#the-home-page should work as well for anchor links and is preferable because it doesn‘t depend on filename.
There was a problem hiding this comment.
I did that first but it results into a linter issue which is why I reverted it to index.html#...
There was a problem hiding this comment.
Just to be sure: What has been removed here has just been moved (and possibly extended in this step) to the new subpages?
There was a problem hiding this comment.
I just split the content into the two sub pages as it makes more readable. Nothing was removed.
| If you want to achieve a different placement, adding margins to the image in an image editor will be necessary. | ||
|
|
||
| This setting is in particular in important if you want to make your background image interactive, in which case it has to be of type SVG. | ||
| See below for more information on [interactive backgrounds](layout-pages-fixed.html#interactive-backgrounds). |
There was a problem hiding this comment.
Here the anchor link alone should be enough instead of having the filename as well:
#interactive-backgrounds
There was a problem hiding this comment.
see comment above
| - **Embed SVG**: Only when enabled, the SVG image is embedded in the page as "real" HTML elements, allowing to interact with it (normally an SVG would only be referenced by an IMG tag). | ||
| By default, this is switched off and therefore needs to be enabled. | ||
|
|
||
| - **Embed SVG Flashing in Run-Mode**: It is possible within the editor to flash the elements of the SVG image that have been previously marked as interactive through the attribute 'openhab' (see below). |
There was a problem hiding this comment.
I would add when they flash: on hover/mouseover IIRC.
|
|
||
| Many special options though will only be available when you click on "Show Advanced". | ||
|
|
||
| - **State Items**: Define the item that is used to retrieve the state of the element to reflect the state. |
There was a problem hiding this comment.
I think it should be mentioned that this defaults to the action Item (IIRC, but the code should be checked to be sure).
|
Sorry I missed my opportunity to review. I'm glad it got merged. I like the changes! |
Documentation for the interactive background feature implemented in openhab/openhab-webui#2787