How to provide attachments
Attachments are files associated with a documentation unit — such as a chapter, function description, or software component description — in EHANDBOOK. They are useful for providing supplementary materials that users can download and reference.
When to use attachments
Use attachments to include files such as:
-
Calibration guides and configuration files (PDF, Word documents)
-
Spreadsheets with parameter values, signal definitions, or lookup tables (Excel, CSV)
-
Binary calibration data and measurement files (DCM, LAB files)
-
Reference documentation and technical specifications
-
Model files and tool-specific formats
-
Any file that provides additional context without cluttering the main documentation text
Attachments allow readers to access relevant supporting materials directly from the documentation unit, improving discoverability and reducing the need to search external repositories.
Choose your EHB-CB approach
Depending on your EHANDBOOK Container-Build approach, attachments are configured differently. Select the section that matches your workflow:
-
Directory-Based EHB-CB: Use if your documentation is organized in file system directories
-
ASAM-Based EHB-CB: Use if your documentation is structured in ASAM XML format
Directory-Based EHB-CB
In the directory-based EHB-CB approach, all files to be added as attachments must be stored in a sub-directory named _attachments. During EHANDBOOK Container-Build, the files are automatically picked up and associated with the documentation unit.
File structure
Tqs (1)
|_ Tqs.adoc (2)
|_ Tqs.slx (3)
|_ Tqs.xlsx (4)
|_ _attachments (5)
|_ Tqs_Calibration_Guide.pdf (6)
|_ Tqs_Initial_Calibration_Values.dcm (6)
|_ Tqs_Variables_List.lab (6)| 1 | Directory for documentation unit Tqs |
| 2 | Textual documentation in AsciiDoc format |
| 3 | Simulink model (source for interactive model) |
| 4 | Excel file with function interface and label description |
| 5 | Sub-directory _attachments for attachments |
| 6 | Files to be attached (any file type) |
|
Folders with name |
ASAM-Based EHB-CB
In the ASAM-based EHB-CB approach, an <ABLOCK> with category ATTACHMENTS must be created and linked to the documentation chapter with which the attachments should be associated. The ABLOCK then lists each file that represents an attachment.
ABLOCK configuration example
<ABLOCK> (1)
...
<AREFS>
<AREF ID-REF="ID_Tqs_Attachments" /> (2)
</AREFS>
...
</ABLOCK>
<ABLOCK ID="ID_Tqs_Attachments"> (3)
<SHORT-NAME>Tqs_Attachments</SHORT-NAME>
<CATEGORY>ATTACHMENTS</CATEGORY>
<FILES>
<FILE>_attachments\Tqs_Calibration_Guide.pdf</FILE> (4)
<FILE>_attachments\Tqs_Initial_Calibration_Values.dcm</FILE> (4)
<FILE>_attachments\Tqs_Variables_List.lab</FILE> (4)
</FILES>
</ABLOCK>| 1 | ABLOCK of the documentation unit to which attachments shall be associated |
| 2 | Reference to the ABLOCK specifying the attachments |
| 3 | ABLOCK with category ATTACHMENTS |
| 4 | Files to be attached (any file type) |