Добавление справки Инструктора для приложений и компонентов

Для инструментов в каталоге Приложения и компоненты легко можно создать справку, которая будет отображаться на боковой панели.

В каталоге Приложения и компоненты на панели Инструктор при выборе элемента отображается содержимое. Эта информация особенно полезна для пользователей, которым нужны советы по выбору правильного компонента или инструкции перед запуском инструмента. Чтобы в полной мере использовать эту функцию, пользователи должны организовать свои боковые панели так, чтобы обе панели были видны.

В каталоге Приложения и компоненты выберите инструмент, к которому вы хотите добавить справку.
На панели Инструктор выберите меню, а затем нажмите Добавление файла справки.

Откроется диалоговое окно для создания необходимых файлов в соответствии с выбранными параметрами.
Нажмите Далее и выберите один или несколько языков.

Выберите языки, которые используются в качестве языков пользовательского интерфейса Tekla Structures в вашей организации. Должен быть файл с содержимым для каждого языка, даже если вы не переводите содержимое.
Нажмите Далее и выберите папку, в которой будут сохранены сгенерированные файлы.

Файлы могут храниться в папке модели, проекта, компании или системной папке. Поиск этих файлов производится в стандартном порядке поиска в папках.

Если необходимо распространить эти файлы среди пользователей, рекомендуется хранить их в папке проекта или компании.
Нажмите Создать.

Tekla Structures создает XML-файл, который определяет связь между инструментом в каталоге Приложения и компоненты и HTML-файлом справочного контента.

Структура папок, в которых хранятся HTML-файлы, предусматривает отдельные папки для каждого языка. XML-файлу и корневой папке содержимого присваиваются имена, соответствующие идентификатору инструмента, для которого предназначена справка. Вы можете копировать файлы из одного разрешенного места хранения в другое, однако не переименовывайте файлы или папки и не изменяйте структуру папок.
Отредактируйте HTML-файлы с содержимым в удобном для вас инструменте, например в Visual Basic, или замените файлы своими собственными HTML-файлами с такими же именами.

При необходимости можно добавить файлы справки инструмента «Инструктор» в пакет .tsep для своего расширения, чтобы при установке пакета .tsep пользователи автоматически добавляли эту справку. С помощью подставного знака (*) в XML-файле определения проекта можно добавить все файлы в указанную папку. Например:

<TargetPathVariables>
	<PathVariable Id="HelpDirectory" Value="%ENVDIR%\common\extensions\MyExtension\"/>
</TargetPathVariables>

<Component Id="ExampleExtension" Guid="4902568A-2195-4B38-BBA4-BEB56A2ABECF">
	<File Id="HelpFilesToCopy" Source="%TSEPDEFINITIONFILEFOLDER%\plugin\*" Target="%HelpDirectory%"/>
</Component>