home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / CBMDevKit2.dms / CBMDevKit2.adf / DevTools / DevTools.lha / Devtools / DOCS / cards.doc < prev    next >
Encoding:
Text File  |  1993-05-13  |  3.8 KB  |  106 lines
  1. CARDS
  2.  
  3. Format:         CARDS <cardfile>
  4.  
  5. Template:    CARDS "CARDFILE/A"
  6.  
  7. Purpose:     To display the index cards in an ASCII card file.
  8.  
  9. FOUND WITH: development tools
  10.  
  11. Specification:
  12.  
  13. CARDS allows you to look at index cards stored in a specially formatted
  14. ASCII cardfile.  There is a cardfile called 68000.cards in the Other window.
  15. This file contains index cards describing the format, sizes and results of
  16. each 68000 machine language instruction.
  17.  
  18. To look at these cards, double-click on the 68000.cards icon.  You can also
  19. use the CD command to make the directory containing the cards the current
  20. directory (in this case, Software Toolkit's Other directory), then use the
  21. command "CARDS 68000.cards."
  22.  
  23. When the 68000.cards display appears, there is a highlighted index line at
  24. the bottom of the display:
  25.  
  26.         .0123456789.ABCDEFGHIJKLMNOPQRSTUVWXYZ.        <>
  27.  
  28. The periods ('.') in the index line represent ranges of special and
  29. punctuation ASCII characters.  To display the first card that starts with a
  30. letter or number, click on the appropriate letter/number in the index line.
  31. To move through the cards one by one, use the < (backward) and > (forward)
  32. gadgets on the right side of the index line.
  33.  
  34. Initially, the cards are sorted according to the category of the first line,
  35. in this case alphabetically.  However, you can sort the cards by any
  36. category by selecting the corresponding line description on the left side of
  37. the display. A '>' character marks the selected line by which the cards are
  38. sorted.  Generally, it is best to sort the 68000.cards cardfile on the
  39. first line which is the mnemonic name of each 68000 instruction.
  40.  
  41. You can also move through the cards by using the keyboard.  Hitting any
  42. alphanumeric key moves you to the first card starting with the letter or
  43. number. Other keyboard shortcuts are:
  44.  
  45.     < or ,    move backwards through the cards one at a time
  46.     > or .     move forward through the cards one at a time
  47.     Shift-U    move the sort line up
  48.     Shift-D    move the sort line down
  49.  
  50. To close the CARDS window and exit the program, hit Ctrl-C.
  51.  
  52.  
  53. CREATING ADDITIONAL CARD FILES
  54.  
  55. Additional card files can be created with any ASCII text editor.  The start
  56. of the card file must be a card template.  The rules for this template are
  57. explained below and are illustrated in the example.
  58.  
  59. Template Example
  60.  
  61.       1 --         @TEMPLATE
  62.     2 --         @N=50
  63.         3 --        @@@@@@@@@@|@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
  64.         4 --        ----------------------CLIENTS----------------------
  65.     5 --        Name
  66.             Company
  67.             Phone
  68.         6 --        @ENDTEMPLATE
  69.  
  70. 1.  The first line of the card file must start with the @TEMPLATE keyword.
  71.  
  72. 2.  The second line is the @N=MaxCards line.  This line specifies the
  73.     maximum number of cards allowed in the file.  It is optional, and if
  74.     not specified, Cards should size its allocations based on the number
  75.     of cards it detects in the file.  In the example above, 50 is the
  76.     maximum number of cards permitted.
  77.  
  78. 3.  The third line is a series of '@' symbols to specify the width of the
  79.     card. One @ symbol is equal to one character space in the card.  You
  80.     need to insert a vertical bar (|) to designate the break between the
  81.     line titles (on the left) and the individual card entries.
  82.  
  83. 4.  The fourth line contains the text for the card title line.
  84.  
  85. 5.  The next several lines specify the left-hand line titles.  (Remember,
  86.     the line titles cannot exceed the number of @ symbols before the
  87.     vertical bar in the third line.)
  88.  
  89. 6.  Finally, the template is concluded with the @ENDTEMPLATE keyword.
  90.  
  91. After the template is created, you can enter the text for each card.
  92. Simply, start each entry with a @ symbol on the first line.  (This should be
  93. the only entry on the first line.)  For example:
  94.  
  95.     @
  96.     Smith, P.J.
  97.     Hypertronics, Inc.
  98.     215-555-3434
  99.  
  100.     @
  101.     Jones, Mandy
  102.     Widgets, Ltd.
  103.     408-555-6767
  104.  
  105. You could continue on in this fashion with another 48 card entries.
  106.