home *** CD-ROM | disk | FTP | other *** search
/ Amiga Times / AmigaTimes.iso / programme / trionbbs110 / Trion / docs / Utils / bbstext.doc < prev    next >
Encoding:
Text File  |  1998-10-06  |  3.6 KB  |  119 lines
  1.  
  2.  
  3.    =====( BBStext V1.10 )=================================================
  4.  
  5.  
  6.         Trion BBStext Program.
  7.  
  8.         (c) Copyright Paul Spijkerman, '95-'98. All rights reserved.
  9.  
  10.         Written for use with the Trion BBS package.
  11.  
  12.  
  13.    ===================================================================
  14.  
  15.  
  16.    The BBStext program is needed to 'compile' bbstext binaries.
  17.  
  18.    With bbstext almost all the text lines displayed by a bbsnode
  19.    to users loged in is mend. These lines are configured in
  20.    BBStext text files. These have to be 'compiled' by the
  21.    bbstext program .. during compiling the lines are translated
  22.    and it checks if all lines are present and if no lines
  23.    it doesn't know are present .. then the lines are saved
  24.    to a binary the BBS node understand.
  25.  
  26.    For every language or menuset you have a seperate BBStext
  27.    file so you can easily add (and obtain) bbstext files
  28.    for different languages who are constructed by other people.
  29.  
  30.    The BBStext text files are found in the Trion:cfg/ directory
  31.    and are called BBStext-X.cfg where X is a number from
  32.    0 to 9 , so you can have 10 different BBStext sets.
  33.  
  34.    The compiled bbstext files are stored in the trion:data/
  35.    as bbstext-X.dat files.
  36.  
  37.  
  38.  
  39.  
  40.  
  41.    BBStext entries consists of lines needed by the compiler
  42.    to know which line we are defining folowed by the
  43.    actual text we want to use in the BBS.
  44.  
  45.    In the text lines you can use special characters to get
  46.    certain effects .. these characters are translated by
  47.    'BBStext' to the corresponding ascii codes, which make
  48.    bbstext files easier to read and change.
  49.  
  50.    Also a lot of lines have codes which can be used in these
  51.    lines and are replaced by the BBS at execution with 
  52.    numbers or text lines. These codes consist of a '%' character
  53.    folowed by a letter. (%a %b %c %d %e %f etc.)
  54.  
  55.    For those of you who can program in 'C' .. it works a little
  56.    bit like C but there are differences!
  57.    In C the letter stands for a certain type of variable .. but
  58.    in BBS a letter has a fixed meaning in every line and can
  59.    be of different types. There are no fixed types.
  60.    (note the types are in the comment lines in the BBStext-X.cfg)
  61.    In other software standard C types are used wich has a major
  62.    drawback .. that you have to use them in a fixed order,
  63.    wich isn't the case with trion.
  64.  
  65.    Note that a BBStext entry can be about 1000 characters each.
  66.  
  67.  
  68.  
  69.    Codes useable for translation to ASCII code:
  70.  
  71.  
  72.       '\a'   ->               Bell   (alert)
  73.  
  74.       '\b'   ->               Backspace          
  75.  
  76.       '\r'   ->               Carriage return    
  77.  
  78.       '\n'   ->               Newline            
  79.  
  80.       '\\'   ->  '\'          BackSlash          
  81.  
  82.       '_'    ->  ' '          space              
  83.  
  84.       ' '    ->  ' '          space              
  85.  
  86.       '|'    ->  ''           Carriage Return folowed by a newline  
  87.  
  88.  
  89.    NOTE: Underscores have the same effect a spaces !!
  90.          which can be convenient to 'see' the end of a line
  91.          also some editors strip the spaces from the end of a line
  92.  
  93.    Use '|' characters as 'return' characters (End Of Line)
  94.  
  95.  
  96.  
  97.  
  98.    Like in C you can add numbers (positive and negative) to
  99.    the '%' codes to fix the look of the text in the BBS:
  100.  
  101.  
  102.  
  103.       '%_'   ->  '_'          Underscore         
  104.  
  105.       '%|'   ->  '|'                             
  106.  
  107.       '%%'   ->  '%'                             
  108.  
  109.       '%A'   ->  'xxxxx'      Line 'A'           
  110.  
  111.       '%8A'  ->  '   xxxxx'   Line 'A' filled with spaces to fill 8 places  
  112.  
  113.       '%-8A' ->  'xxxxx   '   Line 'A' filled with spaces to fill 8 places  
  114.  
  115.  
  116.    Note that the 8 is an example and can be replaced by other numbers.
  117.  
  118.  
  119.