1c-help-manage

Generate Help.xml and language-specific HTML help pages for 1C metadata objects.

413|90|Updated Aug 31, 2025
One-click install
npx skills add https://github.com/comol/cursor_rules_1c --skill 1c-help-manage
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: 1c-help-manage
Source: https://github.com/comol/cursor_rules_1c/tree/main/.cursor/skills/1c-help-manage
Command: npx skills add https://github.com/comol/cursor_rules_1c --skill 1c-help-manage

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill adds built-in help to a 1C metadata object, including a Help.xml file, a Help language HTML page, and optionally updates related form metadata to enable embedded documentation.

Core Features & Use Cases

  • Create Help.xml with the proper language page reference for the object.
  • Generate a Help/<Lang>.html HTML page used by the 1C help system.
  • Optionally update Forms metadata to ensure help content is properly associated with forms.
  • Real-world use: attach contextual help to a data processor or report so users can access in-app documentation without leaving the 1C environment.

Quick Start

Execute the add-help.ps1 script with your ProcessorName to create Help.xml and Help/HTML files for the target object.

Frequently Asked Questions about 1c-help-manage

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add built-in help to a 1C data processor or report?

To add built-in help to a 1C data processor or report, you execute the add-help.ps1 script with your ProcessorName. This generates a Help.xml file and a language-specific HTML page to integrate in-app documentation.

What files are generated when creating 1C metadata help for an EPF project?

Generating 1C metadata help creates a Help.xml file in the Ext/Help directory and a language-specific Help/<Lang>.html page. It optionally updates related Forms metadata to associate the help content with forms.

How do I attach contextual help to 1C metadata objects using PowerShell?

You attach contextual help to 1C metadata objects by running the add-help.ps1 script. This automates the creation of Help.xml and HTML help pages, embedding documentation directly within the 1C environment.

Does adding help to 1C metadata require a specific project structure?

Yes, adding help to 1C metadata requires an EPF-like project structure. Your project must include Ext/Help and Forms metadata directories for the script to properly generate and integrate the help assets.

Can I update 1C form metadata to link generated help files automatically?

Yes, the help generation process optionally updates 1C form metadata automatically. This ensures the generated Help.xml and HTML pages are properly associated with their respective forms for in-app access.

What is the best way to provide in-app documentation for 1C objects without external files?

The best way to provide in-app documentation for 1C objects is generating built-in help files. This Skill creates Help.xml and HTML pages inside the metadata structure, allowing users to access documentation without leaving the 1C environment.