home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / bookm2.zip / INDEXING.IPF < prev    next >
Text File  |  1994-11-11  |  3KB  |  80 lines
  1. :userdoc.
  2. :title.Indexing Demo
  3. :docprof toc=123.
  4. .***************File Created with BookMaker ********************
  5. .*****    Indexing Demo
  6. .*****    11 Nov 1994
  7. .*****    15:52:35
  8. .***************************************************************
  9. .************************************************************
  10. :h1 res=1.
  11. Overview
  12. .************************************************************
  13. :i1 id=1.Overview of Indexes
  14. :p.
  15. :color fc=darkblue bc=default.
  16. :font facename=Helv size=36x20.Indexing:font facename=default size=0x0.
  17. :color fc=default bc=default.
  18. :i2 refid=1.Description
  19. :p.
  20. Indexing allows the user to search an index for a particular topic or
  21. keyword in alphabetical order.  The indexing features of the Information
  22. Presentation Facility allow the developer to set keywords and synonyms and
  23. to place these keywords into appropriate order using the sortkey tag.
  24. :p.
  25. In this example &colon.h1 the words "Overview of Indexes" are used as a primary index
  26. tag for the heading.  The word "Description" is a secondary heading, and
  27. so it falls as a subheading to the first.
  28. :note.
  29. You don't need to insert an ID unless you're going to be using a secondary tag.
  30.  
  31. .************************************************************
  32. :h1 res=2.
  33. Index Order
  34. .************************************************************
  35. :i1.Index Order
  36. :p.
  37. Notice that in the index, "Index Order" comes before "Overview".  By default, an index
  38. is alphabetical.  A secondary index is listed in alphbetical order beneath it's primary.
  39. :i1 sortkey='ZZZZ'.A Placement Example
  40. Notice that "A Placement Example" is listed at the end of our index.  In this case
  41. "A Placement Example"  would normally come first in our list, but we have changed
  42. it's sort order to "ZZZZ" which places it last.  
  43. .************************************************************
  44. :h1 res=3.
  45. Index Synonyms
  46. .************************************************************
  47. :i1 roots='fruit'.Index Synonyms
  48. :isyn root=fruit.apple pear banana peach grape
  49. :p.
  50. Index synonyms are used as a sort of invisible secondary index to
  51. your document.  It's a bit difficult to explain in an online document.  We
  52. add the word -A-p-p-l-e- (we're using the actual word in the synonym
  53. tag, but I don't want the search engine to see it in the actual document)
  54. as an example.  This page is located under "Index Synonyms", but if
  55. you search the index for -A-p-p-l-e-(minus the dashes) you'll see that
  56. the page comes up in your search.  Try some other fruits and see if you
  57. can come up with the something.
  58. :p.
  59. In this example we set a root word for the heading and then associated
  60. root word with the synonyms we chose for the word. 
  61. .************************************************************
  62. :h1 res=4.
  63. Global Attributes
  64. .************************************************************
  65. :i1.Global Setting
  66. :p.
  67. You'll notice in the BookMaker Index window that there's a checkbox
  68. for a global tag.  This tag is valid only in Help (*.hlp) windows.  Using this tag
  69. will add a topic to the OS/2 Master Help Index.
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79. :euserdoc.
  80.