Files
kompas3d-mcp/docs/Kompas3D_SDK/guides/name.md
T
mikhail e1337e4016 feat(sdk-docs): MD-база знаний SDK — в репозиторий; генератор и зеркало убраны
docs/Kompas3D_SDK/ становится каноническим источником справки КОМПАС SDK
и включается в репозиторий (2491 файл, ~14 МБ). HTML-зеркало
docs/KOMPAS_SDK_ru-RU/ (~1.4 ГБ, © АСКОН) и генератор
tools/build_kompas3d_sdk.py больше не нужны — регенерация не предполагается.

- .gitignore: MD-база разблокирована; зеркало остаётся проигнорированным
  (safety-net на случай повторной локальной выгрузки).
- CLAUDE.md / SKILL.md: убраны упоминания регенерации и зеркала.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-26 20:00:05 +03:00

49 lines
2.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
title: "Правило именования и расположения ini-файлов"
type: guide
api: [api7]
tags: [guide, api7, name]
sources:
- name_for_ini.html
---
*Инструкция по созданию справки HTML для приложений > Локальная справка для приложений*
## Правило именования и расположения ini-файлов
В %ProgramData%\ASCON\HelpServer должен быть помещен ini-файл приложения. Имя файла может быть задано в одном из следующих форматов:
•<App ID>_<major версия>_<локаль>.ini
•<helpId>_<major версия>_<локаль>.ini
Пример:
```vb
APP_Gayka1_v23_ru-Ru.ini или Gayka1_v23_ru-Ru.ini
Ini-файл должен быть в кодировке UTF-8 and UTF-16LE with BOM encoded configuration files are supported.
Структура ini-файла
Help]
формируемый путь для строки браузера:
path=/<App ID>/<major версия>/<локаль>/
или
path=/<HelpId>/<major версия>/<локаль>/
путь к справке:
root=J:\Test Lib\Help\Gayka1_ru-Ru.zip
Пример содержания ini-файла
[Help]
path=/Gayka1/22/ru-RU/
root=J:\Test Lib\Help\Gayka1_ru-Ru.zip
Если в системе установлено несколько локализаций, то рекомендуется создавать разные ini-файлы на каждый язык.
Например:
Gayka1_v22_ru-RU.ini
Gayka1_v22_en-US.ini
```
## Правило именования и расположения файлов справки
| | Zip-архив со справкой приложения и БД соответствия идентификаторов и страниц html рекомендуется располагать в каталоге приложения в папке Help. |
| --- | --- |
Поиск справки выполняется по следующему правилу:
<helpId>_<локаль>.zip
Если ключ helpid не задан в манифесте приложения, то поиск справки выполняется по правилу:
<application ID>_<локаль>.zip