Glossary

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 outline compiled from the navigation data.

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.

The data and configuration that is used to drive the assembly process. The data consists primarily of the outline, 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 as described by the outline, whether to insert the start page, and information about the export format.

The title of the merged page used in the assembly. The page’s doctitle is only used if the navtitle for the page is not specified in any of the ways available (assembly-navtitle attribute, text of xref in navigation, or navtitle attribute).

AsciiDoc attributes defined on the assembly file (asciidoc.attributes property), as well as the implicit docname, docdir, docfile, docfilesuffix, outdir, outfile, and outfilesuffix attributes. (Additionally, the imagesdir attribute is set to empty string to deactivate its functionality). The attributes defined on the assembly file are the same attributes inherited by any page in the same component version plus the explicit and intrinsic Assembler attributes. AsciiDoc attributes defined on a component version also inherit attributes defined at the site level.

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.

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

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

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.

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

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.

The navigation built from nav files specified in the component version descriptor. The navigation is used as the source for the outline.

The hierarchy that Assembler uses to merge pages into an assembly. This hierarchy is compiled from the navigation data for a given component version. By default, the source navigation is shared with the site. However, alternate navigation may be provided using an assembler profile.

The merged page that occupies the first position in the body of the assembly, regardless of its position in the outline. While typically the root page, it may not be. For example, when the root level is 1, the first child of a text entry that’s a page reference is the leading page.

The merged page at the root of the outline that occupies the first position in the body of the assembly. For root level 0, this is typically the start page (or the first top-level outline entry if the start page is not inserted). For root level 1, this is typically the top-level outline entry.