Create a new doc page for Main UI‘s special features #2188
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. |
|
Preview: https://deploy-preview-2188--openhab-docs-preview.netlify.app/docs/ui/mainui.html @digitaldan FYI this adds the docs for the UI command Item. |
| - label & service id of persistence service | ||
| - Items persisted by persistence service | ||
|
|
||
| ## Web Audio Sink |
There was a problem hiding this comment.
This Info is also available here: https://www.openhab.org/docs/settings/aboutpage.html#enable-web-audio-sink-support
Please merge the content of the two pages and link accordingly.
ui/mainui.md
Outdated
|
|
||
| Main UI implements a web audio sink, which means the openHAB server can play audio through on a client device through the browser. | ||
|
|
||
| To enable web audio sink support for a client, open the "Help & About" page from the menu and turn on the "Enable Web Audio sink support" option. |
There was a problem hiding this comment.
open the "Help & About" page -> Link to aboutpage.html#enable-web-audio-sink-support
ui/mainui.md
Outdated
| Main UI can be controlled from the openHAB server by setting up a so-called UI command Item. | ||
|
|
||
| Similarly to web audio support, this is a setting specific to your local browser environment, so you have to define the UI command Item for each client, which also allows you to different UI command Items for different clients. | ||
| To setup an Item as the UI command Item on your device, open the "Help & About" page from the menu and select an Item for "Listen for UI command to". |
There was a problem hiding this comment.
To setup an Item as the UI command Item on your device, first create a particular Item of type String, then open the ...
"Help & About" -> link page, see above
ui/mainui.md
Outdated
| Currently, the supported commands are: | ||
|
|
||
| - `navigate:$path`: | ||
| Navigate to a given `$path`, e.g. `navigate:/locations` to navigate to the "Locations" tab of the home page or `navigate:/page/my_custom_page` to navigate to a page with the ID `my_custom_page`. |
There was a problem hiding this comment.
This would make the particular client to open that page automatically. For example, you could listen to the door bell and open a video camera page of the door automatically.
ui/mainui.md
Outdated
| - `close`: | ||
| Close all popups, popovers and sheets. | ||
| - `back`: | ||
| Naviate back. |
|
|
||
| ### Enable Web Audio sink support | ||
|
|
||
| - This setting is also part of the miscellaneous settings. |
There was a problem hiding this comment.
From here on:
I have the feeling you deleted most of what I have written here. Please don't as I have put quite an amount of work by providing context, background and examples into it.
You move around redundant information but don't drop it, thanks.
Signed-off-by: Florian Hotze <[email protected]>
Signed-off-by: Florian Hotze <[email protected]>
Signed-off-by: Florian Hotze <[email protected]>
Signed-off-by: Florian Hotze <[email protected]>
Signed-off-by: Florian Hotze <[email protected]>
Signed-off-by: Florian Hotze <[email protected]>
Signed-off-by: Florian Hotze <[email protected]>
Signed-off-by: Florian Hotze <[email protected]>
Signed-off-by: Florian Hotze <[email protected]>
Signed-off-by: Florian Hotze <[email protected]>
Signed-off-by: Florian Hotze <[email protected]>
Signed-off-by: Florian Hotze <[email protected]>
Signed-off-by: Florian Hotze <[email protected]>
Signed-off-by: Florian Hotze <[email protected]>
|
Superseded by #2198. |
This new page aims at documenting „special“ features of Main UI that really need documentation, like the developer sidebar search (content moved from the tips & tricks section), web audio sink support or the UI Command Item (openhab/openhab-webui#2055).