Return to readme.txt CVS log

Up to [WindowsNT SDKs] / mstools / hlpindex

Annotation of mstools/hlpindex/readme.txt, revision 1.1.1.1

1.1       root        1: Building a Help Index
                      2: 
                      3: This file contains complete details on how to build a help index which
                      4: spans either a single, or multiple help files.  This functionality allows a user
                      5: to search for any word in a help file.
                      6: 
                      7: ***NOTE: The Full Text Search functionality is specific to Windows NT. If
                      8: you intend to ship your application on other platforms, such as Windows 3.1, 
                      9: then you should not install the .IND file.  The .HLP files will still work, but
                     10: the Find button will not be registered.
                     11: 
                     12: 1.  Copy the complete HLPINDEX directory to your local hard drive.
                     13: 
                     14: 2.  Copy NMAKE.EXE from your \MSTOOLS\BIN directory into the HLPINDEX directory.
                     15: 
                     16: 3.  Edit the BAG.INI file to correspond to your help project.  The sample file
                     17:     looks like this:
                     18: 
                     19:        [bag.ini]
                     20:        groupcount=2
                     21:        group1=hlpfile1
                     22:        group2=hlpfile2
                     23: 
                     24:        [hlpfile1]
                     25:        Indexfile=hlpfile1.ind
                     26:        Title=Sample Help File 1
                     27: 
                     28:        [hlpfile2]
                     29:        Indexfile=hlpfile1.ind
                     30:        Title=Sample Help File 2
                     31: 
                     32:     This BAG.INI will create an index file, hlpfile1.ind which contains the
                     33:     full text search index for the two help files HLPFILE1.HLP and HLPFILE2.HLP.
                     34:     Following are the descriptions of each element of the BAG.INI:
                     35: 
                     36:        groupcount -    The number of helpfiles to cross index.  Must be less 
                     37:                        than 15.
                     38: 
                     39:        group[1-15] -   The name of each individual help file.
                     40: 
                     41:        [hlpfile1] -    Each individual group needs a separate configuration
                     42:                        section, identified by the helpfile name.
                     43: 
                     44:        Indexfile -     The name of the resulting .IND file.  This must be the
                     45:                        same for all groups.
                     46: 
                     47:        Title -         The full name of the help file.  This appears in the
                     48:                        Found dialog alongside each hit.
                     49: 
                     50: 4.  Copy the BAG.INI into your development directory (wherever you build the 
                     51:     help file)
                     52: 
                     53: 5.  Add the following lines to your .HPJ files (found in GENERIC.HPJ):
                     54: 
                     55:        [Baggage]
                     56:        bag.ini
                     57: 
                     58:        [config]
                     59:        RegisterRoutine("ftui","InitRoutines","SU")
                     60:        InitRoutines(qchPath,1)
                     61:        RegisterRoutine("ftui","SwitchToTopicsFound","U")
                     62:        AddAccelerator(0x46, 2, "SwitchToTopicsFound(hwndApp)")
                     63:        RegisterRoutine("ftui","ExecFullTextSearch","USSS")
                     64:        CreateButton("ftSearch","F&ind","ExecFullTextSearch(hwndApp,qchPath,`',`')")
                     65:                        
                     66:     This will tell the help compiler to build in the hooks for the index file,
                     67:     and to provide the Find button in each help file.
                     68: 
                     69: 6.  Rebuild all of your help files.
                     70: 
                     71: 7.  Copy all of the help files into the HLPINDEX directory.
                     72: 
                     73: 8.  Copy all of the GENERIC files to the same name as your index file.  For
                     74:     example if your index file was FOO.IND, then you would copy GENERIC.* to 
                     75:     FOO.*.
                     76: 
                     77:        NOTE: The GENERIC.STP file contains a list of words which will not be 
                     78:              indexed.  You can add your own words to this list.
                     79: 
                     80: 9.  Run the HLPINDEX batch file as follows:
                     81: 
                     82:        HLPINDEX FOO -    Creates FOO.IND for one HLP file.
                     83:        HLPINDEX /m FOO - Creates FOO.IND to cross-index multiple HLP files.
                     84: 
                     85: 10. You can now simply put all of the .HLP files and the .IND file in the same
                     86:     directory.  Start winhlp32 foo.hlp and hit the Find button for Full-Text
                     87:     Search.

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.