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

Tim

6 months ago

3 comments

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

Comments

Michael

6 months ago

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)

On the Project tab, click Project Objects, and then click Text Variables.
In the Text Variables dialog, in the left side, click User Variables.
Use the Add button to add the Description and Keywords variables (with empty values).

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.

Michael

6 months ago

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

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

On the Project tab, click Project Options.
In the Project Options dialog, in the left sidebar, select HTML Export|Head Section.
Copy and paste the code below to the HTML code editor.
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.

Michael

6 months ago

Step 3: Define Description/Keywords values for individual topics

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

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

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.

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

Comments

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

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

Use the following HTML code for the <HEAD> section

Step 3: Define Description/Keywords values for individual topics

Add a Comment