home *** CD-ROM | disk | FTP | other *** search
/ Jason Aller Floppy Collection / 83.img / SRCER486.ZIP / TESTYN.REM < prev   
Text File  |  1989-10-30  |  5KB  |  118 lines
  1.  
  2.  
  3.                    ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  4.                       SOURCER REMARKS FILE - SAMPLE REMARKS
  5.                    ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
  6.  
  7.  
  8.  ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ DATA REMARKS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  9.  
  10.         Remarks in this section are linked to the .def  file,  section  3
  11.         relating to data items.    Remarks  will  appear  in  the  source
  12.         code output to the right of the data reference  defintion.   Each
  13.         remark can encompass as many lines as needed, up to 34 characters
  14.         per line.  Each line starts with the 3 digit hex reference number
  15.         starting at 001 to a maximum of 3FFh (1023 entries).   The number
  16.         is also entered in the .def file for the particular data item(s).
  17.  
  18.  
  19.     --------- Data Remarks -----------  -------- comments ignored here --------
  20. 001 This is the remark number 1 
  21. 002 This is another remark
  22. 003 This is the next data remark
  23.      note how it continues onto three
  24.      lines ! (indents allowed)
  25. 004 █▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀█
  26.     █ Lines starting with a graphics █
  27.     █ character will be placed prior █
  28.     █ to the line that the data item █
  29.     █ comment appears on.            █
  30.     █                                █
  31.     █ A line feed will automatically █
  32.     █ be place prior  to  and  after █
  33.     █ the grahics character area.    █
  34.     █▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄█
  35.     this line is left of data item 4
  36. 005 This is the last data comment !
  37. 006 █▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀█          Highlight information prior
  38.     █ Values  For  Beeper  Operation █          to a data item with graphics
  39.     █▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄█          characters !
  40.     Port to toggle speaker on & off
  41. 007 total number of cycles                      (on_off_time)
  42. 008 duration for each cycle on or off
  43. end
  44.  
  45.  
  46.  ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ LOCATION REMARKS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  47.  
  48.         Remarks in this section are linked to the .def  file,  section  4
  49.         relating to location references.   Remarks  will  appear  in  the 
  50.         source code output as lines prior to  the  location  item.   Each
  51.         remark can encompass as many lines as needed, up to 76 characters
  52.         per line.  Each line starts with the 2 digit hex reference number
  53.         starting at 01 up to a maximum of FEh (254 entries).   The number
  54.         is entered in the .def file for the particular location item(s).
  55.  
  56.         relating to location references.   Remarks  will  appear  in  the 
  57.         source code output as lines prior to  the  location  item.   Each
  58.         remark can encompass as many lines as needed, up to 76 characters
  59.         per line.  Each line starts with the 2 digit hex reference number
  60.         starting at 01 up to a maximum of FEh (254 entries).   The number
  61.         is entered in the .def file for the particular location item(s).
  62.  
  63.  
  64.     ----------------------- Location Reference Remarks ------------------------
  65. 01  This is a location reference remark
  66.  
  67. 02  ═════════════════════════════════════════════╡ GRAPHICS ╞═════════════
  68.  
  69.       ■  All graphics characters are allowed for special highlighing
  70.  
  71.       ■  Line feeds can be inserted for extra clarity
  72.  
  73. 03  Text of each remark begins at column 5 in this file
  74.  
  75. 04  ───── TESTYN OPERATION ───────────────────────────────────────────────
  76.      
  77.     Testyn waits for a keystroke "n" or "y", or beeps if any other key has
  78.     been entered.    When "n" or "y" is entered,  the program exits with a
  79.     return code 0 for "n", and 1 for "y".
  80.     
  81.     It is intended to be used in a batch file when a  yes/no  question  is
  82.     asked, the errorlevel command can be used to read the return code.
  83.  
  84. 05
  85.     Line feeds can be placed at the begining for more seperation from  the
  86.         previous section of code (1 line feed is automatically placed 
  87.         prior to the remark).  No linefeeds are placed after the remark 
  88.         unless explictly done as in these examples.
  89.  
  90. end
  91.    
  92.  ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ SUBROUTINE REMARKS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  93.  
  94.         Remarks in this section are linked to the .def  file,  section  5
  95.         relating to subroutine references.   Remarks will appear  in  the 
  96.         source code output as lines prior to the subroutine  item.   Each
  97.         remark can encompass as many lines as needed, up to 76 characters
  98.         per line.  Each line starts with the 2 digit hex reference number
  99.         starting at 01 up to a maximum of FFh (255 entries).   The number
  100.         is entered in the .def file for a particular subroutine item(s).
  101.  
  102.  
  103.     ---------------------- Subroutine Reference Remarks -----------------------
  104. 01  This is a subroutine reference remark
  105. 02                               BEEPER SUBROUTINE
  106.          
  107.         This subroutine generates a short beep.   Note that the sound and
  108.         duration are uP speed dependent.
  109.            
  110.         Regsisters used:   al,bx,cx,dx,ds
  111. end 
  112.  
  113.  
  114.         NOTES:  1)  Entries must be in consecutive sequential order.
  115.                 2)  Remark characters ";" are automatically inserted.
  116.                 3)  Up to 64,000 lines per remark, 32M max file size.
  117.  
  118.