Шаблоны AutoDoc

При генерации документации Робота (паспорт робота) в AutoDoc применяются несколько шаблонов для описания проектов и их структуры:

Project.cshtml — Шаблон для описания проекта (*.ltp).
Process.cshtml — Шаблон для описания процесса.
ActivityInfo.cshtml — Шаблон для активностей проекта.
Template.uml - Шаблон UML для визуализации процессов.
Template.docx - Шаблон для автоматической генерации описания проекта в формате документа MS Word

Каждый из этих шаблонов использует свою модель данных, которая определяется директивой @model.

Структура папки Resources

Папка Resources содержит основные файлы и шаблоны для генерации документации. Она включает:

Шаблоны: проектные файлы project.cshtml, process.cshtml, ActivityInfo.cshtml и файлы Template.uml и Template.docx для генерации документации.
Подпапки: *assets и mazer для стилей, скриптов и изображений, которые используются при оформлении выходных документов.
Файлы .csv. Эти файлы представляют собой словари или списки соответствий для отображаемых значений, используемых при описании внутренних наименований типов, свойств и других элементов.
- tags.csv — устанавливает соответствие между группами элементов и тегами.
- PropertiesDict.csv — содержит отображаемые значения для некоторых свойств активностей.
- elements.csv — описывает активности, включая группу, описание и название класса.

Работа с шаблонами AutoDoc

Для создания пользовательских шаблонов рекомендуется скопировать папку Resources и внести необходимые изменения в шаблоны AutoDoc. При запуске AutoDoc пользовательские шаблоны можно указать с параметрами -t или -templates. Рекомендуется ознакомиться со справочником по синтаксису Razor, чтобы лучше понять возможности синтаксиса разметки и внедренного кода в шаблонах.

Формат готовых документов зависит от параметров запуска:

По умолчанию документы создаются в формате HTML.
Для создания документов MS Word формата .docx используйте параметр -word.

Типы и свойства данных в шаблонах AutoDoc

По ссылкам ниже представлены описания свойств используемых типов в шаблонах .cshtml. Каждому типу данных сопоставлен набор свойств.