Hidden system variables

Variables

The following system variables are not shown in the variables list. These variables are used in publishing templates, used by the library for localized content, and used in command line actions.

When the system variables for HTML publishing template are used, the variable must be added to the template with a namespace declaration.

For example, to use SYS_BREADCRUMBS in the template you must add authorit: inside the first angle bracket.

<authorit:SYS_BREADCRUMBS>

 

Variable name

Where the variable is used

SYS_COMPANY_SHARE

The parent folder of the directory that your Author-it library is stored in. Used by specific publishing profiles to perform after publishing actions.

Note: This variable is automatically updated whenever your library path is updated.

SYS_BREADCRUMBS

HTML template placeholder that resolves to a "breadcrumb" list of links to the current topic in HTML outputs; defined in a custom body_template using a namespace declaration, for example, <authorit:SYS_BREADCRUMBS>

SYS_BREADCRUMBS_WITHOUT_ACTIVE

HTML template placeholder that excludes the current topic from the breadcrumbs in HTML outputs; defined in a custom body_template using a namespace declaration, for example, <authorit:SYS_BREADCRUMBS_WITHOUT_ACTIVE>

SYS_KEYWORDS

HTML template placeholder that resolves to the keywords in the topic; defined in a custom body_template using a namespace declaration: <.authorit:SYS_KEYWORDS>

SYS_LOCALE

If the <SYS_LOCALE> variant exists in a Library it indicates that the Library has been updated to function with the server-based Localize, and the older Author-it Localization Manager software is then limited to just the migration of outstanding translation jobs. The presence of this variable also enables the Author-it Localize Migration toolkit for purposes of migrating localized objects from target libraries to locale variants of primary objects in a single variant-based library.

SYS_LOCALE_ABBREVIATION

Locale code assigned to localized objects for localization purposes.

SYS_TOPIC_BODY

HTML template placeholder for adding topic content; defined in a custom body_template using a namespace declaration: <authorit:SYS_TOPIC_BODY>.

Notes:

  • This variable can be used to add the topic text (without the topic heading) to an HTML template.
  • The variable should be used instead of <aitdata>. This variable will only resolve in external files if the <aitdata> tag is not present. If both are present, then <aitdata> will be resolved and <authorit:SYS_TOPIC_BODY> will not be resolved.
  • The variable should only be used once inside an HTML template. If used more than once only the first instance will be resolved.

SYS_PUBLISH_BOOK_ID

The book's object code (id)

SYS_LIBRARY_COMMAND_LINE

The command line parameter required to open this library

SYS_PUBLISH_FILENAME

Used in a command line action or publishing profile and provides the output filename and file type

SYS_OBJECT_REVISION

Resolves to the revision number for the object, which increments when the topic is saved; so can be used to identify the latest revision of a published topic.