home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / SBBS1B00.ZIP / DOCS.EXE / DOCS / SIF.DOC < prev    next >
Text File  |  1992-07-17  |  4KB  |  98 lines
  1. Synchronet Interface File (SIF) Format Copyright 1992 Digital Dynamics 
  2.  
  3. format:
  4.  
  5. <STX>text<ETX>mode[mod][l][r][x][.n]["str"]
  6.  
  7. element descriptions:
  8.  
  9. STX     is the ASCII code for start of text (ASCII 2 / Ctrl-B)
  10. ETX     is the ASCII code for end of text   (ASCII 3 / Ctrl-C)
  11.  
  12. text    is any number of ASCII characters - Synchronet Ctrl-A codes supported
  13.  
  14. mode    text input mode desired for this field. Possible mode values are:
  15.                 c       single character
  16.                 s       string of characters
  17.  
  18. mod     optional mode modifier. Possible mode modifiers are:
  19.                 n       numeric characters only
  20.                 u       input converted to uppercase
  21.                 f       forced word capitalization ('s' mode only)
  22.  
  23. l       input line will be displayed (inverse bar of maximum input length)
  24.  
  25. r       a carriage return / line feed pair will be appended to this field
  26.         in the data buffer. Only use this field if you want the data buffer
  27.         or file to be more readable. All data is on one line otherwise.
  28.  
  29. x       maximum string length allowed (required for non-template 's' mode)
  30.  
  31. n       minimum string length allowed (only applicable with 's' input mode)
  32.  
  33. str  1: in 's' modes, a template string that defines what will be displayed
  34.         at the prompt and what type of characters the user can input. All
  35.         characters other than 'N', 'A' or '!' are printed at the prompt.
  36.         Occurances of 'N', 'A' or '!' define which type of character the user
  37.         can input for each character position. 'N' allows the user only to
  38.         enter a numeric character, 'A' allows only alphabetic, and '!' allows
  39.         any character. Popular templates are "NNN-NNN-NNNN" for phone number
  40.         input or "NN/NN/NN" for date input.
  41.  
  42.      2: in 'c' modes, a string that defines which characters the user will
  43.         be allowed to input (not case sensitive), usually used for multiple
  44.         choice answers. Most common allowed characters are "ABCD..." or
  45.         "1234...". If this string is specified in 'c' input mode, 'u' and 'n'
  46.         have no effect and input will be converted to uppercase automatically.
  47.                                    
  48. Example 1:
  49.  
  50. <BOT>
  51. Enter string: <EOT>sulr8.3
  52.         
  53.          Prints the prompt, "Enter string: ", then a line of 8 blue spaces
  54. (an input bar, if you like), would convert all of user's input to uppercase,
  55. allow the user to input a maximum of eight characters, a minimum of three and
  56. append a CRLF onto the end of the data field.
  57.  
  58. Example 2:
  59.  
  60. <BOT>
  61. A> First Answer
  62. B> Second Answer
  63. C> Third Answer
  64.  
  65. Which: <EOT>c"ABC"
  66.  
  67.         Prints "A> First Answer" "B> Second Answer" etc... then allows the
  68. user to input one character, either A,B, or C. No other characters will be
  69. accepted as input.
  70.  
  71. Example 3:
  72.  
  73. <BOT>
  74. Enter phone number: <EOT>s"NNN-NNN-NNNN"
  75.  
  76.         Prints "Enter phone number: ", then allows the user to input only
  77. numbers in the 'N' character positions, and automatically skips over the
  78. '-' characters.
  79.  
  80.         
  81. SIF was developed as a questionnaire type file interface for Synchronet BBS.
  82. Its purpose was to minimize the amount of static data in the Synchronet
  83. executable and allow modifications to the syntax and color attributes of
  84. parts of the BBS without requiring recompilation.
  85.  
  86. An automatic new user SIF questionnaire can be specified in the MAIN.CFG file.
  87. If a newuser SIF is specified, all users who logon and don't have a copy of
  88. the answered questionnaire data in their user file will be given the
  89. questionnaire upon logon. The sysop can view the answered questionnaire from
  90. User Edit with the '#' command. For convience, the sysop can create a second
  91. (abbreviated) SIF file for his own use in viewing user's answers. The two SIF
  92. files (input and output) should be identical with the exception of what is
  93. in the 'text' portion.
  94.  
  95. See EXAMPLE.SIF in the SBBS\TEXT directory for more information.
  96.  
  97. /* End of SIF.DOC */
  98.