Templates are used to to customize appearance of your documentation.

Templates are stored inside project file. 

To use template you need to add it to project first. Read this to know how.

Some default templates are in the "templates" sub folder of Helpinator installation folder.


1. HTML Templates. 

Use HTML Templates to change CHM file and Web help looks. Each page can have it's own HTML template. HTML templates are divided into HTML and CSS parts. Use HTML to create topic page structure and CSS to change layout.

Templates use pseudo-tags to define layout. Pseudo-tags are lines of text in the format {%tagname%} where tagname is the name of the tag to be used.

You can use the following pseudo-tags to fit topic inside template


Tag

Description

TITLE

Title of the topic.

CONTENT

Topic text.

PREVNEXTTOPIC

Navigation links to previous and next topics. It Looks like:

Previous | Next

NEXTTOPIC

Link to the next topic.

You can change title of this link from default "Next" to something else with this format:

%NEXTTOPIC="Tag Title"%

PREVTOPIC

Link to the previous topic.

You can change title of this link from default "Previous" to something else with this format:

%PREVTOPIC="Tag Title"%

BREADCRUMBS

Path to the current topic. It contains links to the topics that lead to the current topic.

For example:

About > Order > How To Purchase.

SEEALSO

Links to related topics. Keywords assigned to the current topic are used to create this list. If some topics have the same keywords that the current topic has then they will be in this list.

You need to specify title of this block. For example:

SEEALSO="Related Topics:"



Also you can use project's variables.

Predefined variables:

Variable

Description

COMPANYNAME

Your software company.

YEAR

Year of the release.

VERSION

Release version.

PROGRAMNAME

Software title.


2. RTF Templates

RTF Templates are used to produce RTF and PDF files. RTF Template consists of 3 pages:

- Front Page

- Contents Page

- Topic Page


Also RTF template has two additional areas for PDF output that you can change:

- Header

- Footer


Front page defines the looks of the first page of your document. It is recommended to use project variables to customize it.


Contents Page is used to render contents of the document. It consists from lines like "LEVEL1 TEXT", "LEVEL2 TEXT" and so on. The number after "LEVEL" word identifies level of this entry. For example, if you have a topic in your help file named "Main Topic" and a subtopic "Sub Topic" then style of the line "LEVEL1 TEXT" is used to render "Main Topic" entry and "LEVEL2 TEXT" to render "Subtopic".


Topic page doesn't allow much customization. You can only use "CONTENT" and "TITLE" pseudo-tags.


Header and Footer are only for PDF. Header and footer apply only for pages with content (e.g. except front page). Beside project variables header and footer can have the following variables:

- {%PAGENUM%} - current page number.

Related Topics:
Templates
PDF/RTF Templates
CHM/Web Help Templates
RTF