AutoDoc Templates

When generating documentation for a Robot (robot passport) in AutoDoc, several templates are used to describe projects and their structure:

Project.cshtml — template for describing a project (*.ltp).
Process.cshtml — template for describing a process.
ActivityInfo.cshtml — template for project activities.
Template.uml - UML template for visualizing processes.
Template.docx - template for automatically generating project descriptions in MS Word document format.

Each of these templates uses its own data model, which is defined by the @model directive.

Resources Folder Structure

The Resources folder contains the main files and templates for generating documentation. It includes:

Templates: project files project.cshtml, process.cshtml, ActivityInfo.cshtml, and files Template.uml and Template.docx for generating documentation.
Subfolders: assets and mazer for styles, scripts, and images used in the output document design.
.csv files. These files represent dictionaries or correspondence lists for displayed values used when describing internal names of types, properties, and other elements.
- tags.csv — establishes correspondence between element groups and tags.
- PropertiesDict.csv — contains displayed values for some activity properties.
- elements.csv — describes activities, including group, description, and class name.

Working with AutoDoc Templates

To create custom templates, it is recommended to copy the Resources folder and make the necessary changes to the AutoDoc templates.

When running AutoDoc, custom templates can be specified with the -t or -templates parameters. It is recommended to familiarize yourself with the Razor syntax guide to better understand the possibilities of the markup syntax and embedded code in the templates.

The format of the finished documents depends on the launch parameters:

By default, documents are created in HTML format.
To create documents in MS Word format .docx, use the -word parameter.

Data Types and Properties in AutoDoc Templates

The links below provide descriptions of the properties used for the types in the .cshtml templates. Each data type is mapped to a set of properties.