home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / utilities / utilsd / diskind / !DiskInd / !Help next >
Encoding:
Text File  |  1995-09-10  |  9.7 KB  |  227 lines
  1. DISK INDEXER
  2. ============
  3.  
  4. by JJF
  5.  
  6.  
  7. THIS IS ONLY A DEMO!
  8.  
  9. This is a freeware demonstration version of !DiskInd; it contains almost all
  10. of the features of the original, with the only exception being that it is not
  11. able to index (or scan) any discs.
  12.  
  13. Since this would usually make the program totally useless, a pre-prepared
  14. demonstration file (containing details of most of the Acorn Computing
  15. cover-discs) is supplied.
  16.  
  17. Please copy this demonstration and pass it to anyone who wants it.  Feel free
  18. to upload it to bulletin boards or FTP sites.  If any PD library wants to
  19. distribute it, then they have my permission.
  20.  
  21. If you would like to obtain the full version (which does allow the indexing
  22. of new discs), then please send £2.50 and a blank disc to :
  23.  
  24.    JJF,
  25.    49 Hollyberry Close,
  26.    Winyates Green,
  27.    Redditch,
  28.    Worcestershire,
  29.    B98 OQT.
  30.  
  31. I can accept payment in stamps, postal orders, or cheques (payable to
  32. J. Farmer).  Your copy of the program will usually arrive within a week (unless
  33. you are unlucky enough to send in your money while I am on holiday, in which
  34. case it might take two weeks).
  35.  
  36. Please note that you will NOT be permitted to make copies of the full version
  37. of !DiskInd for non-personal use.
  38.  
  39. Right, that's the serious bit over with.  Now let's say what this program
  40. actually does...
  41.  
  42.  
  43. INTRODUCTION
  44.  
  45. I often envy people with hard discs.  20/40/80/whatever megabytes of storage
  46. space to fill up with all the stuff you would ever want; the ability to
  47. organise everything to perfection.  I, meanwhile, have all my software
  48. spread throughout several hundred discs in no particular order.  The stuff
  49. I use often can be found with little difficulty, but all the little
  50. utilities you find on magazine cover discs, and all the things I never use;
  51. if for any reason I want to find them, it is as near to impossible as makes
  52. no difference.
  53.  
  54. The problem came to a head about a month ago, when I was looking for a 3D
  55. adventure game that I was SURE was on one of those discs.  After about an
  56. hour of looking, I gave up.  I still haven't found it to this day.
  57.  
  58. I had previously used Menon to index my software, but this wasn't really
  59. practical - it became hard to remember what each bit of software did from
  60. just the filename.  I decided that a new solution was necessary, and
  61. !DiskInd is the result of this.
  62.  
  63.  
  64. WHAT IT DOES
  65.  
  66. !DiskInd is a multi-tasking program that will sit on the icon bar and "scan"
  67. a disc (create a record of what is on it) on request.  Individual files,
  68. applications or directories can have an "info text" attatched to them, which
  69. is just a paragraph describing what it is.  Searches of the database can
  70. be made, looking either for a filename or for a phrase in the info texts.
  71. And, most importantly, files/applications can be run and directories opened
  72. simply by clicking on them.
  73.  
  74.  
  75. HOW TO USE IT
  76.  
  77. Double-click on the !DiskInd icon in the filer window and !DiskInd will
  78. install itself on the left-hand side of the icon bar.  Now, select "Scan
  79. Disk" from the icon bar menu and a "Drive Selector" window will pop up,
  80. presenting you with a box containing the phrase "ADFS::0.$" and a button.
  81. The "ADFS::0.$" bit is the path to be scanned; this can be changed by
  82. clicking on it and amending it from the keyboard in the standard Risc OS
  83. way.  It is set to ADFS drive 0 by default, and you probably won't want
  84. to change it from that.
  85.  
  86. Click on the "Start" button to scan the disk currently in the drive - a
  87. window will appear to inform you of the progress the program is making,
  88. although the scanning process does not currently multitask.  Unless you are
  89. scanning something like a CD-ROM that contains masses of files, this should
  90. not be a problem.  !DiskInd will scan inside ArcFS archives only if ArcFS is
  91. already loaded.
  92.  
  93. After scanning, two windows will appear - a large one and a small one.  The
  94. small one contains a list of all the discs that !DiskInd knows about, whilst
  95. the large window displays the information that has just been collected from
  96. the disc.  Click SELECT on any item in the large window to run it - the
  97. action will take place as if the item had been double-clicked on in a filer
  98. window.  A click of SELECT on any disc name in the smaller window will bring
  99. up the information in the large window for that disc.
  100.  
  101.  
  102. INFO TEXT
  103.  
  104. As previously mentioned, each item can have some info text attatched to it.
  105. Click ADJUST on an item in the large window to change it - an oblong window
  106. pops up for you to type into, and when you press RETURN/ENTER or click on
  107. the OK button this text will appear in the large window.
  108.  
  109.  
  110. SEARCHING
  111.  
  112. Bring up the icon bar menu and slide across the "Search" option to reveal
  113. a dialogue box.  A large white box is supplied - type into this what you
  114. would like to search for, and click on the appropriate radio icon (diamond
  115. shaped box) to select whether to search for a file of a particular name or
  116. for a phrase in the info text.  Note that, when searching filenames, only
  117. files with the name given will be displayed - so searching for "!Run" will
  118. not bring up any files called "!RunImage".  However, searching info text
  119. is not subject to this constraint - so a search for "Cheat" will bring up
  120. items whose info text is "James Pond cheat", "Saloon Cars Deluxe cheat", or
  121. "Oh No More Lemmings cheat".  As per usual, you can click on any item in the
  122. window brought up to run it, although you can NOT change an item's info text
  123. from this window.
  124.  
  125.  
  126. FINER POINTS ABOUT DISK NAMES
  127.  
  128. If you lose the window containing the list of the discs that !DiskInd knows
  129. about (i.e. you click on it's close icon), then selecting the "Display Disc"
  130. option from the icon bar menu will bring it up again.  Alternatively, if
  131. you slide across this menu item to bring up a small dialogue box, you can
  132. type in a disc name and it's catalogue will appear.
  133.  
  134. !DiskInd knows each disc by a name, as displayed in the small window
  135. containing the list of the discs !DiskInd knows about (subsequently to be
  136. referred to as the "Disk Name Window") - usually this name is the same as
  137. the disc's actual name (as set by clicking on the disc drive icon and typing
  138. into the "Name disc" dialogue box, or when formatting the disc - it is by
  139. this name that the filer knows the disc), but, should you wish, you can
  140. change the name !DiskInd uses (which does not affect the name the Filer will
  141. use).  To do this, bring up the Disk Name Window and click MENU on one of
  142. the disc names - type the new name into the "Rename" dialogue box.  From
  143. this menu, you can also tell !DiskInd to forget about a disc - select
  144. "Remove" to do this.
  145.  
  146. !DiskInd, like the filer, does not like two discs to have the same name.  If
  147. you try to scan a disc with the same name as one that !DiskInd already knows
  148. about, you will be given three options.  "Update" will cause this new disc
  149. to replace the old one in !DiskInd's index - useful if you have changed the
  150. contents of a disc.  "Rename" allows you to scan this disc under a different
  151. name - this does NOT affect the name by which the Filer will know this disc.
  152. "Cancel", predicatably, stops the scan.
  153.  
  154. Occasionally, the program will be unable to find the disc name - usually
  155. when scanning a hard disc or the resource filer or something - and you will
  156. be asked to type in an alternative name.
  157.  
  158.  
  159. SAVING
  160.  
  161. Selecting "Save" from the icon bar menu will obviously save the index to
  162. disc - to avoid allocating yet another filetype, the index is saved within
  163. the !DiskInd application.
  164.  
  165.  
  166. CONFIGURATION
  167.  
  168. Selecting "Config" from the icon bar menu displays the configuration window.
  169. The "Scanning multitasks" option is just for future enhancements, but all
  170. of the others work.  The "Scan inside apps" buttons allow you to select
  171. whether or not to scan inside applications - putting this to "Never" will
  172. speed up the scanning of discs, but will cause !DiskInd to miss the contents
  173. of many magazine cover discs.
  174.  
  175. The "Show inside apps" options allow you to select when to display the files
  176. inside an application and when not to.  "if contains image" will display
  177. them if the application contains an image file, which is something like an
  178. archive or a hard disc partition.  "if contains dir structure" displays
  179. them if they include a directory structure at least two levels deep, whilst
  180. "if contains apps" will only show them if they include other applications.
  181.  
  182. You can also select what actions SELECT and ADJUST will have on the icon
  183. bar icon, and change some cosmetic features of !DiskInd - these are all
  184. self-explanatory.  Clicking on "OK" will set the configuration, "Save" will
  185. save it to disc, and "Cancel" will reset the configuration to how it was
  186. previously.
  187.  
  188.  
  189. CREDITS
  190.  
  191. !DiskInd uses the WimpExtension module - this was written by Jon Ribbens
  192. of DoggySoft and is truly an excellent programming aid for anyone who can
  193. program the WIMP already.  It makes everything easy - from putting the
  194. caret in an icon to displaying drawfiles.  And, to make it even better, you
  195. don't need the author's permission to incorporate it into other programs!
  196.  
  197. Thanks also to A.J. Cawte for writing such a brilliant tutorial on WIMP
  198. programming - it was originally published in the Virtuality magazine, but
  199. is now available for around £6 from several PD libraries.
  200.  
  201.  
  202. KNOWN BUGS
  203.  
  204. (i)   The "Kill WimpExtension when quit" option mysteriously seems not to
  205.       work...
  206.  
  207. (ii)  !DiskInd will not happily co-exist with !Glazier...
  208.  
  209.  
  210. PROGRAM HISTORY
  211.  
  212. Version  Date       Details
  213.  
  214. 1.00     29-Sep-94  First version
  215.  
  216. 1.01      8-Oct-94  Now displays files with zero length correctly, and 
  217.                     information cannot now disappear off the right of the
  218.                     text window.
  219.  
  220. 1.02     25-Nov-94  Cosmetic change - machine code section is now held in
  221.                     separate file, instead of being in the BASIC code.
  222.  
  223. 1.03      3-Jan-95  Two minor bug fixes
  224.  
  225. 1.04     10-Sep-95  Fixed bug that sometimes prevented progress window from
  226.                     appearing.  Also wrote freeware demo version.
  227.