home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / oct93 / comm / 4d-bbsdemo.lha / 4D-BBSDemo / Docs / A6.EIC < prev    next >
Text File  |  1993-07-02  |  8KB  |  244 lines
  1. Appendix 6:
  2.  
  3.  
  4.                     Embedded Instructional Codes (EIC)
  5.  
  6.  
  7. Explanation of EICs
  8.  
  9.      4D-BBS allows the use of special control codes that can be placed
  10. in any text files displayed by the BBS.  These codes cause the BBS 
  11. to perform certain functions or print specific information to the user.
  12. A good example of EICs is the "stats.txt.ascii" file in the TEXT:
  13. directory. 
  14.  
  15.      If you load this file into a text editor you will see several of
  16. these embedded codes (which start with the control-right bracket
  17. character "^]").  If you view this same file from 4D-BBS, you will not
  18. see those codes.  Instead you will see what information 4D-BBS
  19. replaces these codes with.  Most EICs are specific to the user's
  20. information who is logged onto the BBS.  Other EICs display system
  21. information, while another can execute any menu function.
  22.  
  23.      Below is a list of some EIC's and what they do. A complete list
  24. of EIC's is provided at the end of this appendix.
  25.  
  26.     ^]P0%      current time and date
  27.     ^]P1%      current time
  28.     ^]P2%      last call date of online user
  29.     ^]P3%      name of online user
  30.     ^]P4%      phone number of online user
  31.     ^]C#%      show last caller number # 1 to 5
  32.     ^]SS%      send current sub-board name
  33.     ^]SN%      send current sub-board number
  34.     ^]SD%      send current file-sub number
  35.     ^]SE%      send current file-sub name
  36.  
  37.      The symbol "^]" above represents a "CONTROL ]" keypress, then the
  38. EIC specifier.  A "%" must always end the EIC; this tells 4D-BBS the
  39. EIC sequence is done.
  40.  
  41.      You can enter those EIC's via your text editor or via the built
  42. in message editor.  But please note that for security's sake, you
  43. can not enter them in a message for a message base or email (someone
  44. couldn't easily use the execute menu function EIC to run the user
  45. editor, for example).
  46.  
  47.  
  48.  
  49. Special EICs
  50.  
  51.      Besides EIC's that prints out information about the current user
  52. or the system, there are a few EIC's that do useful things.  Following
  53. is an explanation and example of many of these.
  54.  
  55. The Wait EIC
  56.  
  57.      The EIC "^]Y%" makes the system pause and wait for the user to
  58. hit any key. It DOES NOT provide any text asking the user to hit any
  59. key to continue.  This should be done in the text file before the EIC
  60. is encountered.  Below is an example of this EIC.
  61.  
  62.     Hit any key to go on...^]Y%
  63.  
  64.  
  65. The Last Quote EICs 
  66.  
  67.      The EIC "^]F3%" asks the current caller if they would like to
  68. enter a quote to be displayed to the next caller.  If the user chooses
  69. yes, they can enter a one line message.  The EIC, "^]F2%" displays
  70. this message.  Normally the EIC asking the quote is part of the
  71. logoff.txt file, and the EIC displaying the message is part of the
  72. stats.txt file.  However two menus commands using the :e could be used
  73. to set and display the quote.
  74.  
  75. The Display a Text File EIC
  76.  
  77.      Another useful EIC is the "^]F1filename%" EIC which sends a text
  78. file.  This can be done from any text string, including inside of
  79. another text file.  But be careful not to nest this too many times or
  80. you could cause erratic system results.
  81.  
  82. The Menu Function EIC
  83.  
  84.      One EIC that might seem a little unuseful at first, is the menu
  85. function EIC, "^]Mmenu command%".  This EIC lets you execute any
  86. menu function available in 4D-BBS (except the 0 and 1 functions). For
  87. example, "^]Mm s sysop%" will force a user to send mail to the SysOp
  88. in the middle of displaying a text file.
  89.  
  90. The Random EIC
  91.  
  92.      The most colorful EIC is the random EIC, "^]R...%", which picks
  93. a message at random from a file and displays it.  This is great for
  94. displaying fortune cookie quotes and such.  For example, the EIC
  95. "^]Rtext:cookie.dat%" will select a line from the file
  96. "text:cookie.dat" and display it.  But the file "cookie.dat" (or any
  97. file that is to be used by the random EIC) must follow the format
  98. depicted below:
  99.  
  100.     3                               /* How many messages? */
  101.     @Don't worry, be happy.         /* First message */
  102.     @Be happy but worry a bit.      /* Second message */
  103.     @Forget all about happiness!    /* Third message */
  104.  
  105.  
  106.      The format is rather simple. The first line should have a number
  107. indicating how many messages this file has.  All the lines after that
  108. are the messages.  Each message should start with an "@". A message
  109. can be a single line or it can have many lines.  The way to do a
  110. multi-line message is shown below.
  111.  
  112.      2
  113.     @Roses are red,
  114.     Violets are blue,
  115.     Am I thinking of you?
  116.     @Roses are blue,
  117.     Violets are red,
  118.     And I think I'm color blind.
  119.  
  120.  
  121.  
  122. Complete List of EICs
  123.  
  124.      Below is a complete list of EICs and their descriptions useable
  125. withing 4D-BBS.
  126.  
  127.  
  128. EIC        Description
  129. ------     ---------------------------------------------------------
  130.  
  131. ^]B#%      Sends a beep (# = 1 to 9)
  132.  
  133. ^]P0%      Current date AND time
  134. ^]P1%      Current time
  135.  
  136. ^]P2%      Last call date of online user
  137. ^]P3%      Name of online user
  138.  
  139. ^]P4%      Phone number of online user
  140. ^]P5%      Real name of user (if alias is used)
  141.  
  142. ^]P6%      Total number of calls made to the system
  143. ^]P7%      How much time left
  144.  
  145. ^]P8%      How long the user has been on system
  146. ^]P9%      City and state of online user
  147.  
  148. ^]PA%      Downloads by online user
  149. ^]PB%      Uploads by online user
  150.  
  151. ^]PC%      Messages posted by online user
  152. ^]PD%      Calls made by online user
  153.  
  154. ^]PE%      Timelimit on mintues of online user
  155. ^]PF%      Status (NEW,MEMBER,SYSOP,CUSTOM) of online user
  156.  
  157. ^]PG%      Computer type of online user
  158. ^]PH%      Password of online user
  159.  
  160. ^]PI%      Rows displayable by online user
  161. ^]PJ%      Expert mode (ON,OFF) of online user
  162.  
  163. ^]PK%      How many calls did the user make today
  164. ^]PL%      How many calls in a day the user is allowed to make
  165.  
  166. ^]PM%      ASCII mode (ON, OFF)
  167. ^]PN%      User's real name
  168.  
  169. ^]PO%      User's gender (MALE, FEMALE)
  170. ^]PP%      User's interests
  171.  
  172. ^]PQ%      User's age
  173. ^]PR%      Is this user's data private? (PUBLIC, PRIVATE)
  174.  
  175. ^]F2%      Send the last words of the previous caller
  176. ^]F3%      Make new last words
  177.  
  178. ^]F4%      Sysop available? (AVAILABLE,NOT AVAILABLE)
  179. ^]F5%      No pausing allowed while text is being displayed
  180.  
  181. ^]F6%      Pausing allowed now
  182. ^]F7%      No aborting allowed while text is being displayed
  183.  
  184. ^]F8%      Aborting allowed now
  185. ^]C#%      Show last caller number # 1 to 30
  186.  
  187. ^]SS%      Send current sub-board name
  188. ^]SN%      Send current sub-board number
  189.  
  190. ^]SD%      Send current file sub-category number
  191. ^]SE%      Send current file sub-category name
  192.  
  193. ^]SR%      Prints a CR
  194. ^]SM%      How many pieces of mail for current user
  195.  
  196. ^]SU%      How many new users on system
  197. ^]S1%      Baud rate description
  198.  
  199. ^]S2%      Serial baud rate
  200. ^]S3%      Carrier baud rate (if different from serial)
  201.  
  202. ^]WC%      How many calls made to this system
  203. ^]WU%      How many users on this system
  204.  
  205. ^]WF%      How many files on this system
  206. ^]WD%      How many downloads made on this system
  207.  
  208. ^]WM%      How many messages posted on this system
  209. ^]WS%      Who is this bbs's sysop
  210.  
  211. ^]WR%      Registration number
  212. ^]NF%      Full FIDO Address
  213.  
  214. ^]NZ%      FIDO zone
  215. ^]NA%      FIDO area        
  216.  
  217. ^]NN%      FIDO node
  218. ^]NP%      FIDO point
  219.  
  220.  
  221. SPECIAL EIC's
  222.  
  223. ^]TM%      Check for the user's E-mail (Good to have this in a bulletin)
  224. ^]TP%      Check all mail to the user
  225.  
  226. ^]WN%      How many new files uploaded to system since sysop's last login 
  227.  
  228.        (Mostly for waiting screen, reset to 0 after sysop's auto-login.)
  229.  
  230. ^]Rname%   Prints a randomly-chosen message from the named file. (See the 
  231.        section 7.Color&CMDS on how to prepare a file for this EIC.)
  232.  
  233. ^]MComm% - Executes a menu function. (Example: ^]MM S Sysop% which
  234.            would send mail to the sysop of the system.) All menu functions 
  235.        (except 0 and 1 functions) will work here.
  236.  
  237. ^]F1name%  Send file named 'name' and continue with current file later
  238.            (ex: ^]F1text:junk.txt%)
  239.  
  240. ^]Y%       Wait for user to press a key, no text show (you provide)
  241.  
  242. ^]V%       Sends the current version of 4d-bbs
  243.  
  244.