Using the Project Templates

Navigation:  Premium Pack 1.51 >

Using the Project Templates

Previous pageReturn to chapter overviewNext page

Show/Hide Hidden Text

This Premium Pack contains two different versions of the tabbed navigation templates: skins and project templates. Project templates are really just normal projects.

To use a project template in a new project you just need to make a copy of the project template file and start editing.

To use a project template in an existing project you need to import the template components to your existing project. This is possible, but it is generally easier and more efficient to use skins instead of doing this.

Click to expand/collapseProject template files location

The project template files are stored in the My HelpAndManual Projects folder inside your My Documents directory (in Windows 7 and Vista My Documents is just called Documents):

\My HelpAndManual Projects\Premium Pack

If you do not see the My HelpAndManual Projects directory this means that you deselected the option for installing sample files when you installed Help & Manual. To correct this just reinstall Help & Manual on top of your current version and select the option for installing the sample files during the custom install process. You will need to reinstall the Premium Pack after doing this.

Click to expand/collapseUsing project templates for new projects

1.Choose the template you want to use – you can experiment by publishing an existing project with the skins in this Premium Pack until you find the one you want to use.

2.Copy the .hmxz project template file to your project folder and rename it.

3.Edit the project as normal – everything you need for the template layout is already set up

4.When you publish your project you can turn the optional template features on and off with the options that appear in the Include Options box in the Publish page:

PP 3-frame layout
Activates a third frame above the help for integration in your own website - for example for your website's standard header. See here for instructions.

PP Topic Auto-TOC
Activates the Auto-TOC button that allows the user to navigate in the current topic with a drop-down menu. See here for instructions.

PP Breadcrumbs
Turns on a navigation box inside the topic header with a list of links to the topics above the current topic.

PP User comments
Activates user comments in WebHelp using a free Disqus or IntenseDebate comments account. You need to set this up before you can use this feature. See User Comments in WebHelp for details.

PP Mail feedback
Activates a mail  button in the topic header with which users can mail you feedback on the current topic. References to the topic in question are automatically inserted.

PP JS-Popups
Activates the Premium Pack's advanced JavaScript popups instead of Help & Manual's standard popups. Advanced popups are draggable and resizable and can contain videos as well as formatted text and graphics. See Using Advanced JS Popups for details.

PP Print button
Activates a button in the topic header for printing the current topic. This is particularly useful for WebHelp, where some browsers have trouble printing just the topic in a frame.

PP Sortable tables
Activates the sortable tables option, enabling you to have dynamically-sortable tables in your project. The user viewing your help can resort the tables by clicking in the table heaer. See here for instructions.

PP Webhelp subtitle
Adds a project subtitle beneath the topic header in the navigation pane for WebHelp. You need to enter the text for the subtitle in your configuration variables.

PP Toggles button
Adds a button to the navigation area in the topic header that allows the user to expand and collapse all toggles on the current page by clicking on the button.

PP TOC Show/Hide
Adds a slide-out button to the left of the topic title in the topic header that allows the user to hide the entire navigation pane. If the user has cookies enabled the current user-set width of the navigation pane will be remembered between topics. Otherwise the standard width set in the template will be used.

PP Webhelp URL display
Displays the URL of the current topic at the bottom of the topic for Webhelp. This makes it easy to copy the URL to the topic for reference purposes. The location is fully automatic if the user has JavaScript on but you should enter your server address in the configuration variables for users who don't have JavaScript on.

Click to expand/collapseUsing project templates for existing projects

The easiest way to use the Premium Pack with existing projects is to use the skins when you publish your project. However, if you wish you can also import all the necessary template components to an existing project.

1.Open your own project and select the Baggage Files entry in the Topic Files section of the Project Explorer.

2.Select Add File in Project > Manage Topics and select the .hmxz project template file you want to import from. You will be asked if you want to import the baggage files, confirm with yes. (This will not overwrite your own baggage files if your project already contains any.)

3.Select the Default template in Configuration > HTML Page Templates and then click on the Copy Properties From... button at the bottom of the screen. Select the .hmxz project template file and confirm that you want to copy the settings for this page.

4.Use the same procedure to import the Custom Builds and Text Variables pages in Configuration > Common Properties. Note that this will overwrite any custom builds in your project – if you want to avoid this you need to enter the 5 custom builds required for the project settings manually. You can merge the variables with your own project variables by exporting them from the template project with the Export button and then importing them in your project with the Import button – but it is really easier to use a skin if this is necessary.

5.Select the WebHelp section in Configuration > Publishing Options and again click on the Copy Properties From.. button and select the .hmxz project template file as the copy source. Confirm that you want to copy the settings for the entire section.

That is everything you need. Again, it is much easier to use skins for styling existing projects and the results will be exactly the same. You will only really want to use this procedure if you plan to edit the code of the template yourself after importing all the components.

Click to expand/collapseConfiguring the project template you want to use

Once you have chosen the template you want to use you will probably want to configure it for your own needs. For example, you will at least want to enter your own email address for the mail feedback button and the address of your help on your own server for the topic URL display feature for WebHelp. If you want to use a subtitle in WebHelp you will also want to enter the text of the subtitle. If you are going to use the 3-frame layout option there are also some additional settings you will want to make.

These texts are stored in text variables in the project template file. To edit them select Text Variables section in Configuration > Common Properties. All the variables you can edit are unprotected, the variables you should not normally edit are protected and are shown grayed out.

See Configuring Your Skin or Template for full instructions.