Variable text

Variables can be used to provide common values that are authored once, then used throughout your help document. This allows you to create placeholders for values that are likely to change, and to reuse common text throughout your project. There are also system variables for things like horizontal lines, the help icon, and date/time.

Help crafter provides several builtin variables, and you can also add your own variables. Variables you add can be localized into each language your help project supports. See

Builtin variables include:

Name

Description

BundleIcon

The help icon set for the project

PageTitle

The localized title of the current page.

HorizontalRule

A divider line drawn horizontally across the page

Author

The author name set in the contact info

AuthorEmail

The author’s email address set in the contact info.

Company

The company name set in the contact info.

Website

the website URL et in the contact info.

ShortDate

a short date, such as 1/22/16. The date is localized and formatted according to the rules of the each locale.

LongDate

A long date, such as January 22, 2016. The date is localized and formatted according to the rules of the each locale.

LongDateTime

Date and time, such as January 22, 2016 at 5:14:29 PM. The date and time are localized and formatted according to the rules of the each locale.

DayOfWeek

the day of the week, such as Friday. The day is localized and formatted according to the rules of the each locale.


To insert variables in your help content:

User variables can be added, modified, or removed by accessing HelpBook Settings.

Copyright © 2015 - 2016 Putercraft, LLC

Still need help? Please email us with any questions.