Text Variables

Text type variables can be used wherever you want to place a standard small string of text.

• Text variables substitute the variable with a string of text up to a maximum of 2000 characters.
• List-of-value variables use a predefined list of values enabling the user choose a single value to match a particular context.

Let's say you are producing a manual for a piece of equipment that will be branded for one of three companies. To achieve this you create a text variable called <company_name> and add it to the topics where ever the company name is used. You then create a manual for each company and add your topics, and any additional topics specific to that company.

To turn this variable into the specific company name you assign the <company_name> variable to each company's book and update the value with the correct name.

However, to ensure the company name is used correctly, you make this variable a list-of-values type, and enter the three company names into the list. If other authors assign the company name to any documents, the choice is is made from the preset list, ensuring errors are not introduced by typing the text.

Including Variables in the Value of Other Variables

To add even more power to variable substitution, a variable value can be created from several variables. Author-it resolves the variable by substituting the value for each variable in turn, and uses the full string in the published output.

As an example, each version of Author-it uses a build number like 5.0.8.295 which is broken into three parts:

Major = 5

Minor = 0

Revision = 8.295

We have created a variable <AIT_BUILD>. This variable has a value that is created from three other variables <AIT_MAJOR>, <AIT_MINOR>, and <AIT_REVISION>.