ASAM Exchange Format: Links and Attachments

Links to external Resources

EHB supports URL and file links inside an FSX <CHAPTER> section.

To open an Internet page, add the following:

<P>
	<XREF>
		<LABEL-1>About ETAS EHANDBOOK</LABEL-1>
		<REFERRABLE-REF
			ID-CLASS="EXTERNAL"
			EXT-ID-CLASS="URL">https://www.etas.com/ehandbook%3c/REFERRABLE-REF%3e%3c/XREF%3e%3c/P[https://www.etas.com/ehandbook</REFERRABLE-REF>
	</XREF>
</P>

To open an external file, add the following:

<P>
	<XREF>
		<LABEL-1>Word_template</LABEL-1>
		<REFERRABLE-REF
			ID-CLASS="EXTERNAL"
			EXT-ID-CLASS="URL">file://host/path/Word_template.pdf</REFERRABLE-REF>
	</XREF>
</P>

The text inside <LABEL-1> is shown as link text in EHB-NAV. When you click on it, the “URL” will be executed with its associated Windows tool.

EHB only supports absolute file paths in URL.

Attachments

For a general overview on attachments in EHANDBOOK, please refer to the EHANDBOOK Container-Build User Guide.

Attachments are files associated to a documentation unit in particular a chapter in EHANDBOOK. This can be a general text chapter, a function description or a software component description.

In the ASAM-based EHB-CB approach, an <ABLOCK> with category ATTACHMENTS has to be created and linked to the documentation chapter to which the attachments shall be associated.

The 'ABLOCK' then has to list each file that represents an attachment.

<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)
    </FILE>
</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	File to be attached