Структура документации
Данная документация является основным ресурсом для всех пользователей ioBroker. На этой странице объясняется, как в ней ориентироваться.
Веб-сайт имеет адаптивный дизайн: в зависимости от ширины экрана элементы управления группируются или скрываются, чтобы освободить место для текста. Поэтому страница выглядит по-разному на телефоне и на изображениях, представленных здесь.
Области страницы
| Нет. | Область |
|---|---|
| 1 | Главное меню : ведет к другим разделам сайта. |
| 2 | Меню документа : дерево всех глав. |
| 3 | Меню тем : заголовки текущей открытой страницы. |
| 4 | Выбор языка . |
| 5 | Поиск и фильтрация : выше показан поиск по всему сайту; в разделе документации поле над текстом фильтрует дерево глав и выполняет поиск по всему тексту при нажатии клавиши Enter. |
Над разделами отображается навигационная цепочка : она показывает, где находится текущая страница в дереве, и каждая ее часть является кликабельной.
1 Главное меню
Вверху перечислены наиболее важные пункты. Значок с тремя линиями в правом крайнем углу открывает полное меню:
Помимо основных разделов — документация , адаптеры , лицензии и установка — вы также найдете блог, форум, статистику, юридическую информацию и политику конфиденциальности. Значки в правом нижнем углу ведут на GitHub, Facebook, Discord и Instagram.
Символ солнца в правом верхнем углу меняет свой внешний вид, переходя из светлого в тёмный.
2 Меню документации
Дерево слева ведет по всем главам. Щелчок по папке разворачивает ее, две стрелки над ней разворачивают или сворачивают все дерево целиком.
Поле над текстом — это фильтр , а не поле поиска: после ввода термина в древовидном представлении останутся только главы, названия которых соответствуют поисковому запросу. Для поиска по всему тексту нажмите клавишу Enter ; ссылка для этого также находится ниже поля.
Двойная стрелка в верхнем левом углу позволяет полностью скрыть дерево, если требуется больше места для текста.
3 Меню тем
В правом верхнем углу этой страницы отображаются заголовки открытой в данный момент статьи:
Для длинных страниц это самый быстрый способ найти нужный раздел.
4. Выбор языка
Документация многоязычная. Немецкие тексты служат образцом; тексты на других языках создаются на его основе и постепенно совершенствуются носителями языка.
5. Поиск и фильтрация
На сайте есть два поля ввода, которые легко перепутать.
| Поле | Что это делает |
|---|---|
| Увеличительное стекло в области головы | осуществляет поиск по всему сайту: документации, адаптерам и блогу. |
| Поле над текстом, с символом воронки. | Фильтрует дерево глав по названиям глав; нажатие клавиши Enter запускает поиск по всему тексту с использованием того же термина. |
Символ воронки отличает эти два понятия: воронка обозначает фильтрацию, а увеличительное стекло — поиск. Термин, который встречается в тексте, но отсутствует в заголовках, не будет найден в фильтре. Индикатор под полем перенаправит вас к функции поиска.
В списке результатов кнопка «Назад » в правом верхнем углу вернет вас на предыдущую страницу.
С чего начать?
- Тем, кто еще не знаком с ioBroker, следует начать с основ .
- В инструкциях по установке описан процесс для Linux, Docker, Proxmox, Windows и macOS.
- В административном интерфейсе объясняется, как им пользоваться.
- Как точки данных преобразуются в процессы, объясняется в разделе «Логика и автоматизация» .
- Все адаптеры перечислены по отдельности в справочнике адаптеров .
- Любой желающий может найти отправную точку для написания собственного адаптера в разделе для разработчиков .
Данная документация постоянно пополняется. Если чего-то не хватает или требуется более подробное объяснение, мы будем рады любой помощи .