HelpSmith Logo
Making Help Authoring a Pleasure to Do
Free DownloadStart your free trial now
HelpSmith Topics
Making Help Authoring a Pleasure To Do

How to set meta tags for topics in a Web Help system?

Is it possible to set keywords and description meta tags for individual topics? Can you provide instructions for this task?

38

Comments

Is it possible to set keywords and description meta tags for individual topics?

You can use the following instructions to add the meta tags to help topics in your web help system.

Step 1: Add the Description and Keywords variables (on the project-level)

  1. On the Project tab, click Project Objects, and then click Text Variables.
    Editing variables of the help project
  2. In the Text Variables dialog, in the left side, click User Variables.
  3. Use the Add button to add the Description and Keywords variables (with empty values).
    Adding variables for meta tags on the project level

Remark: On the project level, you should define the Description and Keywords variables with empty values as they will be used by the topics which do not override these variables on the topic-level.

21

Step 2: Set the HTML code for the <HEAD> section

Set the following HTML code for the HEAD section in Web Help's settings:

  1. On the Project tab, click Project Options.
  2. In the Project Options dialog, in the left sidebar, select HTML Export|Head Section.
  3. Copy and paste the code below to the HTML code editor.
  4. Click OK.

Use the following HTML code for the <HEAD> section

<IF_#WebHelp>
  <IF_#Topic>
<meta name="description" content="<%Description%>">
<meta name="keywords" content="<%Keywords%>">
  </IF_#Topic>
</IF_#WebHelp>

Thus, this HTML code will output the Description and Keywords variables into the <head> section of the generated topics.

18

Step 3: Define Description/Keywords values for individual topics

Finally, you should define the values of the Description and Keywords for specific topics.

  1. In the Project Manager pane, double-click on a topic to edit its properties.
  2. In the Properties dialog, click Variables.
  3. In the Text Variables dialog, use the Add button to add the Description and Keywords variables with the needed values.
  4. Click OK.

Defining variables for meta tags on the topic level

Remark: Alternatively, in Project Manager, you can right-click on a topic, and then click Text Variables in the popup menu.

Thus, on the topic-level, you can define the values of the Description and Keywords variables, which will be inserted into the <head> section of the given topic.

12

Add a Comment

Please Login or Register or leave comments.

Hello World
Lorem ipsum dolor sit amet
OK
Login
Nickname or Email:
Password:
If you do not have an account, you can register.