Панель документации
Справка 1С:Элемент внутри редактора: дерево содержания, полнотекстовый поиск, страница по символу и переходы из конструктора – всё из вашего дистрибутива платформы.
Расширение показывает справку платформы внутри редактора – отдельным контейнером Документация (1С:Элемент) на панели действий. Это тот же справочник, что и на сайте документации, но собранный из вашего дистрибутива 1С:Элемент: он совпадает с версией платформы, которой вы пользуетесь, и работает без сети.
Что внутри
- Дерево “Содержание” – курируемое оглавление, совпадающее с сайтом: руководство
разработчика, руководство администратора, типы языка (
Стд,Стд::Коллекции→Массив, …) и язык запросов. Разделы внутри страницы (Иерархия типа,Примеры,Литералы) вложены в её узел – клик ведёт сразу к нужному месту. - Страница открывается вкладкой редактора сбоку и не забирает фокус: код, таблицы и картинки статьи, кнопка Копировать у примеров, ссылка Первоисточник на ту же страницу сайта. Внутренние ссылки ведут к другим страницам в этой же вкладке, а дерево “Содержание” позиционируется на открытую страницу.
- Поиск (кнопка в шапке дерева, команда XBSL: поиск по документации) – полнотекстовый по всему справочнику и руководствам; выбор из списка открывает страницу.
Как сюда попадают
Панель – общий “ответчик на вопрос что это такое” для всего расширения:
| Откуда | Что делает |
|---|---|
Наведение на имя в .xbsl |
подсказка показывает описание типа и ссылку Документация – клик открывает страницу |
| Контекстное меню редактора, XBSL: документация по символу | страница типа под курсором; у метода или неоднозначного имени – список кандидатов |
| Палитра конструктора, Открыть документацию | страница компонента, который собираетесь вставить (краткое описание видно и в подсказке элемента палитры) |
| Дерево “Содержание” и поиск | обычная навигация по справочнику |
У неоднозначного имени кандидаты ранжируются по приёмнику перед точкой: Задание.Настроить
предпочитает страницы запланированного задания странице одноимённого топика руководства.
Что нужно
- LSP-режим (
pip install "xbsl[lsp]"): базу документации держит сервер, расширение только спрашивает и показывает. - Данные документации, собранные из вашего дистрибутива 1С:Элемент – см. Данные о языке.
Без данных панель не падает, а сообщает, что документация недоступна; остальные возможности расширения продолжают работать.
Для скриптов и агентов
Тот же справочник доступен вне редактора:
- MCP –
docs_search(полнотекстовый поиск),docs_page(статья по идентификатору),docs_symbol(страница по имени типа или члена). Именно так ИИ-агент сверяет API платформы, не выходя в сеть. - LSP – запросы
xbsl/docsAvailable,xbsl/docsSearch,xbsl/docsPage,xbsl/docsTree,xbsl/hoverDoc: любой редактор с поддержкой LSP может собрать над ними свою панель.
Смежное
- Визуальный конструктор – палитра и панель свойств, откуда сюда ведут переходы.
- Расширение VS Code – остальные возможности расширения.