home *** CD-ROM | disk | FTP | other *** search
/ Peanuts NeXT Software Archives / Peanuts-1.iso / Documents / literature / RecipeIndex.0.94.README < prev    next >
Encoding:
Text File  |  1994-04-30  |  5.4 KB  |  125 lines
  1. RecipeIndex  [V0.94 by Izumi Ohzawa, izumi@pinoko.berkeley.edu]
  2.  
  3. [Archive maintainer: please store this file in the same directory
  4. as Recipes.tar.Z, since this package contains a set of tools to index
  5. recipe files in that collection.  Thanks.]
  6.  
  7. OS: 3.0 or later
  8. ARCH: MAB (m68k,i386)
  9.  
  10. This is a Sevice filter daemon for indexing recipe collection in
  11. nroff format available as Recipes.tar.Z at FTP archives.  This is
  12. a replacement (update) for scripts found in Recipes/.index directory
  13. which no longer work for Digital Librarian in NS 3.x or later.
  14. Precompiled FAT binary (m68k,i386) is included.
  15.  
  16. Nroff-format recipe files themselves are not included, you must
  17. obtain them by getting Recipes.tar.Z from the archives.  There is
  18. no need to modify the original recipe files.  You only have to add
  19. several files to the Recipes database directory from this distribution,
  20. and install indexing tools and display scripts.  From the original
  21. package, only the README file is included here as README-Recipes.orig.
  22.  
  23. An alternative way to index this thing is to use a nroff2rtf type
  24. converter, which must exist somewhere, while moving the recipe title
  25. to the top of file.  Then again, you will lose such cool features,
  26. e.g., ability to display recipes with metric measurement units with
  27. a simple modification to .displayCommand.
  28.  
  29. This is a quickly hacked version of the indexing tool for NewsGrazer
  30. articles available as NewsIndex0.93* from the archives.  Only minimal
  31. modifications have been made.  See README-OLD.NewsInex0.93 for info on
  32. details not found in this README file.
  33.  
  34. CAVEAT:  This indexing service may or may not interfere if you
  35. attempt to index local man pages for DL, because it registers file type
  36. "nr".  If you have trouble indexing new man pages, remove
  37. RecipesIndexing.service.  Since the recipes collection appears to
  38. be static (no new ones avaialble), you might want to remove the
  39. service after you've created the index anyway.
  40.  
  41. Also for now, you should avoid using Igor.app from AFS
  42. that comes with WriteUp.app (maybe also with PasteUp too).
  43. NS Release 3.2, DigitalLibrarian, ixbuild are not happy
  44. when Igor.app is in /LocalApps or ~/Apps.  You will get
  45. lots of error messages in the console log from ixbuild
  46. and DL saying ascii paste board could not be filtered etc.
  47. This may not necessarily cause apps to mulfunction, but
  48. it is annoying.  The bug, I was told, is in NeXT side of
  49. software, but until that is fixed, you might avoid Igor.app
  50. anyway.
  51.  
  52.  
  53. --- Installation Procedure -------------------------------------------------
  54. [1] Copy "RecipeIndexing.service" folder into
  55. /LocalLibrary/Services or ~/Library/Services.
  56.  
  57. [2] Copy the following 6 files:
  58.     .index.ftype
  59.     .index.swords
  60.     .displayCommand
  61.     .roffArgs
  62.     .dir.tiff
  63.     Copyright.rtf
  64. into ~/Library/Recipes directory (or wherever you have
  65. installed nroff recipe files).  (Enable "Unix Expert mode" in
  66. Preferences, if you don't see these files in FileViewer.)
  67.  
  68. Rename the obsolete .index directory to something else like .index.old
  69. (just in case the old directory is not completely ignored).
  70.  
  71. [3] Copy xart.awk into /usr/local/lib directory.  Also copy tmac.recip
  72. into /usr/local/lib/tmac.  Create the directories if they do not exist.
  73. [These files and .displayCommand come from rcshow shell script in
  74. the original package written by Brian Reid.]
  75.  
  76. [4] Do "make_services" or, logout/relogin or whatever necessary to
  77. make WorkSpace recreate its services cache.  Try doing Command-u in
  78. WorkSpace while ~/Library/Services/RecipeIndexing.service (or /LocalLibrary...)
  79. is selected.
  80.  
  81. [5] Cd to ~/Library/Recipes (or wherever), and do:
  82.  
  83.     rm .index.store
  84.     ixbuild -gsv -LEnglish .
  85. This will create the first usable index for DL.
  86.  
  87. With the '-v' flag for the ixbuild command, it should print out
  88. filenames being indexed followed by the file type "nr" for nroff
  89. file.  If the file type is not "nr", something is wrong with the
  90. installation.  Possible causes include missing .index.ftype or
  91. RecipeIndexing.service is not correctly installed or the servce is
  92. not yet registered by Workspace (see [4] above).
  93.  
  94. [6] Start DL and drag ~/Library/Recipes onto shelf. Save.
  95.  
  96. [7] From this point on, you should be able to update the index from within
  97. DL via the inspector (if you ever get new recipes in nroff format).
  98.  
  99. [8] To display in Metric measurements (grams, milliliters, etc.
  100. instead of lbs, cups), change "-rM0" to "-rM1" in .displayCommand.
  101.  
  102. [9] Delete the installed RecipeIndexing.service if you are not adding
  103. any new recipes in nroff format (see CAVEAT at the top of file).
  104.  
  105. [10] Install a tastier .dir.tiff in the Recipes folder than the one
  106. I included from NeXT-icon@gun.com Archives (Tools/Spatula/Spatula.tiff).
  107.  
  108. No Copyright is claimed for the RecipeIndex/RecipeFilter.
  109. This program is hereby released into the public domain, and you are free
  110. to use it for any purpose including commercial use.
  111. Note the copyright for the original recipes, however.
  112.  
  113. =================================================================================
  114. For more detailed info on the workings of this daemon and other tips, see
  115. README-OLD.NewsInex0.93.
  116.  
  117.  
  118. --- To Build FAT binary: --------------------------------------------------------
  119. Launch ProjectBuilder.app, do Project->Open Makefile, and open the Makefile
  120. in this directory.  Select target <Default>, and build!
  121. If there is an error, first select target "clean", build, and then select
  122. target <Default> and build.
  123. ---------------------------------------------------------------------------------
  124.  
  125.