Navigation: Getting Started >

A-Keywords

Send comments on this topic.

  

 

You can add A-Keywords to your project and associate them with help topics. Unlike regular keywords, A-Keywords do not appear in the Index, but topics can be found and shown via a hyperlink using an ALink macro or via a special HTML Help API call from a Windows application.

 

The Keyword pane displays the A-Keywords of the current help project under the "A-Keywords" node. If you do not see the Keyword pane, on the View tab, click Keywords.

 

Remark: A-Keywords is a feature provided by HTML Help and is not supported by other output formats.

 

Add an A-Keyword


1.In the Keywords pane, select the A-Keywords node or an item under this node.

2.On the Project tab, in the Keywords group, click Add.

3.In the Keywords pane, enter a name for the new keyword.

4.Press Enter.

 

Remark: Unlike regular keywords, A-Keywords cannot include sub-items.

 

Delete an A-Keyword


1.In the Keyword pane, select the A-Keyword that you want to delete.

2.On the Project tab, in the Keywords group, click Delete.

 

Rename an A-Keyword


1.In the Keyword pane, select the A-Keyword that you want to rename.

2.On the Project tab, in the Keywords group, click Rename.

3.Enter a new name for the selected A-Keyword.

4.Press Enter.

 

Associate Topics and A-Keywords


An A-Keyword can be associated with any number of help topics.

 

To edit the association of one of more A-Keywords with the currently opened help topic, you can simply check or unckeck the A-Keywords in the Keywords pane.

 

Also, you can edit topic associations for an individual A-Keyword, to do so:

1.In the Keywords pane, select the A-Keyword you need.

2.On the Project tab, in the Keywords group, click Properties.

3.At the dialog box, check the topics that should be associated with the selected A-Keyword.

4.Click OK.

 

Using an ALink Macro


The ALink macro looks up for the list of topics which are associated with an A-Keyword. If the help system finds a single topic, that topic will be displayed immediately. In case more than one topic is found, the help system will suggest the user to select a topic to display. Thus, A-Keywords and the ALink macro can be used to display the list of related topics when the user clicks a special hyperlink.

 

To insert a hyperlink with an ALink macro:

1.In the word processor, put the cursor where you want to insert a hyperlink.

2.On the Insert tab, click Hyperlink.

3.At the dialog box, in the left sidebar, click Macro.

4.Enter text of the new hyperlink in the Text to display box.

5.In the Command box, select "ALink".

6.In the Keywords box, enter one of more A-Keywords that the ALink macro will search for.

7.Click OK.



Copyright © 2007-2019 HelpSmith.com