Document MainUI developer sidebar search abilities (#2062)
* MainUI developer sidebar: document the search With https://github.com/openhab/openhab-webui/pull/1732, the developer sidebar search was extended to check much more entities for the search string. This lists what is possible now. Signed-off-by: Florian Hotze <florianh_dev@icloud.com> * Address review & Add missing Things Signed-off-by: Florian Hotze <florianh_dev@icloud.com> --------- Signed-off-by: Florian Hotze <florianh_dev@icloud.com>pull/2063/head
parent
ca8c303d57
commit
cf1b554772
|
@ -33,16 +33,43 @@ Bring up the sidebar through Developer Tools or the key combination <kbd>Alt</kb
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
Note that the sidebar will not come up if your display is to narrow.
|
Note that the sidebar will not come up if your display is too narrow.
|
||||||
It will not work on a phone nor on most tablet displays.
|
It will not work on a phone nor in portrait mode on most tablet displays.
|
||||||
|
|
||||||
There are four tabs on the sidebar.
|
There are four tabs on the sidebar, and the search field at the top.
|
||||||
|
|
||||||
|
### Search
|
||||||
|
|
||||||
|
Imagine you need to find all usages of an Item in rules or pages.
|
||||||
|
You could open all your rules and pages to check them, or just use the developer sidebar search.
|
||||||
|
Enter your Item name, and you will see in which rules, scenes, scripts and pages that Item is used.
|
||||||
|
|
||||||
|
The developer sidebar is checking your search query non case-intensive against the following entities:
|
||||||
|
|
||||||
|
- Things
|
||||||
|
- UID
|
||||||
|
- label
|
||||||
|
- Items
|
||||||
|
- name
|
||||||
|
- label
|
||||||
|
- tags (requires exact match)
|
||||||
|
- metadata namespaces (requires exact match)
|
||||||
|
- Pages
|
||||||
|
- uid
|
||||||
|
- label
|
||||||
|
- content (widgets, tabs, charts, etc. with their configuration)
|
||||||
|
- Rules, Scenes & Scripts
|
||||||
|
- Item name & Thing UID of triggers, actions & conditions
|
||||||
|
- script code (e.g. Rules DSL, JavaScript, and even Blockly)
|
||||||
|
- script MIME types (requires exact match)
|
||||||
|
|
||||||
### Pinned Objects
|
### Pinned Objects
|
||||||
|
|
||||||
Let's say you are working on your lighting automations which involves Things, Items, and Rules.
|
Let's say you are working on your lighting automations which involves Things, Items, and Rules.
|
||||||
Instead of keeping a dozen browser tabs open and flipping between them you can pin these objects to the sidebar.
|
Instead of keeping a dozen browser tabs open and flipping between them you can pin these objects to the sidebar.
|
||||||
In the search box at the top, enter a search term which can be part of an object's name, ID, label, etc.
|
|
||||||
|
Enter a search term in the search filed at the top to search within Items, Things, Rules, Scripts, Scenes and Pages.
|
||||||
|
The search term can be part of an object's name, ID, label, etc.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue