home *** CD-ROM | disk | FTP | other *** search
/ ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng) / ProfitPress-MegaCDROM2.B6I / BBS / MISC / TPB71NED.ZIP / NED.DOC next >
Encoding:
Text File  |  1991-12-06  |  12.4 KB  |  339 lines

  1.  
  2.  
  3. NED, the Newin file editor for TPBoard v7.0, v1.1
  4.  
  5. by: Plain Jayne Software
  6.     November, 1991
  7.     All Rights Reserved
  8.  
  9.  
  10. How NED works
  11. -------------
  12.  
  13. Ned is a full-screen, browsing file editor for the Newin
  14. file.  Ned is easy to navigate, simply execute NED from
  15. the DOS prompt and you will see the records of your NEWIN
  16. file listed, one record per line.  The initial listing is
  17. in the alphabetical order of the filenames.  Try pressing
  18. Alt-K (for KEY); the listing will change to an alphabetized
  19. listing by file area.  The Alt-K command works as a toggle
  20. between the two available keys in the Newin file.
  21.  
  22. The down-arrow key will scroll through the file to the next
  23. record.  The up-arrow will scroll one record up.  The other
  24. directional keys work similarly:  PgDn, PgUp, Home, and End.
  25. In addition, the right and left arrow keys will scroll the
  26. display horizonally.  Try it and you will find that there is
  27. much information off the screen to the right.
  28.  
  29. You can see that NED navigates pretty much as you'd expect.
  30.  
  31.  
  32. Display formats
  33. ---------------
  34.  
  35. NED offers 5 different display format.  A display format is
  36. the information that displays on a given line for a given
  37. record.  Display format #1 is the default and displays:
  38.  
  39. Format #1
  40.  
  41.   1) filename   2) area name  3) uploader's name
  42.   4) upload date  5) description
  43.  
  44. Using the Alt-1..Alt-5 keys, you can toggle between the 
  45. five formats.  These are:
  46.  
  47. Format #2
  48.  
  49.   1) filename   2) area name  3) uploader  4) description
  50.  
  51. Format #3
  52.  
  53.   1) filename   2) area name  3) description
  54.  
  55. Format #4
  56.  
  57.   1) filename   2) description
  58.  
  59. Format #4
  60.  
  61.   1) description
  62.  
  63.  
  64. Alt-K Keys
  65. ----------
  66.  
  67. As mentioned above, the Alt-K command toggle between the
  68. two available keys into the Newin database file.  When you
  69. press Alt-K, the key will change with the value being 
  70. sought for that key being the currently highlighted record.
  71. For example, if you are keyed in filename order and the
  72. file highlighted is TEST.PAK in the GRAPHICS area and you
  73. press Alt-K, NED will change to the area key with the first
  74. record being the first entry for the GRAPHICS file area.
  75.  
  76.  
  77. File searching
  78. --------------
  79.  
  80. You can search for a particular value in the Newin file (a
  81. filename for file area) with the Alt-S command.  You will
  82. be asked for the phrase to search for according to the
  83. currently selected key order.  If you enter 'F' and press
  84. [ENTER], you will find either the first filename or file
  85. area that begins with an 'F'.  If no match is found, you'll
  86. see the next closest record.
  87.  
  88.  
  89. Picking matching records by template
  90. ------------------------------------
  91.  
  92. Matching works something like searching except that you
  93. specify in more detail exactly  which records you wish to
  94. see by editing a dummy newin record (a template) and asking
  95. for all matching records.  Once you have edited this template
  96. record, you would instruct NED to pick all records that match
  97. that template and Filter on the picked status of the records.
  98. In other words, NED would display ONLY those records that
  99. match the template (are picked).
  100.  
  101. Example:  you want to edit only those records that have
  102. NO file descriptions on record.  You could edit the template
  103. and search for all Newin records with the phrase "not 
  104. available" ANYWHERE in the description.  If any where found,
  105. NED would display only those records on the screen.  Once you
  106. have selected to turn Filtering on, Alt-F will turn filtering
  107. off.
  108.  
  109. The scenario would be:  
  110.  
  111.    Alt-T   Select or edit a template record
  112.    Alt-P   Pick all records that match template
  113.    Alt-P   Filter by picked records
  114.  
  115. When matching, ned considers ANY field that isn't blank as
  116. a command to process when looking for a match to that 
  117. template.  Ned recognizes the following commands:
  118.  
  119.  1) if you enter a phrase in a template field with no
  120.     NED command letters, a match is any record that has
  121.     the exact same data in the exact same field.  If you
  122.     enter 'TEST.ARC' in the filename field, a match must
  123.     be named 'TEST.ARC'. 
  124.  
  125.  2) if you enter a phrase in a template field with a '@'
  126.     character in the first space, that field is considered
  127.     a NED command, and a match is determined by the second
  128.     character.  
  129.  
  130.     a) ^ in the second space means to search for and consider
  131.        as a match any record that contains the following
  132.        phrase ANYWHERE in the same field.  If your command is
  133.        @^TEST in the filename field, any Newin record with
  134.        'TEST' anywhere in the filename would be considered a
  135.        match.
  136.  
  137.     b) > in the second space means to search for and consider
  138.        as a match any record that is greater than the
  139.        following phrase in the same field.  If your command is
  140.        @>TEST in the filename field, any Newin record with
  141.        a filename greater than the entered phrase would be
  142.        considered a match.
  143.  
  144.     c) < in the second space means to search for and consider
  145.        as a match any record that is less than the following 
  146.        phrase in the same field.  If your command is
  147.        @<TEST in the filename field, any Newin record with
  148.        a filename less than the entered phrase would be
  149.        considered a match.
  150.  
  151.     d) a ' character (a single quote) considers a match any
  152.        record which has a blank field.  If you entered
  153.        @' as a command in the description field, all records
  154.        that match would have blank description fields.
  155.  
  156.     e) a ~ character (a tilde) considers a match any record
  157.        which is not an EXACT match.  For example, if you
  158.        wanted to display all files NOT uploaded from the sysop,
  159.        your'd enter  @~SYSOP as a command in the uploader
  160.        field.
  161.  
  162. Notes on searching and ascii matching.  When comparing two
  163. string phrases, strings are converted to upper case letters
  164. before comparing.  This means that 'asp' is the same as
  165. 'ASP.'  Also, to compare dates correctly, the dates must be
  166. compared in reverse order:  year first.  NED reverses the dates
  167. or records in reading them in; however, your template record
  168. must already be in YY-MM-DD format.
  169.  
  170. Example with dates:   the command @>91-09-00 would match any
  171. records with a filedate GREATER than Sep 00, 1991.  
  172.  
  173.  
  174. Picking
  175. -------
  176.  
  177. A record is picked if there is an asterisk in the first display
  178. column.  Some programs also call "picking" tagging or marking;
  179. the concept is still the same.  The purpose in picking records
  180. is multifold.
  181.  
  182. For one, you can use the pick status of records as a filter.
  183. Suppose you wanted to only view records that had a last download
  184. date of @<91-01-01 (records not downloaded since Jan 1, 1991).
  185. Fill out the current template with the appropriate command, select
  186. to pick all matching records, and then select to Filter on the 
  187. picked status.
  188.  
  189. Second, you can peform functions to picked records.  For example,
  190. you can force the value of the template onto all picked records.
  191.  
  192. And you can use picking to refine the filter.  For example, having
  193. picked all records that haven't been downloaded since 01/01/91,
  194. you now want to keep those you've picked and exclude any with
  195. total downloads greater than 20.  Edit a template to pick records
  196. with LESS THAN 20 downloads.  Now, UnPIck all matching records.
  197.  
  198. You can break the picking process at any time by pressing the
  199. ESC key.
  200.  
  201.  
  202. Forcing
  203. =======
  204.  
  205. If you don't understand template command terminology, you won't
  206. understand forcing.  When forcing, a template record is processed
  207. as a series of commands (just like matching a record to a 
  208. template) except that forcing intends to alter the contents of
  209. a record.  A command in a template field during a force operation
  210. tells NED to change the record's value of that field in some way.
  211.  
  212. For example, if the filename field were the only template field
  213. that contained a command and the command string was  @^.PAK^.ZIP;
  214. Ned would substitutue ".ZIP" in every instance of ".PAK" in all
  215. records chosen for the force operation (either ALL records or
  216. all picked records).
  217.  
  218. Or, if you wanted to substitute the description line:
  219. "Description not available" with "Sorry, Lazy sysop hasnt entered
  220. one yet."  you could:
  221.  
  222.    a)  pick all records with the command "@^ion not available" in
  223.        the description field.
  224.    b)  process a Force on all picked records with the command
  225.        "Sorry, Lazy sysop hasnt entered one yet."
  226.  
  227. Remember, when forcing, you don't want ANYTHING in a template
  228. field unless you want to alter the contents of the field during
  229. the force!
  230.  
  231. Ned recognizes the following commands during a force operation:
  232.  
  233.  1) if you enter a phrase in a template field with no
  234.     NED command letters, the contents of that field are
  235.     forced verbatim on the record field.
  236.  
  237.  2) if you enter a phrase in a template field with a '@'
  238.     character in the first space, that field is considered
  239.     a NED command, and the command to process is determined 
  240.     by the second character.  
  241.  
  242.     a) ^phrase1^phrase2  means to swap any FOUND occurrence
  243.        of phrase1 in that field with phrase2.  For example,
  244.        the earlier example to swap the filename extensions
  245.        using the command string:  @^.PAK^.ZIP;  A trick to
  246.        delete all occurrences of a field is to specify a
  247.        phrase1 with a blank phrase2:  @^SHIT^ would effectively
  248.        remove the phrase "SHIT" from that field.
  249.  
  250.     b) > in the second space means to Append the contents of
  251.        the template field TO the existing value of the field.  
  252.        The command "@>Not OnLIne" in the desciption field
  253.        would append the phrase "Not Online" to all records
  254.        processed.  If the new field is too long, it will be
  255.        chopped off.
  256.  
  257.  
  258.     c) > in the second space means to Append the contents of
  259.        the record's field TO the value of the template field.  
  260.        The command "@<Not OnLIne: " in the desciption field
  261.        would append the original description to the phrase
  262.        "Not Online:  " to all records processed.  If the new 
  263.        field is too long, it will be chopped off.
  264.  
  265.  
  266.     d) a ' character (a single quote) deletes the contents of
  267.        that field.  You could use this to delete all 
  268.        descriptions.
  269.  
  270.     e) the math symbols '+', '-', '*', and '/' instruct NED
  271.        to perform a math operation on the field.  For example,
  272.        you could pad the number of times downloaded with the
  273.        command:  @+20   This command would add 20 to the number
  274.        of times downloaded for all records processed.  The
  275.        other math commands are:
  276.  
  277.          @-XX  to subtract XX from the original value
  278.          @*XX  to multiply the original value by XX
  279.          @/XX  to divide the original value by XX
  280.  
  281. That's it.  Forcing is simple yet a very powerful tool when
  282. properly applied.
  283.  
  284. You can break the forcing process at any time by pressing the
  285. ESC key.
  286.  
  287.  
  288. Editing
  289. -------
  290.  
  291. To edit a record, press ENTER with the desired record highlighted.
  292. To save a record you've edited, press PgDn or PgUp.  Pressing ESC
  293. during editing aborts the changes to THAT record; records already
  294. saved with the PgUp or PgDn keys are still saved.  
  295.  
  296. Deleting records
  297. ----------------
  298.  
  299. You can delete the currently highlighted record by pressing [DEL].
  300. You will be asked if you really want to delete before NED procceds
  301. with the process.  You can also delete ALL picked records by pressing
  302. Alt-D.  This brings up a menu that allows you to delete ALL picked
  303. records OR to Undelete any deleted records in the Newin database
  304. file.
  305.  
  306. Deleting all picks is a dangerous operation -- make very sure that
  307. only records you really want to delete are picked before you delete
  308. all picks!  
  309.  
  310. ANY deleted records can be recovered using UNDelete before the next
  311. TPBoard purge cycle has run.
  312.  
  313.  
  314. Commandline Arguments
  315. ---------------------
  316.  
  317. NED accepts the following command line arguments.
  318.  
  319.  /M  to force mono mode (non-color mode)
  320.  
  321.  /V  to select VGA/EGA mode (50/43 line modes)
  322.  
  323.  NODE ##  to envoke network record locking.  the ##
  324.           is the workstation number.
  325.  
  326.  
  327.  --- THE END -----
  328.  
  329.  
  330.  1.1  o  added full mouse support in the main screen
  331.       o  fixed template matching when more than one field is specified
  332.       o  added record deleting
  333.       o  added crt restore after running NED with /V
  334.  1.2  o  removed the concept of a template filter.  Pick matches and
  335.          filter on the picked status.  Filtering alone was far too
  336.          slow a process
  337.       o  added a check for calling a filter when nothing to filter
  338.          (pick filter when no picks)
  339.