Create clever Documents with Attributes

Imagine you have released a new version of your software and now need to adapt the manual. Before adoc Studio, this would have meant that you would have had to rewrite each instance individually from “Version X” to “Version Y”.

With adoc Studio, you use attributes to speed up adaptations. We define the version number as a variable and place this variable instead of the number in the text. If changes are made, simply adjust the number in the definition and the current version number is displayed everywhere.

This makes it easy to insert and adapt recurring content. Not only version numbers, but also the name of your product or specific URLs, for example, can be quickly integrated.

In addition to its use as a variable, adoc Studio offers a wide range of standard attributes. Here are just a few of the most popular attributes:

  • :toc: inserts a table of contents into your document

  • :icons: font displays admonitions as icons instead of text

  • :stem: activates mathematical formulas and equations (according to AsciiMath or LaTeXMath)

  • :ads-footnotes: defines whether and where footnotes should be displayed

  • :title-page: adds a title page to the PDF output

  • :page-nums: displays page numbers in the PDF output

But that's not all. For a complete overview, simply press the ESC key to call up the adoc Coach. The Attributes (Definition) entry now lists all attributes together with a brief explanation.

Many attributes must be inserted above the title, in the document header. This guarantees that the attribute is active throughout the document.