Files
kompas3d-mcp/docs/Kompas3D_SDK/guides/description.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

36 lines
5.0 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: "Описание необязательных ключей манифеста приложения OnlineHelp и HelpURL"
type: guide
api: [api7]
tags: [guide, api7, description]
sources:
- description.html
---
*Инструкция по созданию справки HTML для приложений > Онлайн-справка для приложений*
В манифесте приложения содержатся необязательные ключи OnlineHelp и HelpURL, которые служат для работы с онлайн-справкой приложения, см. пример.
<application id="APP_Gayka1" title="Конструкторский элемент на Visual C++ с панелью" appIcon="E00D" helpId="Gayka1" OnlineHelp="true" HelpURL="www.testhelpserver.ru" autostart="true" showInMenu="true" iconFont="#Ascon Icons SDK Base" iconAccentFont="#Ascon Icons SDK Accent" iconColor1Font="#Ascon Icons SDK Color1" iconColor2Font="#Ascon Icons SDK Color2" iconColor3Font="#Ascon Icons SDK Color3">
OnLineHelp — признак наличия онлайн-справки у приложения.
Данный ключ определяет наличие онлайн-справки у приложения.
Принимаемые значения: true или false.
| | Если в настройках КОМПАС-3D установлен вызов онлайн-справки, а на стороне приложения она отсутствует, то необходимо установить в манифесте OnlineHelp=false для локальной работы со справкой. |
| --- | --- |
HelpURL — адрес сервера онлайн-справки приложения.
Данный ключ указывает адрес сервера приложения. К URL, определенному в ключе HelpURL манифеста приложения, добавляется на стороне КОМПАС <локаль КОМПАС> и <page>.
Пример работы:
Значение ключа HelpURL="www.testhelpserver.ru"
Результирующий URL=http://www.testshelperver.ru/ru-RU/cm_gayka5915.html
| | Ключ HelpURL должен идти в паре с ключом OnlineHelp = true. |
| --- | --- |
Примеры работы справки при различных значениях ключей
•КОМПАС-3D онлайн-справка = true, OnlineHelp = отсутствует, HelpURL = отсутствует — справка приложения открывается на help.ascon.ru;
•КОМПАС-3D онлайн-справка = false, OnlineHelp = отсутствует, HelpURL = отсутствует — справка приложения открывается на локальном сервере с помощью HelpServer;
•КОМПАС-3D онлайн-справка = true, OnlineHelp = true, HelpURL = присутствует и задан — справка открывается на указанном сервере приложения;
•КОМПАС-3D онлайн-справка = true, OnlineHelp = true, HelpURL = отсутствует — справка открывается на help.ascon.ru;
•КОМПАС-3D онлайн-справка = true, OnlineHelp = false, HelpURL = отсутствует — справка открывается на локальном сервере с помощью HelpServer;
•КОМПАС-3D онлайн-справка = false, OnlineHelp = false, HelpURL = отсутствует — справка открывается на локальном сервере с помощью HelpServer;
•КОМПАС-3D онлайн-справка = false, OnlineHelp = true, HelpURL = отсутствует — справка открывается на локальном сервере с помощью HelpServer, если в процессе работы настройка меняется на КОМПАС-3D онлайн справка = true, то она работает через help.ascon.ru;
•КОМПАС-3D онлайн-справка = false, OnlineHelp = true, HelpURL = присутствует и задан — справка открывается на локальном сервере с помощью HelpServer, если в процессе работы настройка меняется на КОМПАС-3D онлайн справка = true, то она работает через указанный сервер;
•КОМПАС-3D онлайн-справка = false/true, OnlineHelp = отсутствует, HelpURL = присутствует и задан — некорректное оформление манифеста. HelpURL должен отсутствовать, либо идти в паре с OnlineHelp = true. Работа производится согласно настройке КОМПАС-3D Справка — Использовать онлайн-справку.