PAMMS Repositories, Folder Structure, and Terminology

A component contains AsciiDoc files, their optional assets and examples, one or more optional navigation files, and a component version descriptor file per repository.

In these Help pages and the Antora documentation, the term component version is used when discussing concepts that apply to a version of a component. DFCS doesn’t version its program materials like software programs; therefore, there isn’t a version, so for now, component and component version are essentially the same in DFCS. It’s important to remember that a component’s name and a component’s version may be very different from the names of the repository, branch, or folder where it’s stored.

A component must contain a component version descriptor file named antora.yml. When Antora finds antora.yml in a repository, it knows it has located a component (or part of component in the case of dfcs). The component version descriptor tags the files under its hierarchy with the specified component name and version.

A module is a discrete bundle of content, including text, images, and other source materials, organized in a hierarchy of folders by content format, then by optional topic if needed. One or more modules are stored in a modules directory. A component can contain one or more modules.

The ROOT module contains all the content that’s directly associated with the component itself. When pages in the ROOT module are published, these pages are promoted a level above any other modules' pages in that component’s URL. ROOT doesn’t appear in the URL of the pages.

The pages directory contains a module’s AsciiDoc files. These files are automatically converted to standalone HTML pages. Files in the pages folder will be published to the site even if they’re not listed in a navigation file. See the Standard Policy Document Structure to learn how to structure an AsciiDoc file.

The partials directory contains AsciiDoc files that aren’t standalone pages. These files are referenced by an include directive from a document in the pages directory.

Word documents (the Forms of many of the programs) and PDF files are stored in the attachments directory. Word documents are converted to PDF when Antora runs. Files that were already stored in attachments as PDF are passed through to the site as they are by Antora.

Photographs, screenshots, and graphic files in images are inserted into pages using the image macro.

Non-AsciiDoc files, such as source code, are stored in the examples directory. These files are often inserted into code blocks using an include directive.

A navigation file, often named nav.adoc, contains one or more AsciiDoc lists. Antora uses these files to build the site’s component navigation menus.