How to insert custom content?

Even if the content generated automatically by Antidoc is already valuable, you may want to add your own "hand-written" content to the final document. This could be done by adding plain-text files at specific locations.

Supported locations

You can add custom content to the following sections:

  • Project description

  • DQMH module

  • Library

  • Class

The content will be added to different locations depending on the section.

For project

At the end of the section.

For DQMH Module

After the Responsibilty paragraph.

For library and class

After the Version line.

Content and Images

The written content must be stored in a single file. The text must be formatted with the Asciidoc syntax.

To be inserted into the final document, the adoc file name should be identical to the lib or project file.

  • My Project.lvproj → My Project.adoc

  • My Library.lvlib → My Library.adoc

  • My Class.lvclass → My Class.adoc

To insert images, you need to store them in a specific folder next to the adoc file.

The folder must be named as follows:

  • My Project.lvproj → My Project-images

  • My Library.lvlib → My Library-images

  • My Class.lvclass → My Class-images

Example

How custom content must be stored on the disc
Figure 1. How it is stored on the disc
How it is injected into the final document
Figure 2. How it is rendered in the final document

Content text file syntax

Here is the minimum AsciiDoc Syntax to know to create custom content.

Sections

Use = Section Title to add a section. Use == Sub Section Title for a subsection.

Images

Use the image::filename[] to insert an image.

The full AsciiDoc syntax is supported. See the documentation here to learn more about this awesome syntax.