fix(help-add): remove EPF-specific artifacts, clarify ObjectName as path

v1.2: renamed processorDir→objectDir, removed ProcessorName alias, generic error messages instead of "epf-init", HTML template "Описание" instead of "Описание обработки". SKILL.md clarifies ObjectName format (e.g. Catalogs/МойСправочник). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-06-10 16:14:54 +03:00 · 2026-03-20 15:41:53 +03:00
parent 5b6fcc7c74
commit 669b5f42f2
3 changed files with 21 additions and 70 deletions
@@ -1,6 +1,6 @@
 ---
 name: help-add
-description: Добавить встроенную справку к объекту 1С (обработка, отчёт, справочник, документ и др.)
+description: Добавить встроенную справку к объекту 1С (обработка, отчёт, справочник, документ и др.). Используй когда пользователь просит добавить справку, help, встроенную помощь к объекту
 argument-hint: <ObjectName>
 allowed-tools:
  - Bash
@@ -23,7 +23,7 @@ allowed-tools:

 | Параметр   | Обязательный | По умолчанию | Описание                            |
 |------------|:------------:|--------------|-------------------------------------|
-| ObjectName | да           | —            | Имя объекта                         |
+| ObjectName | да           | —            | Путь объекта относительно SrcDir (например `Catalogs/МойСправочник`, `DataProcessors/МояОбработка`) |
 | Lang       | нет          | `ru`         | Код языка справки                   |
 | SrcDir     | нет          | `src`        | Каталог исходников                  |

@@ -33,60 +33,12 @@ allowed-tools:
 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-страница справки
-```
+- Создаёт `Ext/Help.xml` и `Ext/Help/ru.html` — шаблон справки
+- Если у объекта есть формы — добавляет `<IncludeHelpInContents>` в метаданные форм (если отсутствует)
+- Справка **не регистрируется** в `ChildObjects` — достаточно наличия файлов

- `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)
-
-```xml
-<AutoCommandBar name="ФормаКоманднаяПанель" id="-1">
-    <Autofill>true</Autofill>
-</AutoCommandBar>
-```
-
-### Нужно заменить на
-
-```xml
-<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>`.
+Отредактируй `Ext/Help/ru.html` — наполни содержимым справки (стандартный HTML: `<h1>`..`<h4>`, `<p>`, `<ul>`, `<table>` и т.д.). Кнопка справки появится автоматически через `Autofill` в AutoCommandBar формы.
@@ -1,8 +1,7 @@
-# help-add v1.1 — Add built-in help to 1C object
+# help-add v1.2 — Add built-in help to 1C object
 # Source: https://github.com/Nikolay-Shirokov/cc-1c-skills
 param(
 	[Parameter(Mandatory)]
-	[Alias("ProcessorName")]
 	[string]$ObjectName,

 	[string]$Lang = "ru",
@@ -14,11 +13,11 @@ $ErrorActionPreference = "Stop"

 # --- Проверки ---

-$processorDir = Join-Path $SrcDir $ObjectName
-$extDir = Join-Path $processorDir "Ext"
+$objectDir = Join-Path $SrcDir $ObjectName
+$extDir = Join-Path $objectDir "Ext"

 if (-not (Test-Path $extDir)) {
-	Write-Error "Каталог обработки не найден: $extDir. Сначала выполните epf-init."
+	Write-Error "Каталог объекта не найден: $extDir. Проверьте путь ObjectName (например Catalogs/МойСправочник)."
 	exit 1
 }

@@ -59,7 +58,7 @@ $helpHtml = @"
 </head>
 <body>
    <h1>$ObjectName</h1>
-    <p>Описание обработки.</p>
+    <p>Описание.</p>
 </body>
 </html>
 "@
@@ -68,7 +67,7 @@ $helpHtml = @"

 # --- 3. Проверка IncludeHelpInContents в метаданных форм ---

-$formsDir = Join-Path $processorDir "Forms"
+$formsDir = Join-Path $objectDir "Forms"
 if (Test-Path $formsDir) {
 	$formMetaFiles = Get-ChildItem -Path $formsDir -Filter "*.xml" -File
 	foreach ($formMeta in $formMetaFiles) {
@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# add-help v1.0 — Add built-in help to 1C object
+# add-help v1.2 — Add built-in help to 1C object
 # Source: https://github.com/Nikolay-Shirokov/cc-1c-skills

 import argparse
@@ -30,7 +30,7 @@ def main():
    sys.stdout.reconfigure(encoding="utf-8")
    sys.stderr.reconfigure(encoding="utf-8")
    parser = argparse.ArgumentParser(description="Add built-in help to 1C object", allow_abbrev=False)
-    parser.add_argument("-ObjectName", "-ProcessorName", required=True)
+    parser.add_argument("-ObjectName", required=True)
    parser.add_argument("-Lang", default="ru")
    parser.add_argument("-SrcDir", default="src")
    args = parser.parse_args()
@@ -41,11 +41,11 @@ def main():

    # --- Checks ---

-    processor_dir = os.path.join(src_dir, object_name)
-    ext_dir = os.path.join(processor_dir, "Ext")
+    object_dir = os.path.join(src_dir, object_name)
+    ext_dir = os.path.join(object_dir, "Ext")

    if not os.path.isdir(ext_dir):
-        print(f"Каталог обработки не найден: {ext_dir}. Сначала выполните epf-init.", file=sys.stderr)
+        print(f"Каталог объекта не найден: {ext_dir}. Проверьте путь ObjectName (например Catalogs/МойСправочник).", file=sys.stderr)
        sys.exit(1)

    help_xml_path = os.path.join(ext_dir, "Help.xml")
@@ -83,7 +83,7 @@ def main():
        '</head>\n'
        '<body>\n'
        f'    <h1>{object_name}</h1>\n'
-        '    <p>Описание обработки.</p>\n'
+        '    <p>Описание.</p>\n'
        '</body>\n'
        '</html>'
    )
@@ -92,7 +92,7 @@ def main():

    # --- 3. Check IncludeHelpInContents in form metadata ---

-    forms_dir = os.path.join(processor_dir, "Forms")
+    forms_dir = os.path.join(object_dir, "Forms")
    if os.path.isdir(forms_dir):
        for entry in os.listdir(forms_dir):
            if not entry.endswith(".xml"):