Glossary

assembly

The AsciiDoc source produced by reducing the AsciiDoc of one or more pages in the site and merging them together into a single AsciiDoc document. The assembly is driven by the navigation structure.

assembly file

A virtual file that encapsulates the assembly. An assembly file provides additional metadata, such as the AsciiDoc attributes for use during conversion and the resource ID template for creating the export file. The assembly file is what the converter provided by the exporter extension accepts as input to generate the export file.

assembly model

The data and configuration that is used to drive the assembly process. The data consists of the navigation data, which defines which pages are merged and how they are organized. The configuration controls the level at which the assembly is performed, how to merge sections with the navigation structure, whether to insert the start page, and information about the export format.

converter

Software that converts AsciiDoc to another format. Here we are talking about an AsciiDoc converter, such as Asciidoctor PDF.

convert function

A function that converts the AsciiDoc source of the assembly to the target format. Typically, this function will delegate to a system command such as asciidoctor-pdf.

converter metadata

Information about the target format, such as the file extension, media type, and AsciiDoc backend.

exporter

An Antora extension that configures and runs the assembly process primed for the target format and provides a converter to transform the assembly into the export file.

export

The converted AsciiDoc source of the assembly. The conversion is handled by the converter provided by the exporter.

export file

A virtual file stored in Antora’s content catalog that encapsulates the export. An export file provides additional metadata, such as the resource ID, output location, and publication metadata, that is used by Antora for referencing and publishing.

navigation data
navigation structure

The hierarchy of page references that Assembler uses to merge pages into an assembly. Typically, this navigation is shared with the site, though an alternate navigation may be provided.