System variables on the variables list - Cloud

Variables

Probably the most obvious use of a variable is to display some text that may change when a book or topic is published, such as the date published, or which user published the book. The System type variables are ideal for this. System variables can also be used in external publishing templates.

<Sys_LDate> This date is created by the <Sys_LDate> variable, which displays the date this book was published according to the computer long date format of the computer doing the publishing.

<Sys_User> This is the name of the Author-it user logged in who actually did the publishing, and is set by the <Sys_User> variable.

It should be noted that system variables are set once at the beginning of a publishing session so that all documents published in a session can have the same values when using these variables.

The system variables in this topic are shown in the variable list, however, there are additional system variables that are not shown in the variables list (Edit tab > Variables > List).

The following system variables are visible in the variable list; the variable name is added between angle brackets:

Variable name

Information the variable adds to the published output

SYS_BASEDON

object template id

SYS_BASEDONKEY

object template code

SYS_BASEDONTEXT

object template description

SYS_CREATED

object creation date/time

SYS_CREATEDBY

object created by

SYS_DESCRIPTION

object description

SYS_HEADING

used in external publishing templates to add the web heading or title

SYS_LDATE

long date publishing started

SYS_MODIFIED

object last modified date/time

SYS_MODIFIEDBY

object last modified by

SYS_OBJECT_GUID

object guid

SYS_OBJECTID

object code

SYS_PRIMARY_OBJECT_GUID

if the object is a variant, adds the guid of the primary object

SYS_PUBLISH_FOLDER

publishing output folder of the current book

SYS_SDATE

short date publishing started

SYS_STATEID

object release state id

SYS_STATUS

object status id

SYS_TIME

time publishing started

SYS_TOC_ORDER

the object's sibling index within its level in the book toc

SYS_TOC_PARENT_GUID

object guid for the object's parent in the book

SYS_TOC_PARENT_ID

object id of the object's parent in the book

SYS_USER

user who published the document

SYS_VERSION

object version

The following system variables are also available, but are not shown in the variable list:

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, <

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, <

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

If the <

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: <

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 <
  • 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