Руководство XBSL
Карта руководства: установка, проверка, создание метаданных, серверы и данные платформы.
Руководство разложено по задачам. Короткая экскурсия – в README. Каждая страница ниже подробно разбирает свою часть инструментария.
| Страница | Что там |
|---|---|
| Быстрый старт | пакет, данные о языке из вашего дистрибутива, язык вывода |
| Проверка исходников | ключи запуска, на что опираются глубокие правила, список принятых замечаний, CI |
| Правила | полный перечень проверок с уровнями и областью |
| Создание метаданных | объекты, реквизиты, маршруты и формы движком; шаблоны кода |
| Комментарии в yaml | где пояснение в описании элемента переживает визуальный редактор и какие правила за этим следят |
| Серверы и плагины | сервер LSP, сервер MCP, веб-панель, свои плагины |
| Данные платформы | сгенерированные наборы, индекс документации, сравнение двух версий |
| Перевод проекта | перевод исходников на английские написания: словарь, покрытие, проверка в CI |
| Команды | все команды и опции, собрано из самого инструмента |
| Расширение VS Code | редактор на том же движке: диагностики, дерево метаданных, деплой |
| Визуальный конструктор | панель формы, палитра, панель свойств |
| Панель документации | справка платформы в редакторе: содержание, поиск, страница символа |