Contents 
 Index 
 "TPT User's Guide" 
 < Previous 
 Next > 

Index Tokens

My faith in going with Mif2Go as the export tool was well-founded. OmniSys’s support and attentiveness to my requests is commendable.

Their support of index tokens is a case in point. Their initial support required generating HTML suitable for Microsoft HTML-Help.

• This inserted MS Object tags with the key word information.

• The Object tags were at the end of the top rather than at the location where the index marker was defined.

I had to create some work-around in my tools to convert the object tag into another format (so that it wouldn’t be seen by the reader). My index was prevented from giving my readers mid-topic jumps, which can be helpful in long topics where the writer added index tokens as aids.

The Mif2Go solution is more general that what I required. How I employ their solution is now more easily supported by voyant_nav.pl when it generates the index files. Moreover, it supports mid-topic jumps immediately after export from FrameMaker without any modification to the tags.

Specifically in the mif2htm.ini file, I define the following information:

[Markers]
Index=VoyIndex

[MarkerTypes]
VoyIndex=Code

[MarkerTypeCodeBefore]
VoyIndex=<a name="<$$objectid>" class="v_index" value="

[MarkerTypeCodeAfter]
VoyIndex="></a>

The result is an anchor tag in the HTML file that can be used as a target for a mid-topic hyperlink.

<a name=”<$$objectid>” class=”v_index” value=”index entry”></a>

The <$$objectid> actually comes from FrameMaker that Mif2Go uses and uniquely identifies the paragraph format. The index entry was text that was extracted from writer-defined index token in FrameMaker.

The voyant_nav.pl Perl program can easily locate anchor tags. When they are determined to be of class=”v_index”, it then knows how to handle the name attribute as part of a fully qualified URL to the HTML filename and target within the file (00000FileOwner.html#$$objectid), as well as the text to display to the reader (“index entry”).

Note: For this to work properly, index tokens should have only one entry per token and should have no more than two levels.



 "TPT User's Guide" 
 < Previous 
 Next > 


Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003

TP Tools v2-00-0a

# tpt-hug-02