home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / bbs_ra / seditv23.arj / SEDIT.DOC next >
Text File  |  1991-03-21  |  16KB  |  359 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.                                                                                 
  16.                                                                                 
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.                                                                                 
  26.                        ▄████▄ ██████ █████▄  ██ ████████
  27.                       ██      ██     ██   ██ ██    ██
  28.                       ▀█████▄ ████   ██   ██ ██    ██   V2.3
  29.                            ██ ██     ██   ██ ██    ██
  30.                       ▀████▀  ██████ █████▀  ██    ██
  31.                                                                                 
  32.                                                                                 
  33.                                The Menu Editor                                  
  34.                                                                                 
  35.                          Editing the Menus of SuperBBS                          
  36.  
  37.  
  38.                            (C) 1991  by Oliver Weindl
  39.  
  40.  
  41.                   For Upgrade Versions Call TOOLBOX Rottenburg/L
  42.                        Germany - 08781-3188  1200-2400 BAUD
  43.  
  44.  
  45.  
  46.  
  47.                                       -1-
  48.  
  49. 1.General
  50.  
  51. SEDIT is a menueditor for SBBS and QBBS. Other BBS programs may not work
  52. with this version of SEDIT.
  53. SEDIT is deliverd in following package:
  54.  
  55.  SEDIT.EXE  Main program
  56.  SEDIT.OVR  Overlay with some functions
  57.  SEDIT.TPY  The Menutypes (this is a real ASCII File, you can append
  58.                            new menutypes by adding them in this textfile.
  59.                            Only us a simple ASCII-Editor)
  60.  SEDIT.INI  (only the registrated Version of SEDIT)
  61.  SEDIT.DOC  Should be there, cause you're reading it ;-)
  62.  SEDIT.KEY  new item, list of all keys SBBS supports
  63.  
  64. When you are running SEDIT, there will be much more files in the directory,
  65. SEDIT will create them by itself.
  66.  
  67. 2. Registration or not
  68.  
  69. If you don't have the registrated version of SEDIT, don't panic, you can
  70. purchase it for a little fee of 20 German Marks.
  71. If you want to do this, just send me a short letter, and include
  72. a formatted disk. Tell me your registration-datas (2 lines) and you
  73. will receive the disk as fast as possible. It will contain a file
  74. called SEDIT.INI. this will be your ticket for later versions of SEDIT.
  75. You don't need to registrate any more, cause you only take the SW-version
  76. and the key will work.
  77. You can send the money by check (payable in DM) or in bank-notes (please
  78. german notes, cause i don't want to change LIT or so).
  79.  
  80. Write to        Oliver Weindl
  81.                 Sudetenstr.3
  82.          D-8303 Rottenburg/L
  83.  
  84. You also can contact me on my BBS (TOOLBOX Rottenburg   08781-3188) or
  85. with FIDO (JUKEBOX Landshut 2:246/6).
  86.  
  87. 3. Let's Get Started
  88.  
  89. After the introduction-screen (in the SW version this will take some
  90. time), you have to choose one of the existing menus in your menu-directory.
  91. SEDIT takes its informations from CONFIG.BBS. So this file should be
  92. in the same directory than SEDIT. You also can simply type a name, this
  93. menu will be created, if it doesn't exist yet.
  94. Suddenly you have entered the Main Menu of SEDIT. All the menu-functions
  95. are displayed by pressing F1 in the Main Menu.
  96. Now you can edit the different entries of the menu. You can do this
  97. by using the cursor-keys, or simply press the key, which would call
  98. this entry in the BBS.
  99.  
  100.  
  101.                                       -2-
  102. 4. The EDIT-Area
  103.  
  104. ╔═ TEXT-String ═════════════════════════════════════════════════════════════╗
  105. ║         1         2         3         4         5         6         7     ║
  106. ║123456789012345678901234567890123456789012345678901234567890123456789012345║
  107. ║         LogOff  TOOLBOX Rottenburg           ;∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙║
  108. ╚═══════════════════════════════════════════════════════════════════════════╝
  109. ╔═ Data-String ═════════════════════════════════════════════════════════════╗
  110. ║∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙∙║
  111. ╚═══════════════════════════════════════════════════════════════════════════╝
  112. DATA should make :      None
  113. Menutype : 0              0 Text Line (Not Considered a Command) ..
  114. Security : 5
  115. KEY      : ?            Used : ????MS!?+???
  116. ╔═ Colors ════════════╗
  117. ║Foreground : 15      ║
  118. ║Background :  1      ║            ▄████▄ ██████ █████▄  ██ ████████
  119. ╚═════════════════════╝           ██      ██     ██   ██ ██    ██
  120.                                   ▀█████▄ ████   ██   ██ ██    ██   V2.3
  121. ╔═ Flags ═════════════╗                ██ ██     ██   ██ ██    ██
  122. ║Flag A: --------     ║           ▀████▀  ██████ █████▀  ██    ██
  123. ║Flag B: --------     ║
  124. ║Flag C: --------     ║
  125. ║Flag D: --------     ║  ╔═ ALT + (Assignment 1) Change with  ALT + F1-F5
  126. ╚═════════════════════╝  ║    1=┌ 2=┘ 3=─ 4=┐ 5=└ 6=│ 7=┤ 8=├ 9=┴ 0=┬    ║
  127.                          ╚═══════════════════════════════════════════════╝
  128.    UP/DOWN with cursor keys   ---  ESC ends editing
  129.  
  130. The Picture above shows you the screen of the EDIT-Area.
  131. The field TEXT-STRING contains the Chars which will be printed from the
  132. BBS. A semikolon at the end of this lines supresses a carriage RETURN.
  133. By pressing F10 you can make a database for your own Key-definitions.
  134. Most BBS like QBBS or SBBS support Key-Codes for different BBS functions.
  135. To hold all this keys in mind, you need to be either a genius or you are the
  136. programmer of the BBS-Program. Pressing ALT + U in this field will remake
  137. all changes.
  138.  
  139. The Field DATA-STRING stands for special command-lines. This depends
  140. on what for Menu-types you have choosen below. "DATA should make" gives you
  141. a hint, what should stand in the command.line. For further information see
  142. your BBS DOC.
  143.  
  144. At Menutype you can input one of the available menutypes. Pressing F1
  145. let you choose one out of the existing menutypes. This list can be
  146. changed in the File SEDIT.TPY. Use a simple ASCII editor for this
  147. operation.
  148.  
  149. The Security Level also can be changed by pressing F1. This list is
  150. taken from LIMITS.BBS. But you also can make comments to the different
  151. levels.
  152.  
  153. The KEY-Field only consists of one character. This Key will invoke the
  154. menutype in your BBS.
  155.  
  156. Background/Foreground sets the colors for the TEXT-STRING.
  157.  
  158. In the FLAG-BOX you can change the flagg-settings for this menuentry.
  159. Put a "X" on the Bit you want to set. On the right you get your own
  160. FLAG-description. Changing this descriptions is possible in the Main
  161. Menu.
  162.  
  163.  
  164.  
  165.                                       -3-
  166.  
  167. 5. The Main Menu
  168.  
  169. In the Main Menu there are a lot of Functions which can be invoked with the
  170. function keys or with the ALT key. Now you get a list of these functions:
  171.  
  172. Pressing F1 will give you this HELP-SCREEN :
  173.  
  174. ╔═════════════════════════════════════════════════════════════════════╗
  175. ║                                                                     ║
  176. ║    F1        HELP                  F2       Level-Editor            ║
  177. ║    F3        Load New Menu         F4       Simulation-Settings     ║
  178. ║    F5        Start Simulation      F6       Check Menu-structure    ║
  179. ║    F7        Search & Replace      F8       Linenumbers ON/OFF      ║
  180. ║    F9        Flag-Settings         F10      Save Menu               ║
  181. ║                                                                     ║
  182. ║    ALT + I   Insert Entry          ALT + A  Append Entry            ║
  183. ║    ALT + D   Delete Entry          ALT + E  ANSI-Editor             ║
  184. ║    ALT + P   Prompt edit           ALT + F  Flags ON/OFF            ║
  185. ║    ALT + N   New name for Menu     ALT + S  Block save              ║
  186. ║    ALT + C   Copy Entry            ALT + L  Block load              ║
  187. ║    ALT + G   Global Prompt         ALT + T  Default Entry           ║
  188. ║    ESC       END                   ALT + O  ANSI Compiler           ║
  189. ║                                                                     ║
  190. ║ Choose an entry with the cursor keys or simply by pressing its      ║
  191. ║ INVOKE key. Pressing F10 in edit-mode gives you a list of keys.     ║
  192. ║ With ALT + U in edit-mode, you can invoke an UNDO-function.         ║
  193. ║                                                                     ║
  194. ║                                                                     ║
  195. ╚═════════════════════════════════════════════════════════════════════╝
  196.  
  197.  
  198. F2  Level Editor :          Here you can create comments for each
  199.                             securitylevel found in your LIMITS.BBS.
  200.                             If you add an level in your BBS, SEDIT
  201.                             will recognize this automatically.
  202.  
  203. F3  Load New Menu:          Loading a new Menu into SEDIT
  204.  
  205. F4  Simulation Settings:    Here you can define your simulation-
  206.                             environment. So you also can test your
  207.                             Menu-structure by simulating a new User.
  208.  
  209. F5  Start Simulation:       Starts the Simulation with the in F4 defined
  210.                             simulation-settings. The Simulation only
  211.                             follows a few of the available commands.
  212.                             There are for example GOTO and GOSUB commands,
  213.                             RETURN from SUBMENU is also recognized.
  214.                             Additionaly you can view ASC/ANS Files.
  215.                             Other commands are ignored and you have to test
  216.                             them in your BBS.
  217.  
  218.  
  219.  
  220.                                       -4-
  221.  
  222. F6  Check Menustructure:    This Option allows you to show you, wether
  223.                             your menustructure has errors or not.
  224.                             SEDIT looks for jumps in other menus or ASC
  225.                             ANS files, which should be shown. If the
  226.                             file is missing, SEDIT will beep and show you
  227.                             the missing Filename.
  228.  
  229. F7  Search & Replace:       Pressing this key allows you to serach for
  230.                             special command-lines in your menu-structure.
  231.                             For example if you renamed a menu, its necessary
  232.                             to change all jumps to this menu. Simply type
  233.                             in the old name of the menu and the new one.
  234.                             Then SEDIT will search all menus and replace the
  235.                             old one with the new.
  236.  
  237. F8  Linenumbers ON/OFF :    Changing Linenumbers ON/OFF
  238.  
  239. F9  Flag-Settings :         Here you can define the descriptions which will
  240.                             be shown when editing the flags in the EDIT-
  241.                             Area. Choose a bit and press RETURN. Now you can
  242.                             edit the description. Cursor LEFT/RIGHT changes
  243.                             Flags A to D.
  244.  
  245. F10 Save Menu               Save the Menu.
  246.  
  247.  
  248. Now follow the special ALT-Functions in the Main Menu:
  249.  
  250. ALT + I  Insert Line        Insert a line at cursor location.
  251.  
  252. ALT + D  Delete Line        Delete the line at cursor location
  253.  
  254. ALT + P  Edit Prompt        Edit the Prompt and the Highlight-colors.
  255.                             The Prompt is the line shown at the bottom of
  256.                             each menu. SEDIT won't show this Prompt.
  257.                             A "~" stands for TIMELEFT, that means the
  258.                             BBS will insert here the minutes, which you have
  259.                             left in the BBS. Prompt colors and the highlight
  260.                             colors can also defined here. To highlight a
  261.                             character in the menu, take him into two "^".
  262.                             E.G. [^L^] LOGOFF will put the L in highlight.
  263.  
  264. ALT + N  New Name for menu  Let you choose a new name for the actual menu
  265.  
  266. ALT + C  Copy Entry         Copy an entry. First you have to choose the entry
  267.                             which should be copied. Take the cursor
  268.                             to the position, where the Entry should be
  269.                             copied. Now you only have to choose wether to
  270.                             INSERT the entry or OVERWRITE the entry at
  271.                             cursor location.
  272.  
  273. ALT + A  Append Entry       Append an entry at the bottom of the Menu.
  274.  
  275. ALT + E  ANSI Editor        Let you call up an ANSI-Editor for editing
  276.                             your ANSI files in the txtfile directory.
  277.                             I advise you to use THEDRAW for this operation.
  278.                             It takes not to much memory. Before you can
  279.                             call up the editor, you have to give SEDIT the
  280.                             full Path and the filename of the editor. Don't
  281.                             forget the Extension of the Editor (EXE or COM).
  282.  
  283.  
  284.  
  285.                                       -5-
  286.  
  287.  
  288. ALT + F  Flags ON/OFF       Here you can set Flags or disable them globaly.
  289.                             If you have changed a flag-setting in your BBS,
  290.                             you have to change all menus, simply
  291.                             choose this option and set or delete the flags
  292.                             globaly.Choose the Flags to set, and SEDIT will
  293.                             prompt you before every menu, wether he should
  294.                             change the flag or not.
  295.  
  296. ALT + S  Save Block         Firstly choose the beginning of the block,
  297.                             and then the ending. Now you only have to give
  298.                             the block a name (existing files are deleted).
  299.  
  300. ALT + L  Load Block         Loads an saved block, and inserts him at
  301.                             cursor location.
  302.  
  303. ALT + G  Global Prompt      With this option you can change all Prompt-
  304.                             strings in your menus in one moment. Simply
  305.                             define a string and the colors, and the changes
  306.                             will be done to all menus in menudirectory.
  307.  
  308. ALT + T  Default Entry      Now you can define a default entry which will
  309.                             be insert in your menus by ALT + I and ALT + A.
  310.  
  311. ALT + O  ANSI Compiler      Compiles an ANSI File (*.ANS) to a SEDIT
  312.                             block-file (*.BLK). Firstly choose an existing
  313.                             ANS File in the current directory. Then enter
  314.                             the name of the destination-block. SEDIT will
  315.                             convert the ANSI file into the menu-structure
  316.                             of QBBS/SBBS. This block can be implemeted by
  317.                             the ALT + L option.
  318.  
  319.  
  320. ESC                         ESC puts you out of SEDIT.
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                       -6-
  328. 6. Shareware
  329.  
  330. Some guys who will use this editor ( or any other SW program ) will say
  331. "hey what's up, the fool wants money for the prog, let's take our Debugger
  332. and get it fixed!". Yes, this will (perhaps) propably happen. But
  333. nevertheless, supporting the Shareware-principle is not one of the bad ones.
  334. Only the paying users of SW programs keep the scene alive. So don't
  335. sit on your money, and registrate. If every user only registrates to
  336. one SW program, this would increase the quality of the SW scene enormously.
  337.  
  338.  
  339. 7. Finally
  340.  
  341. This DOC isn't one of the long ones. I simply give you a short summary
  342. of the abilities of SEDIT. If you have questions or suggestions (how
  343. nice it rhymes B-) you can contact me over my BBS. Simply call
  344. Germany 08781-3188 . We're online from 07.00 to 24.00 under the week,
  345. and at weekends 24h. If you want to have the level for the SBBS area,
  346. complete the Questionary in the main menu and then answer the questions
  347. in the sysop-menu.
  348. Saving money, you also can contact me over FIDO JUKEBOX *HST* Landshut 24h
  349. 2:246/6 (Thanx to the SysOp Werner Hielscher for extremly excessive and
  350. annoying ;-) Beta-testing).
  351.  
  352. So, that was it. Surely you've recognized, that my english is not
  353. one of the best ones, but i hope you can handle with SEDIT.
  354.  
  355.  
  356.       May the CARRIER be with You .......
  357.  
  358.                               
  359.