home *** CD-ROM | disk | FTP | other *** search
/ Amiga Times / AmigaTimes.iso / programme / trionbbs110 / Trion / docs / 08_Tilde_codes.doc < prev    next >
Encoding:
Text File  |  1998-10-06  |  9.0 KB  |  269 lines
  1.  
  2.  
  3.  
  4.   Introduction
  5.   ------------
  6.  
  7.    This chapter describes the system of tilde codes that is used
  8.    in for instance ANSI BBS screens to display certain
  9.    proterties of users, or information on file or message sections
  10.    or just the time.
  11.  
  12.  
  13.   What are tilde codes
  14.   --------------------
  15.  
  16.    Tilde codes are the control codes used in the Trion BBS system
  17.    to display all kinds of information.
  18.    They can be used in ANSI screens that are part of menus, or
  19.    in other screens like the login and logout screens.
  20.    They can be used in logs with the LogMessage menu command.
  21.    They can be used in the BBStext files which configure most
  22.    of the text used in the BBS program.
  23.    They can be used in Door programs.
  24.  
  25.  
  26.   Simple examples
  27.   ---------------
  28.  
  29.    This line could display the current status in a file menu.
  30.    The tildecodes display: AreaNumber, AreaName, number
  31.    of marked files and the number of bytes in the marked files.
  32.  
  33.    Area:  (#~300)   ~301.   Marked: ~308 files ~309 bytes
  34.  
  35.    Which could give this result on a screen:
  36.  
  37.    Area:  (#1)   Upload.    Marked: 1 files 43552 bytes
  38.  
  39.  
  40.  
  41.    This line could display the current status in a mail menu.
  42.    The tildecodes display: AreaNumber, AreaName, Type of Area,
  43.    lastread message and the range of messages in this section.
  44.  
  45.    Area: (#~100)  ~101  (~106)  lastread: ~102   ~103/~104
  46.  
  47.    Which could give this result on a screen:
  48.  
  49.    Area: (#1)  [loc] Sysop Comments  (Local)  lastread: 1178   [1059/1178]
  50.  
  51.  
  52.  
  53.   menu prompts
  54.   ------------
  55.  
  56.    You can use tilde codes in the prompt of menus.
  57.    For instance the number of minutes left online:
  58.  
  59.    "~213 > "
  60.  
  61.    Or use the time in a prompt.
  62.  
  63.    "~252 : "
  64.  
  65.    A more usefull option in a mail menu could be the current
  66.    message section name followed with the range of messages
  67.    in a section.
  68.  
  69.    "~101 [~103/~104] : "
  70.  
  71.    In a file menu a prompt with the name of the current section
  72.    could be usefull.
  73.  
  74.    "~301 > "
  75.  
  76.  
  77.   formatting codes
  78.   ----------------
  79.  
  80.    Tilde codes consist of a '~' followed by 1 to 3 digits and in some
  81.    cases some additional data.
  82.    Tilde codes can be used to show all kinds of information in BBS
  83.    screens, in the BBStext lines, menu commands, log commands etc..
  84.  
  85.    To make things clear the following text is used in the examples.
  86.  
  87.     nnn = tilde code number
  88.     xxx = area number
  89.     SSS = string of characters
  90.  
  91.  
  92.    A normal tilde code would like this:
  93.    Where nnn is the tilde code.
  94.  
  95.    ~nnn
  96.  
  97.    For example ~200 to display the name of the user online.
  98.  
  99.  
  100.    Also there are tilde codes which displays an atribute of a mail
  101.    or file section. These look like this:
  102.    Where xxx is the area number.
  103.    And where nnn is tilde code 2 or 3.
  104.  
  105.    ~nnn:xxx~
  106.  
  107.    For example ~2:100~ displays a '*' if there are new messages
  108.    in a message section and a ' ' if there are now new messages.
  109.    For example ~3:100~ will display the number of new messages
  110.    in a message section.
  111.  
  112.  
  113.    There are tilde codes which change a certain string displayed
  114.    with other tilde codes.
  115.    Where SSS is the text string.
  116.    And where nnn is tilde code 20 or 21.
  117.  
  118.    ~nnn:SSS~
  119.  
  120.    For example ~20:!~ will change the default string that means
  121.    there a new messages in a message section from '*' to '!'.
  122.    Note that is doesn't display anything. Tildecodes
  123.    20 and 21 display these strings.
  124.  
  125.  
  126.    There are also tilde codes which do the same as the above
  127.    mentioned 2 tilde codes.
  128.    You give it a area number and a string and it will display
  129.    the string if an attribute of the section is true or false.
  130.    It is a little simpler to understand as the above two, but
  131.    makes longer text files and is more work to change.
  132.    Where SSS is the text string.
  133.    Where xxx is the area number.
  134.    And where nnn is tilde code 0 or 1.
  135.  
  136.    ~nnn:xxxSSS~
  137.  
  138.    For example ~0:100New~ will display "New" on the screen if
  139.    there are new messages in section 100.
  140.  
  141.    For example ~1:100---~ will display "---" on the screen if
  142.    there are no new messages in section 100.
  143.  
  144.  
  145.  
  146.   List of all current tilde codes
  147.   -------------------------------
  148.  
  149.    xxx = area number
  150.    SSS = string of characters
  151.  
  152.  
  153.       Code:        Default: Meaning:
  154.    ======================================================================
  155.  
  156.       ~0:xxxSSS~            Print 'SSS' if New Messages in area xxx.
  157.       ~1:xxxSSS~            Print 'SSS' if NO new Messages in area xxx.
  158.  
  159.       ~20:SSS~    ~20:*~    Use 'SSS' as macro for New Messages.
  160.       ~21:SSS~    ~21: ~    Use 'SSS' as macro for NO New Messages.
  161.  
  162.       ~2:xxx~               Prints one of the above mentioned macros
  163.                             for area xxx.
  164.  
  165.       ~3:xxx~               The number of new messages in area xxx.
  166.                             Only prints if number greater than zero.
  167.                             Occupies 3 characters on the screen.
  168.  
  169.  ???  ~10                   'more' , asks for a 'return' to continue.
  170.  
  171.       ~11                   Causes a 1 second delay after the return.
  172.  
  173.  
  174.       ~50                   The number of this node.
  175.       ~51                   The number of the user logged in.
  176.  
  177.       ~60                   Sysop available/Sysop not available
  178.  
  179.       ~100                  Current Message Area Number.
  180.       ~101                  Current Message Area name.
  181.       ~102                  Number of last read message.
  182.       ~103                  Number of the first message in this area.
  183.       ~104                  Number of the last message in this area.
  184.       ~105                  Number of new messages in the current area.
  185.       ~106                  Type of msg area (Local, Echomail, Netmail)
  186.  
  187.       ~110                  Maximum Msgs per day.
  188.       ~111                  Number of messages the user wrote today.
  189.       ~112                  Total number of messages this user wrote.
  190.  
  191.       ~120                  Number of marked messages.
  192.  
  193.       ~200                  Name of the User online.
  194.       ~201                  Level of the User online.
  195.       ~202                  City of the User online.
  196.       ~203                  Alias of the User online.
  197.       ~204                  Password of the User online.
  198.       ~205                  Voice Phone Number of the User online.
  199.       ~206                  Data  Phone Number of the User online.
  200.       ~207                  Status (level name) of the User online.
  201.  
  202.       ~210                  Number of calls by this user.
  203.       ~211                  Date User 'First on System'.
  204.       ~212                  Date User 'Last on System'.
  205.       ~213                  Number of minutes this user has left.
  206.       ~214                  Screen length of this user.
  207.       ~215                  Number of minutes this user is online.
  208.       ~216                  Number of minutes this user has per day.
  209.       ~217                  Number of minutes this user has per call.
  210.       ~218                  Number of days since first log on of this user
  211.       ~219                  Number of days since last log on of this user
  212.       ~220                  Number of calls today by this user.
  213.  
  214.  
  215.       ~250                  Time + date.
  216.       ~251                  Date.
  217.       ~252                  Time.
  218.  
  219.       ~300                  Current File Area number.
  220.       ~301                  Current File Area name.
  221.  
  222.       ~305                  File Transfer Protocol
  223.       ~306                  Message Editor (num)
  224.  
  225.       ~308                  Number of Marked Files.
  226.       ~309                  Number of Marked Bytes.
  227.  
  228.       ~310                  FileRatio.
  229.       ~311                  ByteRatio.
  230.       ~312                  Maximum bytes per day.
  231.  
  232.       ~320                  number of Downloaded files by this user.
  233.       ~321                  number of Uploaded files by this user.
  234.       ~322                  DownloadedBytes by this user.
  235.       ~323                  UploadedBytes by this user.
  236.       ~324                  Files downloaded today by this user.
  237.       ~325                  Bytes downloaded today by this user.
  238.  
  239.       ~326                  Files downloaded with effect on ratio
  240.       ~327                  Bytes downloaded with effect on ratio
  241.  
  242.  
  243.       ~330                  Files still available today.
  244.       ~331                  Bytes still available today.
  245.       ~332                  Bytes available by ratio.
  246.  
  247.       ~334                  Files available on ratio
  248.       ~335                  Bytes available on ratio
  249.  
  250.       ~340                  Files available outside ratio (free files).
  251.       ~341                  Bytes available outside ratio (free bytes).
  252.  
  253.       ~350                  File Group number
  254.       ~351                  File Group name
  255.       ~352                  Messages Group number
  256.       ~353                  Messages Group name
  257.  
  258.  
  259.       ~400 - ~449           Reserved for stats (now also still 240 - 245)
  260.  
  261.  
  262.       ~400                  Total number of calls to the system . Max 4 Miljard.
  263.       ~401                  Total number of messages on the system.
  264.       ~402                  Total number of files on the system.
  265.       ~403                  Number of users on the system.
  266.       ~404                  Number of callers today.
  267.       ~405                  Number of callers yesterday.
  268.  
  269.