agentleFS
anymasoftanymasoft/1c-ai/.claude/skills/help-add/SKILL.md

help-add

Skill0 starsChanged 4 months agoMITView on GitHub

Этот скилл MUST быть вызван когда нужно добавить встроенную справку к объекту 1С: обработка, отчёт, справочник, документ. SHOULD также вызывать когда документация объекта должна быть встроена в конфигурацию. Do NOT использовать для создания внешней документации или README.

2 other projects use a version of this, 1 of them edited.

Adopted by

Most recently taken up by

The file

Files
SKILL.md

/help-add — Добавление справки

Добавляет встроенную справку к объекту: файл метаданных Help.xml, HTML-страницу и при необходимости обновляет метаданные форм.

Usage

/help-add <ObjectName> [Lang] [SrcDir]
ПараметрОбязательныйПо умолчаниюОписание
ObjectNameда—Имя объекта
LangнетruКод языка справки
SrcDirнетsrcКаталог исходников

Команда

powershell.exe -NoProfile -File .claude/skills/help-add/scripts/add-help.ps1 -ObjectName "<ObjectName>" [-Lang "<Lang>"] [-SrcDir "<SrcDir>"]

Что создаётся

<SrcDir>/<ObjectName>/
    Ext/
        Help.xml                    # Метаданные справки (namespace extrnprops)
        Help/
            ru.html                 # HTML-страница справки
  • Help.xml — фиксированная структура с <Page>ru</Page> (namespace http://v8.1c.ru/8.3/xcf/extrnprops)
  • ru.html — HTML 4.0 Transitional с подключением стилей 1С (v8help://service_book/service_style)
  • Справка не регистрируется в ChildObjects корневого XML — достаточно наличия файлов

Что модифицируется

  • Если в метаданных формы (Forms/<FormName>.xml) отсутствует <IncludeHelpInContents> — скрипт добавит <IncludeHelpInContents>false</IncludeHelpInContents> после <FormType>. Для форм, созданных через /form-add, элемент уже есть.

Кнопка справки на форме

После создания справки для её вызова нужна кнопка на форме. Добавь кнопку Form.StandardCommand.Help в AutoCommandBar формы (Forms/<FormName>/Ext/Form.xml).

Текущая структура AutoCommandBar (созданная form-add)

<AutoCommandBar name="ФормаКоманднаяПанель" id="-1">
    <Autofill>true</Autofill>
</AutoCommandBar>

Нужно заменить на

<AutoCommandBar name="ФормаКоманднаяПанель" id="-1">
    <Autofill>true</Autofill>
    <ChildItems>
        <Button name="ФормаСправка" id="{{свободный_id}}">
            <Type>CommandBarButton</Type>
            <CommandName>Form.StandardCommand.Help</CommandName>
            <ExtendedTooltip name="ФормаСправкаExtendedTooltip" id="{{свободный_id + 1}}"/>
        </Button>
    </ChildItems>
</AutoCommandBar>

Выбор id

Просмотри все id="..." в Form.xml и выбери следующий свободный числовой id. Обычно id начинаются с 1 и идут подряд. Для кнопки нужны 2 id: один для Button, один для ExtendedTooltip.

Важно

  • Form.StandardCommand.Help — стандартная команда платформы, не нужно объявлять в <Commands>
  • Обработчика в Module.bsl не требуется — платформа сама найдёт Help.xml и откроет HTML

Редактирование справки

После создания содержимое справки — обычный HTML. Отредактируй Ext/Help/ru.html в соответствии с назначением объекта. Поддерживается стандартная HTML-разметка: <h1>..<h4>, <p>, <ul>, <ol>, <table>, <strong>, <em>, <a>, <pre>.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.