attachElementElementElement functions can be customized with set and show rules.
set and show rules.A file that will be attached to the output PDF.
This can be used to distribute additional files associated with the PDF within it. PDF readers will display the files in a file listing.
Some international standards use this mechanism to attach machine-readable data (e.g., ZUGFeRD/Factur-X for invoices) that mirrors the visual content of the PDF.
Example
#pdf.attach(
"experiment.csv",
relationship: "supplement",
mime-type: "text/csv",
description: "Raw Oxygen readings from the Arctic experiment",
)
Notes
- This element is ignored if exporting to a format other than PDF.
- File attachments are not currently supported for PDF/A-2, even if the attached file conforms to PDF/A-1 or PDF/A-2.
ParameterParameterParameters are input values for functions. Specify them in parentheses after the function name.
pathRequiredRequiredRequired parameters must be specified when calling the function.PositionalPositionalPositional parameters can be set by specifying them in order, omitting the parameter name.
The path of the file to be attached.
Must always be specified, but is only read from if no data is provided in the following argument.
dataRequiredRequiredRequired parameters must be specified when calling the function.PositionalPositionalPositional parameters can be set by specifying them in order, omitting the parameter name.
Raw file data, optionally.
If omitted, the data is read from the specified path.
relationship
The relationship of the attached file to the document.
Ignored if export doesn't target PDF/A-3.
Available string values:
sourceThe PDF document was created from the source file.
dataThe file was used to derive a visual presentation in the PDF.
alternativeAn alternative representation of the document.
supplementAdditional resources for the document.
Default value: none
mime-type
The MIME type of the attached file.
Default value: none