PC Online 1998 January

home *** CD-ROM | disk | FTP | other *** search

/ PC Online 1998 January / PCO0198.ISO / filesbbs / dos / cs340a-e.exe / DOC / REFERENC.DOC < prev next >

Wrap

Text File | 1997-07-09 | 46.0 KB | 942 lines

"The Army Knife for ProBoard BBS Software" · ·· ·-──── -──·──── -──· ┌┐-──·┌─┐┌─ ──·┌─┐─────── -──·──── ──-──· -∙· · │ ┌ ┌┼┬┘└─┐┌──┼┬┘│ ┐ └─┘└─┘│└───┘└─┘│└─┴─│ · ·· ·-──── -──·──── -──· ─ -──·│─── -──·──-──┘──── -──·──── ──-──· -∙· · CURSORY, VERSION 3.40 PROBOARD 2.1x DOS PEX Copyright (C) 1995-1997 WSA Software Written by J. Rathmann ALL RIGHTS RESERVED ╔══════════════════════════════════════════════════════════════════════════╗ ║ ▒▒ Reference ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ║ █ ╚══════════════════════════════════════════════════════════════════════════╝ █ ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ This file contains a reference of ALL CSI-keywords, control codes, color codes, text macros, special codes for "hotkey" and "globalkey" and error messages. ┌──────────────┐ │ CSI-keywords │ └──────────────┘ LOCAL KEYWORDS GLOBAL KEYWORDS ╔────────────────╗ ╔─────────────────────────────────╗ │ menu │ │ globalhotkeys nocheck │ │ help │ │ globalkey noglobalcheck │ │ hotkey │ │ startmenu log │ │ returnkey │ │ show forceansi │ │ function │ │ numeric forceavatar │ │ restart │ │ static hide │ │ leftgoto │ │ elitemenu printstart │ │ rightgoto │ │ elitetask printend │ │ upgoto │ │ nofresh userdoes │ │ downgoto │ │ noloop timeslice │ │ leftkey │ ╚─────────────────────────────────╝ │ rightkey │ │ upkey │ │ downkey │ │ task │ │ wait │ ╚────────────────╝ ╔──────╗ │ menu │ Defines a new menu option ╚──────╝───────────────────────────────────────────────────────────────────── Type ............... LOCAL Syntax ............. menu "MENUTEXT" MENUTEXT = Text including control codes (you can find a description of all control codes in the section "Control codes") Example ............ menu "%1,1%@8,27@ Test menu option " Description ........ This keyword defines the text, position(s) and color(s) of ONE menu option. It is the START MARKING of a menu block, ALL LOCAL keywords below belong to this menu option (until the next menu option is defined using "menu"). ╔──────╗ │ help │ Defines a help text (online help) for a menu option ╚──────╝───────────────────────────────────────────────────────────────────── Type ............... LOCAL Syntax ............. help "HELPTEXT" HELTTEXT = including control codes (you can find a description of all control codes in the section "Control codes") Example ............ help "%1,20%@14@This is a help text" Description ........ This keyword defines text, position(s) and color(s) of ONE help text. This help text belongs to the LAST defined menu option. ╔────────╗ │ hotkey │ Defines a "hotkey" for a menu option ╚────────╝─────────────────────────────────────────────────────────────────── Type ............... LOCAL Syntax ............. hotkey HOTKEY HOTKEY = ASCII-character OR ASCII-code with preceding "#" Examples ........... hotkey a hotkey #27 Description ........ This keyword defines a LOCAL hotkey for the LAST defined menu option. If it is defined, the corresponding menu option can be selected directly via the specified character, alternatively to the cursor key control and "RETURN". The character is case insensitive. ╔───────────╗ Defines a character which is sent after the │ returnkey │ corresponding menu option is selected ╚───────────╝──────────────────────────────────────────────────────────────── Type ............... LOCAL Syntax ............. returnkey RETURNKEY RETURNKEY = ASCII-character OR ASCII-Code with preceding "#" Examples ........... returnkey a returnkey #65 Description ........ This keyword can be used to define a character which is sent to ProBoard after the corresponding menu option is selected. This character MUST be defined as HOTKEY in the ProBoard MENU EDITOR. The character is sent to ProBoard AFTER execution of a function possibly defined with "function". The character is case insensitive. ╔───────────╗ Defines a function which is executed after the │ function │ corresponding menu option is selected ╚───────────╝──────────────────────────────────────────────────────────────── Type ............... LOCAL Syntax ............. function FUNCTIONNUMBER OR function FUNCTIONNUMBER, "PARAMETER" FUNCTIONNUMBER = ProBoard function (you can find a description of all ProBoard functions in the ProBoard documentation) PARAMETER = Parameter (if necessary) Examples ........... function 8 function 60, "TEXTSRCH" Description ........ This keyword defines a ProBoard function which is executed after the corresponding menu option is selected. After execution the menu is left (you can avoid this by using "restart"). The defined function is executed BEFORE a character possibly defined with "returnkey" is sent. ╔─────────╗ │ restart │ Causes CURSORY to restart after a function is executed ╚─────────╝────────────────────────────────────────────────────────────────── Type ............... LOCAL Syntax ............. restart Description ........ After selection of a SPECIFIC menu option and execution of a function the menu is NOT left. Instead the CSI-file is called again (the file is NOT read again physically). ╔──────────╗ Defines the menu option which is active after the user │ leftgoto │ pressed CURSOR-LEFT on the corresponding menu option ╚──────────╝───────────────────────────────────────────────────────────────── Type ............... LOCAL Syntax ............. leftgoto MENUOPTION MENUOPTION = Number of a menu option Note: The menu options are numbered top down Default ............ Active menu option - 1 Example ............ leftgoto 4 Description ........ If the user presses CURSOR-LEFT on the corresponding menu option, the defined menu option is active. All invalid values are ignored. ╔───────────╗ Defines the menu option which is active after the user │ rightgoto │ pressed CURSOR-RIGHT on the corresponding menu option ╚───────────╝──────────────────────────────────────────────────────────────── Type ............... LOCAL Syntax ............. rightgoto MENUOPTION MENUOPTION = Number of a menu option Note: The menu options are numbered top down Default ............ Active menu option + 1 Example ............ rightgoto 4 Description ........ If the user presses CURSOR-RIGHT on the corresponding menu option, the defined menu option is active. All invalid values are ignored. ╔────────╗ Defines the menu option which is active after the user │ upgoto │ pressed CURSOR-UP on the corresponding menu option ╚────────╝─────────────────────────────────────────────────────────────────── Type ............... LOCAL Syntax ............. upgoto MENUOPTION MENUOPTION = Number of a menu option Note: The menu options are numbered top down Default ............ Active menu option - 1 Example ............ upgoto 4 Description ........ If the user presses CURSOR-UP on the corresponding menu option, the defined menu option is active. All invalid values are ignored. ╔──────────╗ Defines the menu option which is active after the user │ downgoto │ pressed CURSOR-DOWN on the corresponding menu option ╚──────────╝───────────────────────────────────────────────────────────────── Type ............... LOCAL Syntax ............. downgoto MENUOPTION MENUOPTION = Number of a menu option Note: The menu options are numbered top down Default ............ Active menu option + 1 Example ............ downgoto 4 Description ........ If the user presses CURSOR-DOWN on the corresponding menu option, the defined menu option is active. All invalid values are ignored. ╔─────────╗ Defines a character which is sent after pressing │ leftkey │ CURSOR-LEFT on the corresponding menu option ╚─────────╝────────────────────────────────────────────────────────────────── Type ............... LOCAL Syntax ............. leftkey LEFTKEY LEFTKEY = ASCII-character OR ASCII-code with preceding "#" Examples ........... leftkey a leftkey #65 Description ........ If the user pressed CURSOR-LEFT on the corresponding menu option, the defined LEFTKEY is sent to ProBoard. If for a menu option both "leftkey" and "leftgoto" is defined, then "leftkey" has a higher priority. ╔──────────╗ Defines a character which is sent after pressing │ rightkey │ CURSOR-RIGHT on the corresponding menu option ╚──────────╝───────────────────────────────────────────────────────────────── Type ............... LOCAL Syntax ............. rightkey RIGHTKEY RIGHTKEY = ASCII-character OR ASCII-code with preceding "#" Examples ........... rightkey a rightkey #65 Description ........ If the user pressed CURSOR-RIGHT on the corresponding menu option, the defined RIGHTKEY is sent to ProBoard. If for a menu option both "rightkey" and "rightgoto" is defined, then "rightkey" has a higher priority. ╔───────╗ Defines a character which is sent after pressing │ upkey │ CURSOR-UP on the corresponding menu option ╚───────╝──────────────────────────────────────────────────────────────────── Type ............... LOCAL Syntax ............. upkey UPKEY UPKEY = ASCII-character OR ASCII-code with preceding "#" Examples ........... upkey a upkey #65 Description ........ If the user pressed CURSOR-UP on the corresponding menu option, the defined UPKEY is sent to ProBoard. If for a menu option both "upkey" and "upgoto" is defined, then "upkey" has a higher priority. ╔─────────╗ Defines a character which is sent after pressing │ downkey │ CURSOR-DOWN on the corresponding menu option ╚─────────╝────────────────────────────────────────────────────────────────── Type ............... LOCAL Syntax ............. downkey DOWNKEY DOWNKEY = ASCII-character OR ASCII-code with preceding "#" Examples ........... downkey a downkey #65 Description ........ If the user pressed CURSOR-DOWN on the corresponding menu option, the defined DOWNKEY is sent to ProBoard. If for a menu option both "downkey" and "downgoto" is defined, then "downkey" has a higher priority. ╔──────╗ │ task │ Defines an animation sequence ╚──────╝───────────────────────────────────────────────────────────────────── Type ............... LOCAL (TASK) Syntax ............. task "SEQUENCE" SEQUENCE = Text including control codes (you can find a description of all control codes in the section "Control codes") Example ............ task "%1,24%@7@This is part of an animation" Description ........ Using this keyword you can define an animation sequence (a "state" of an animation). If several "tasks" are defined, they will be shown top down at runtime. When the last "task" is reached (the end), the animation is shown again (you can disable this via "noloop"). A "task" is local, but it does not belong to a menu option. "Local" just means that it belongs to the keyword "wait". ╔──────╗ Defines the delay after the corresponding animation │ wait │ sequence is displayed ╚──────╝───────────────────────────────────────────────────────────────────── Type ............... LOCAL (TASK) Syntax ............. wait DELAY DELAY = Value for delay (the value 18 delays about 1 second) Default ............ 0 Example ............ wait 10 Description ........ This keyword defines the delay after the corresponding "task" is displayed. The next "task" is not displayed until the delay ends. This keyword is OPTIONAL, it does not have to be defined behind every "task". 0 is default (no delay). Each value behind "wait" may be different, so you can change the animation speed at runtime! ╔───────────────╗ │ globalhotkeys │ Defines SEVERAL global hotkeys ╚───────────────╝──────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. globalhotkeys "HOTKEYS" HOTKEYS = List of characters Example ............ globalhotkeys "!#%?$*-" Description ........ Defines global hotkeys or in general characters which are also sent to ProBoard. When a key is pressed while menu selection which is not a control key or a local hotkey, it is normally ignored. By using this keyword you can define ADDITIONAL characters which are also sent to ProBoard. For example this could be hotkeys, which are defined in the GLOBAL menu in the ProBoard menu editor. "globalhotkeys" may be defined several times in a CSI-file. ╔───────────╗ Defines ONE global hotkey, additionally a seperated │ globalkey │ "returnkey" can be specified ╚───────────╝──────────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. globalkey HOTKEY OR globalkey HOTKEY, RETURNKEY HOTKEY = ASCII-character OR ASCII-code with preceding "#" RETURNKEY = ASCII-character OR ASCII-code with preceding "#" Examples ........... globalkey ? globalkey #63 globalkey #27, ! Description ........ This keyword can be used to define ONE global hotkey (see also CSI-keyword "globalhotkeys"), additionally a RETURNKEY can be specified. In this case the RETURNKEY is sent after the user pressed the HOTKEY. You can GLOBALLY seperate hotkeys and returnkeys (equivalent to the local seperation via the CSI-keywords "hotkey" and "returnkey"). If no RETURNKEY is specified, the HOTKEY is sent (identical to "globalhotkeys"). For this reason "globalkey a" is exactly the same as "globalkey a, a". This keyword may be defined SEVERAL times in a CSI-file. HOTKEY and RETURNKEY are case insensitive. ╔───────────╗ │ startmenu │ Defines the menu option which is active at start ╚───────────╝──────────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. startmenu MENUOPTION MENUOPTION = Number of a menu option Note: The menu options are numbered top down Default ............ 1 Example ............ startmenu 4 Description ........ The value behind this CSI-keyword defines the menu option which is active at start. If this keyword is missing, the first menu option is active by default. All invalid values are ignored. If the keyword "static" is defined additionally, then "startmenu" has only an effect if the menu is displayed the FIRST time. ╔──────╗ │ show │ Displays an ANSI- or AVATAR-file ╚──────╝───────────────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. show "FILENAME" FILENAME = Name of an ANSI/AVATAR-file WITHOUT path and extension Example ............ show "MAIN" Description ........ Displays an ANSI/AVATAR-file as background for a menu. The file *MUST* be located in the ProBoard TXTFILES- directory. If the specified file is not found, the keyword is ignored. ╔─────────╗ │ numeric │ Allows alternative control via 2, 4, 6 and 8 ╚─────────╝────────────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. numeric Description ........ Allows alternative control via the keys 2, 4, 6 and 8 (replacement for the cursor keys). If identical hotkeys are defined, the hotkeys have a HIGHER priority! ╔────────╗ Causes that the last selected menu option is saved │ static │ and active automatically when the menu is called again ╚────────╝─────────────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. static Description ........ If this keyword is defined in a CSI-file, the last selected menu option is saved when the menu is left. If the same menu is called again, not the first or the menu option defined via "startmenu" is active but the saved one. Therefore this keyword has a higher priority than "startmenu". ╔───────────╗ │ elitemenu │ Converts all menu and help texts into "elite-font" ╚───────────╝──────────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. elitemenu Description ........ If this keyword is defined, ALL menu options and help texts are converted into "elite"-font. The following changes are made: 1. All characters are converted into capitals 2. 'A' (ASCII-code 065) -> 'Æ' (ASCII-code 146) 3. 'E' (ASCII-code 069) -> 'ε' (ASCII-code 238) 4. 'F' (ASCII-code 070) -> 'ƒ' (ASCII-code 159) 5. 'I' (ASCII-code 073) -> 'i' (ASCII-code 105) 6. 'N' (ASCII-code 078) -> '∩' (ASCII-code 239) ╔───────────╗ │ elitetask │ Converts all animation sequences into "elite-font" ╚───────────╝──────────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. elitetask Description ........ Converts ALL animation sequences (defined with "task") into "elite"-font. Take a look at "elitemenu" to find detailed information. ╔─────────╗ Causes that all menu options are NOT displayed at start │ nofresh │ (only the active menu option is visible) ╚─────────╝────────────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. nofresh Description ........ This keyword causes a "nofreshing" of all menu options at start. Normally ALL menu options defined in a CSI- file are displayed once automatically, so the user can see between what he may choose. If the keyword "nofresh" is used, ONLY the active menu option is visible at start. Therefore it is possible to "paint" all menu options in the background picture (see CSI-keyword "show") and CURSORY will not overwrite them at start. In principle this is not disturbing, but it is sometimes visible if the user has a bad connect and there are many menu options. The advantage of defining all menu options (in the "not active" color!) in the background picture is that these menu options are visible IMMEDIATELY for the user. Without "nofresh" the background picture is shown FIRST, THEN the menu options are displayed. You should ONLY use "nofresh" if you do not like the aspect described above, because there are also two disadvantages: 1. All menu options defined in the CSI-file must be EXACTLY identical with the menu options in the background picture 2. The keyword "elitemenu" only has an effect if the user chooses the menu options at least ONCE. If you want to use this keyword, all menu options must be defined in "elite-font" in the background (see CSI- keyword "elitemenu") ╔────────╗ Causes that a defined animation is NOT repeated, it is │ noloop │ displayed only ONCE ╚────────╝─────────────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. noloop Description ........ If this keyword is defined and the last animation sequence is reached, the animation is NOT repeated. This keyword has only an effect if there is really an animation. If not, the keyword is ignored. ╔─────────╗ │ nocheck │ Disables checking for all menu options ╚─────────╝────────────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. nocheck Description ........ After a menu option is selected the programm will NOT check if the user has really access. If a returnkey is defined, it is sent to ProBoard in any case (and there possibly ignored). You should use this keyword if you call CURSORY in a language file, otherwise the error message "Could not open PBM-file" is shown (a PBM-file contains information about limitations for each menu options). ╔───────────────╗ │ noglobalcheck │ Disables checking for menu options in the GLOBAL menu ╚───────────────╝──────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. noglobalcheck Description ........ Similar to "nocheck", but ONLY the GLOBAL checking is disabled. Use this keyword if you want checking but no global menu is defined in the ProBoard menu editor (file GLOBAL.PBM). ╔─────╗ Enables the "LOG"-function / some runtime information │ log │ is written to the file PROBOARD.LOG ╚─────╝────────────────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. log Description ........ If this keyword is defined, some useful runtime information (e. g. selected menu options, executed functions) is written to the file PROBOARD.LOG. ╔───────────╗ │ forceansi │ Forces CURSORY to use the ANSI-emulation ╚───────────╝──────────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. forceansi Description ........ If this keyword is defined, CURSORY uses the ANSI-mode in any case. For example this is useful for a LOGIN. ╔─────────────╗ │ forceavatar │ Forces CURSORY to use the AVATAR-emulation ╚─────────────╝────────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. forceavatar Description ........ If this keyword is defined, CURSORY uses the AVATAR-mode in any case. For example this is useful for a LOGIN. ╔──────╗ │ hide │ The cursor is hidden GLOBALLY ╚──────╝───────────────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. hide X, Y OR hide X, Y, NOHIDE X = X-position Y = Y-position NOHIDE = 0 or 1 1 means, that the cursor is not hidden after it is set to the defined position (default is 0) Example ............ hide 79, 24 hide 79, 24, 1 Description ........ The cursor is hidden GLOBALLY. This keyword is a replacement for the control code "*". If this keyword is used, the cursor is set to the defined position after EACH change on the screen. Now it will be invisible (also for the user!). The difference to the control code "*" is that the cursor is set to a fixed position again and again. "*" will always use the CURRENT position. NOTE: "hide 80, 24" will scroll up the screen. ╔────────────╗ │ printstart │ Displays a text BEFORE the cursor key control is started ╚────────────╝─────────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. printstart "TEXT" TEXT = including control codes (you can find a description of all control codes in the section "Control codes") Example ............ printstart "%1,1%@15@Welcome to this menu!" Description ........ The text defined behind this keyword is displayed BEFORE the cursor key control (or the animation, if no menu options are defined) is started. If a background picture is defined (see CSI-keyword "show"), this will happen AFTER the picture is shown. For example you can use this keyword to display static text macros (fixed text macros, e. g. the user's name or location). ╔──────────╗ Displays a text AFTER the cursor key control is left │ printend │ and BEFORE the program exits ╚──────────╝───────────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. printend "TEXT" TEXT = including control codes (you can find a description of all control codes in the section "Control codes") Example ............ printend "ⁿ²" ⁿ (control code) = clear screen ² (control code) = log off the user Description ........ Similar to "printstart", but this text is shown AFTER the menu selection is left and BEFORE the program exits. For example this is useful if an animation is defined in a CSI-file but the "hide"-keyword is NOT used. Then the cursor position is not defined any time, so if you leave the menu ProBoard could display something at a wrong position. These "errors" occur for example if you use the internal message reading routine. After the user selected the menu option "Read messages", the prompt which messages should be shown is displayed in the MIDDLE of the background picture. This problem can be solved by using the keywords "printend" OR "hide" (the cursor is hidden additionally). You can also use "printend" e. g. to "log off" the user immediately after a menu is left (e. g. at Login). ╔──────────╗ │ userdoes │ Creates a USERDOES-file in the ProBoard system-directory ╚──────────╝───────────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. userdoes "TEXT" Example ............ userdoes "Just testing CURSORY :-)" Description ........ This keyword can be used to create a "USERDOES.*"-file in the ProBoard system-directory BEFORE the program is started ("*" is the current node number). This file may contain information about the user's activity. It can be read using special programs (e. g. USERDOES by DQP). You can assign a USERDOES-text to each CSI-file (therefore also if you call the program in a language file!). E. g. if userdoes "Just testing CURSORY" is defined in a CSI-file and this file is called on node 1, all other users can see (if they just use e. g. DQP-USERDOES) that user no. 1 is just testing CURSORY :-). ╔───────────╗ Defines how many "timeslices" are released per time unit │ timeslice │ if a multitasker is used ╚───────────╝──────────────────────────────────────────────────────────────── Type ............... GLOBAL Syntax ............. timeslice VALUE VALUE = a decimal value Default ............ 1 Example ............ timeslice 5 Description ........ The value behind this keyword defines how many "timeslices" are released per time unit if CURSORY runs under a multitasker. Value 1 means that such "timeslices" are released after every cycle (checking the keyboard and modem buffer and displaying the next animation sequence). If 2 is specified, this will only happen every second, if 3 every third cycle. Default is 1. If 0 is defined, no "timeslices" are released. Using this keyword you can reserve more time for a CURSORY- task under a multitasker. E. g. this is useful if many other tasks are in the background which "slow down" an animation. The best setting depends on the system used and should be tested. If no multitasker is detected, this keyword has no effect. ┌───────────────┐ │ Control codes │ └───────────────┘ All control codes may be used in connection with the keywords "menu", "help", "task", "printstart" and "printend". Many of these control codes need a start and an end marking (two identical characters, e. g. for color changing the character "@"). If you forget the end marking, the complete control code is ignored. This could cause wrong results. If you have problems, check if all end markings are set. NOTE: If you want to DISPLAY a control character, you have to define it TWICE (see also chapter "How to use control characters" in the file "CURSORY.DOC"). ───────────────────────────────────────────────────────────────────────────── @a,b@ = Change color (for "menu") a = Color code or color macro, if the menu option is NOT active b = Color code or color macro, if the menu option is active @a@ = Change color (for "help", "task", "printstart" and "printend") a = Color code or color macro Color code = background color * 16 + foreground color ───────────────────────────────────────────────────── 0 = Black, 1 = Blue, 2 = Green, 3 = Cyan, 4 = Red, 5 = Magenta, 6 = Brown, 7 = Lightgray, 8 = Darkgray, 9 = Lightblue, 10 = Lightgreen, 11 = Lightcyan, 12 = Lightred, 13 = Lightmagenta, 14 = Yellow, 15 = White If you add 128 to the color code, the foreground color will blink. A value higher than 7 as backround color has no effect. Color macros see section "Color macros" below! %x,y% = Change absolute cursor position x = X-position y = Y-position If x and/or y are 0, the specific coordinate is not changed. There are two macros which may be used instead of x and y: - STARTX The X-coordinate where the cursor was located before CURSORY was called - STARTY The Y-coordinate where the cursor was located before CURSORY was called &Xx& = Change relative cursor position X = L (Left), R (Right), U (Up) or D (Down) x = relative change ^TEXTMACRO^ = Displays a ProBoard-compatible text macro, which is replaced through specific information at runtime (text macros see section "Text macros" below!) ~FILENAME~ = Shows an ASCII-/ANSI-/AVATAR-file (the file extension MUST NOT be specified). The file, which must be located in the ProBoard TXTFILES-directory, is shown immediately when this control code is found (if the file is found) $PEX$ = The defined PEX, which must be located in the ProBoard PEX- directory, is executed. You can use this to call your own programs while runtime _DELAY_ = The display is delayed dependent on the value specified behind "DELAY". You can use this to create "fadings". The value 18 will delay about 1 second. * = The cursor is hidden at the current position (on FREE background ONLY!) (see also CSI-keyword "hide") ⁿ = (ASCII 252) Clear screen, if the user has set the "CLRSCR"-flag ² = (ASCII 253) If CURSORY finds this character, the user is logged off IMMEDIATELY :-) ┌──────────────┐ │ Color macros │ └──────────────┘ Color macros may be used in connection with the control character "@" everywhere "normal" color codes are valid, too. The syntax is FOREGROUNDCOLOR-BACKGROUNDCOLOR-BLINK, all macros must be seperated by a hyphen ("-"). ALL macros are OPTIONAL and SHAPELESS. The color BLACK may be left out. Some examples (in brackets the equivalent color codes): blue-black-blink (129) blue (1) blau-black (1) BLUE-Black (1) blue--blink (129) yellow-red (78) blue - black (1) -blue (16) b l u e - b l a c k (1) blau-schwarz (1) Note: English and german color macros and color codes may be mixed. A color macro or color code with a background color value higher than 7 has no effect. All valid color macros (ENGLISH/GERMAN): Color macro Color code Color macro Color code ──────────────────────────────── ────────────────────────────────────── BLACK, SCHWARZ 0 DARKGRAY, DUNKELGRAU 8 BLUE, BLAU 1 LIGHTBLUE, HELLBLAU 9 GREEN, GRUEN 2 LIGHTGREEN, HELLGRUEN 10 CYAN, TUERKIS 3 LIGHTCYAN, HELLTUERKIS 11 RED, ROT 4 LIGHTRED, HELLROT 12 MAGENTA, VIOLETT 5 LIGHTMAGENTA, HELLVIOLETT 13 BROWN, BRAUN 6 YELLOW, GELB 14 LIGHTGRAY, HELLGRAU 7 WHITE, WEISS 15 BLINK 128 ┌─────────────┐ │ Text macros │ └─────────────┘ Text macros can be shown left-aligned, right-aligned or centered. Normal: ^textmacro^ Left-aligned: ^textmacro:20^ Right-aligned: ^textmacro:-20^ Centered: ^textmacro::20^ ADDRESS1 User's address, 1. part ADDRESS2 User's address, 2. part ADDRESS3 User's address, 3. part BAUD Baudrate BBSLOCATION Location of BBS BBSNAME Name of BBS BBSPHONE Phone number of BBS BIRTHDATE User's birthday CIL CURSORY KERNEL INFO CITY User's location COUNTRY User's country CURFILEAREA# Number of current filearea CURFILEAREA Name of current filearea CURFILEGROUP# Number of current filegroup CURFILEGROUP Name of current filegroup CURMENU Name of current menu CURMSGAREA# Number of current messagearea CURMSGAREA Name of current messagearea CURMSGGROUP# Number of current messagegroup CURMSGGROUP Name of current messagegroup DATAPHONE User's data phone number DATE Current date DOWNLOADLIMIT User's KB download-limit per day EXPIRATIONDATE Expiration-date FAXPHONE User's FAX phone number FIRSTLOGIN Date of user's first login FIRSTNAME User's first name FLAGANSI +/- = Ansi enabled/disabled FLAGAVATAR +/- = Avatar enabled/disabled FLAGAVTPLUS +/- = Avt/0+ enabled/disabled FLAGCLEARSCREEN +/- = Clearscreen enabled/disabled FLAGFSED +/- = Fullscreen-editor enabled/disabled FLAGHOTKEYS +/- = Hotkeys enabled/disabled FLAGIBM +/- = IBM-chars enabled/disabled FLAGMOREPROMPT +/- = Moreprompt enabled/disabled FULLTIME Current time (including seconds!) HANDLE User's handle (alias) ID User's "ID" (short description of level) INACTIVITYTIME Inactivity-time INFO CURSORY version number KBDOWNLOADED User's KB download (total) KBUPLOADED User's KB Upload (total) KBUSEDTODAY User's KB Download (today) LANGUAGE User's language LASTDATE Date of user's last call LASTNEWFILESCHECK Date of user's last newfilecheck LASTPASSWORDCHANGE Date of user's last password change LASTTIME Time of user's last call LEVEL User's level MAXSYSOPPAGES Number of allowed sysop pages MINUSEDTODAY User's online time today (minutes) MNUDIR Path to the *.PBM-files MSGDIR Path to messagebase NAME User's name NEWUSERLEVEL Level for new users NLDIR Nodelist-directory NODE Current node number NUMCALLS Number of user's total calls NUMDOWNLOADS Number of user's total downloads NUMFILEAREAS Number of fileareas NUMMSGAREAS Number of messageareas NUMNODES Number of nodes NUMPOSTED Number of user's written messages NUMUPLOADS Number of user's total uploads NUMUSERS Number of users PASSWORD User's password PEXDIR PEX-directory PREVUSER Name of previous user PROTOCOLHOTKEY Hotkey of user's default protocol PROTOCOLNAME Name of user's default protocol PVTDIR User's private upload-directory SCREENLENGTH Number of lines SCREENWIDTH Number of columns STARTDIR Startup-path STATE User's state SYSDIR ProBoard system-directory SYSOPNAME Sysop's name TIME Current time TMLEFT User's time left today TMLIMIT User's daily time limit TMONLINE User's online time today TOTALTIMEUSED User's total online time TXTDIR Path to the ASCII-/ANSI-/AVATAR-files UPDIR Upload-directory USERREC User's number in the file USERS.BBS VERSION ProBoard version number VOICEPHONE User's voice phone number %ENVIRONMENT-VARIABLE Shows the environment variable defined with "SET VARIABLE=" ┌────────────────────────────────────────────┐ │ Special codes for "hotkey" and "globalkey" │ └────────────────────────────────────────────┘ By using these special codes you can use the following keys as hotkey. SPACE #32 RETURN #13 ESC #27 Cursor-left #19200 Cursor-right #19712 Cursor-up #18432 Cursor-down #20480 HOME #18176 END #20224 Examples: hotkey #27 globalkey #19200, < globalkey #19712, > ┌────────────────┐ │ Error messages │ └────────────────┘ ERROR -> No CSI-file defined The program could not find any parameter in the DATA-field of the menu editor ERROR -> No menu or task defined In the specified CSI-file there is neither a menu option nor an animations sequence defined ERROR -> Could not open PBM-file After selecting a menu option the program checks if it is possibly locked by flags, a minumum level or something else in the menu editor. This information is read from "PBM"-files. When CURSORY is called in a language file, no PBM-file exists. In this case the checking must be deactivated manually to prevent this error message. You can do this by using the global CSI-keyword "nocheck" ERROR -> Could not open GLOBAL.PBM The file GLOBAL.PBM could not be found. Create a global menu or use the global CSI-keyword "noglobalcheck" ERROR -> Out of memory Too few memory to display all menu options / animation sequences defined in the CSI-file ERROR -> Could not open CSI-file The CSI-file was not found. This error occurs if the specified file does not exist or the filename and/or the path are not spelled correctly. If this error occurs again in spite of all checking, then use the filename including COMPLETE path and drive name in the DATA-field (you can find further information in the file "FAQ.DOC") ERROR -> Unknown keyword in line x In the given line of the CSI-file there is an unkown keyword. Check if the keyword is spelled correctly. You can find further information in the file "FAQ.DOC" ERROR -> Too many "menu" defined Too many menu options defined ERROR -> Too many "task" defined Too many animation sequences defined ERROR -> Too many global hotkeys defined Too many global hotkeys defined ERROR -> " expected in line x In the given line a " is missing ERROR -> Too few parameters in line x In the given line at least one parameter is missing behind the CSI-keyword ERROR -> Too many parameters in line x In the given line there are too many parameters behind the CSI-keyword. You can find further information about other reasons for this error message in the file "FAQ.DOC" ERROR -> Keyword outside block in line x In the given line there is a LOCAL CSI-keyword which does not belong to any menu option or animation sequence. Please check if you possibly forgot to define the keywords "menu" or "task" above this keyword