Beijing Paradise BBS Backup

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

/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / POPMAX1.ZIP / DOCUMENT.POP < prev next >

Wrap

Text File | 1993-06-16 | 27.1 KB | 723 lines

June 15, 1993 +---------------------------------+ | PopMax! | | v. 1.0 | | Allan Bowhill, 1993 | +---------------------------------+ +---------------------------------------------------+ | Allan Bowhill | | 7714 196th St #204 | | Edmonds, WA 98026 | | BBS support (206) 775-4765 - State Express BBS | | Fidonet 1:343/555 | | Internet: Allan.Bowhill@f555.n343.z1.fidonet.org | +---------------------------------------------------+ Type C for Contents ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒T0▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ This macro is free, but {Commo} isn't.... Register your copy of {Commo}! PopMax has an internal mechanism to display your {Commo} registration name and number online. Each time the menus are initialized, a snapshot of your opening screen will be copied to your disk. Your registration number and name will be displayed to your users. If you don't have a valid registration number, it will show to your users. - Do not disable this feature! - Show your users that you have registered! ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒TC▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Help Contents Section Topic Access Keys ------- ----- ----------- Introduction Register {Commo} T0 Disclaimer TA Files included TB System requirements TD Program description TE Startup Quick start TF Customizing PopMax Menu structure TH How menus are displayed TI Modifying and compiling menus TJ Option types TK Constructing menus TL Using PopMax Using arrow-keys TN ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒TA▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ∙NOTICE∙ ~~~~~~ NOTICE from the Author: ~~~~~~~~~~~~~~~~~~~~~~~ This is a test release of POPMAX! Menus for Maximus v. 1.0. This means it is still under development. I do not guarantee that this macro will work for you. RISK You use this software at your own risk. I will not be held libel for any consequential damages from the use of these macos and data files. FEES You may use this macro, as long as you do not remove, modify, or disable the subroutines that display to remote callers your: 1. {Commo} registration number 2. {Commo} registered name 3. {Commo} version number If used in an institututional setting, I ask that you notify me of the company that is using it, and the number of copies in use. There is no charge for use. SUPPORT BBS support can be obtained by calling State Express (206) 775-4765. I will try to answer any questions that you have. INELLECTUAL PROPERTY Allan Bowhill (the author) retains all intellectual property rights guaranteed under the U.S. Constitution, and international law. You are not permitted to distribute this macro in anything other than its original form. CREDITS {Commo} is a trademark of Fred P. Brucker Maximus-CBCS is a product of Scott J. Dudley ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒TB▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ∙Files Included∙ There are twelve (12) files enclosed in the POPMAX1.ZIP archive: README.1ST Basic startup instructions INSTALL.BAT Installation batch file INSTALL.POP Installation Macro TAGMENU.POP Information to be added to Menus.Ctl during installation DOCUMENT.POP This document GUI_HLP.POP Online help screen for users OUTLINE.POP Menu options as you define them POPDATA.POP Compiled version of above file COMPILE.POP Macro to compile menu options into above data file POPMAX.POP Main macro, executed online POPMENU.MEC Displayed via Maximus when user selects option POPMAX.MEC User information. Creates .DEF file ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒TD▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ∙System Requirements∙ In order to run this beta release properly, you will need the following equipment and files. 1. An IBM AT computer. 2. A hard disk. 3. A *REGISTERED* COPY of Commo v. 5.41 An unregistered version will not work!! 4. A working Maximus BBS 2.0 or higher This macro is pre-configured to use the following programs in your MAXIMUS Home path: 1. Silt.Exe 2. Mecca.Exe 3. {Commo} 5.41 ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒TE▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ∙Program Description∙ POPMAX! is a set of online ansi pop-down menus for Maximus BBS. It is acts as a door program that utilises Maximus' comprehensive Mecca token language to give your BBS interactive ansi menus. Interactive ansi menus differ from regular ansi menus, because they work on a graphical principle. Your users may select any option based on the movement of a selector bar at a variety of levels. Popmax works as a 'script' file inside Fred Brucker's efficient {Commo} terminal program. When someone logs in to your Maximus system, and enters the Popmax menus, they will be able to use their arrow-keys to select any option in Maximus, in a familiar and intuitive environment. You, as the sysop, can use the interface locally with the added advantage of mouse support, and special control and information features. You can also use the interface (and mouse) while someone is logged-on to your system. Here are a few of the features: - Configurable and definable pop-down menus - make your own options - Optional mouse support for local and online sysop functions - Selectable color or black-and-white ansi emulation - Accessible help files for users - Easy-access online documentation - Online sysop screen with security features - Online user information bar - No 'helper' utilities are used - 100 percent {Commo} reliability - Special data file design - fast reads, minimal disk activity - Special precautions taken against 'ansi-bleed' at high speeds - Optimized escape sequences for fast data transmission - Support for locked baud rates, or non-locked rates HISTORY ------- Originally, this project of developing a pop-down menu interface for Maximus started with the H.A.L. series. The H.A.L. macro series enabled users of a Maximus BBS to use interactive ansi online in the form of little pop-up boxes with a scrolling menu bar. The last in the series (HALGUI1F.XXX) was the last bug fix. The little GUI turned out to be very slow, however, and had a certain lack of appeal, due to the speed. The menus also weren't -true- pop-down menus. I had done all my personal testing of these menus with a 2400 baud modem, and the lack of speed was less apparant. Most of HAL's slowness was due to slow data file reads, so I set out on a project (about 3 or 4 months ago) to redo the menus completely. Since then I have been testing and revising the new version. I have also given the menus a new name, and there have been many improvements. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒TF▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ∙Quick-Start∙ 1. Move a *registered* version of {Commo} 5.4 or above, (with all commo data files) into your Maximus home directory. 2. Unzip the POPMAX archive in your Maximus home directory. 3. Type `INSTALL' from the DOS prompt, in the Maximus home directory. You will guided through a series of steps to assist you in setup. 4. Compile with Silt.Exe, and logon! ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒TH▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Menu Structure ∙Explanation and Analogy∙ The outline file is organized much the same way an essay or speech outline is -- in a topical hierarchy. Each line in the outline file has an associated `level', (from 1 to 8 -- represented by successive dashes) as each line in a speech outline has an associated number or letter. Speech Outline Outline.Pop `````````````` ``````````` I. Introduction <- level 1 -> -menuBar choice a II. Subject <- level 1 -> -menubar choice b A. Topic <- level 2 -> --popdown menu choice a (from b) 1. subtopic <- level 3 -> ---popdown menu subchoice III. Subject <- level 1 -> -menu bar choice c 1. Topic <- level 2 -> --popdown menu choice a (from c) 2. Topic <- level 2 -> --popdown menu choice b (from c) / \ +-----+ \ | \ ------------------------------------------------------------ \ a level-one item: Roman numerals (I,II,III,IV,V,IV...) \ a level-two item: Uppercase English letters (A,B,C,D,E...) \ a level-three item: Arabic numerals (1,2,3,4,5...) \ a level-four item: Lower case English letters (a,b,c,d,e...) \ a level-five item: Arabic numerals (1,2,3,4,5...) \ ------------------------------------------------------------ | | ------------------------------------- | level one - (one dash) | level two -- (two dashes) | level three --- (three dashes) --------------------+ level four ---- (four dashes) level five ----- (five dashes) level six ------ (six dashes) level seven ------- (seven dashes) level eight -------- (eight dashes) -------------------------------------- ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒TI▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ∙How menus are displayed∙ ┌───────────────────┐ ┌─────────────┐ ┌───────────────────────┐ │ Maximus BBS ├──»──┤ Popmax Menu ├──»──┤ Popmax.Bbs displayed ├──»─┐ └───────────────────┘ │ is entered │ │ as custom MenuFile │ │ ┌────────»────────────┤ │ └───────────────────────┘ │ │ └─────────────┘ │ └───■─────────────«─────────────■──────────────«────────────■──────────┘ ┌───────┴────────┐ ┌─────┴─────┐ ┌───────────┴────────────┐ │ Mecca compiles │ │ {Commo} │ │ Popmenu.mec displayed │ │ Choice.Mec │···· └─────┬─────┘ └───────────┬────────────┘ └───────┬────────┘ : ┌──────┴───────┐ ┌─────────┴──────────┐ ┌─────┴───────┐ : │ Popmax Macro │·········│ Popmax.Def written │ │ Choice.Bbs │ : └──────┬───────┘ └────────────────────┘ │ displayed │ : ┌───────┴─────────┐ └─────┬───────┘ : │ Option selected │ ╔═════════════════════╗ ┌───────┴────────┐ : │ from Ansi GUI │ ║ Popmax! ║ │ Mecca command │ : └───────┬─────────┘ ║ Process Flowchart ║ │ excuted online │ : ┌───────────┴──────────────┐ ╠═════════════════════╣ └────────────────┘ ···│ Associated Mecca token │ ║ ■ sub-process ║ │ written to Choice.Mec │ ║ ··· input file link ║ └───────────┬──────────────┘ ║ ─── execution path ║ ┌──────┴───────┐ ║ « » program flow ║ │ Exit {Commo} │ ╚═════════════════════╝ └──────────────┘ Each line in the outline file represents an option in one of the menus in PopMax. All options that are in level one (1) will be placed in the menu bar at the top of the screen. All other options will be end up in pop-down panels, or pop-down subpanels. The borders of the panels are specially deigned to accentate the differences between panels. [ This command was selected ] | | <top of screen> Main Menu Message Menu File Menu Change settings Exit GUI menus Goodbye ▌▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▐▀▀▐ ▌ Areas ▐a ▐ ▌ Upload a Message ▐ ▐<----- pop down panel ▌ Post a message ▐<-------- pop down subpanel ▌ Kill a message ▐ ▐ ▌ Edit a message ▐ ▐ ▌▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▐ ▐ ▌ Goodbye ▐ ▌▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▐ information bars are always at bottom of screen | Escape key exits : Keep mouse still : Use buttons only : Double-click if stuck ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒TJ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ∙Modifying and compiling Menus∙ PopMax's menus are fully customizable and configurable. You can add your own menu options, or modify and delete ones that have been included in the original archive. PopMax is capable of displaying 23 options on any menu or submenu, and 8 levels of submenus can be created. This means almost 200 options can be encorporated into the outline file. Customizing PopMax menu items is a two-step process: 1. Modify the outline file (POPDATA.POP) to add, delete or edit options. You can edit the outline file via your favorite text editor, or by selecting `Edit outline file' from the sysop menu. 2. Compile this file by selecting `Compile new outline file' from the sysop menu. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒TK▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Page 10 ∙Option Types∙ Each option in the outline file is placed on a single line. There are two types of options in the outline file. 1. Submenu-calling option: calls a submenu 2. Command-executing option: executes a Commo/Mecca command * When you create a submenu-calling option, you must also create an associated menu. A submenu-calling option has: 1. No associated command 2. Precedes the first option of the menu it calls 3. Precedes a menu level that is one greater in value A command-executing option has: 1. An associated command 2. Will never precede a menu level greater than itself ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒TL▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ∙Constructing Menus∙ In the PopMax outline file, each individual pop-down menu and submenu must have an assigned menu level. When a submenu-calling option is selected items of the next level are `gathered' to form a new menu on the screen. In the speech outline, sub-topics can be summarized by `gathering' items of a particular level. For example, if a summary is needed of The Four Misconceptions of Social Responsibility, one would first locate the topic header: A. Subject 1 <- level 2 Then `gather' the item headers under that topic: 1. Topic 1 <- level 3 2. Topic 2 <- level 3 3. Topic 3 <- level 3 4. Topic 4 <- level 3 Regarding the menus, the same rule applies. If an item is selected, the the item headers under that option are gathered to form a new submenu. Selected Item: Post (message) Associated text in outline file: -Post`' Option-Type: Submenu-calling Yeilds screen output: <top of screen> Main Menu Message Menu File Menu Change settings Exit GUI menus Goodbye ▌▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▐▀▀▐ ▌ Areas ▐a ▐ ▌ Upload a Message ▐ ▐<----- pop down panel ▌ Post a message ▐<-------- pop down subpanel ▌ Kill a message ▐ ▐ ▌ Edit a message ▐ ▐ ▌▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▐ ▐ ▌ Goodbye ▐ ▌▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▐ Items that were gathered: ------------------------- --Post`' <- level 2 ---Areas`[message][menu_cmd Area_Change]Message' <- level 3 ---Upload a Message`[message][menu_cmd Msg_Upload]message' <- level 3 ---Post a message`[message][menu_cmd Enter_Message]message' <- level 3 ---Kill a message`[message][menu_cmd Msg_Kill]message' <- level 3 ---Edit a message`[mesage][menu_cmd Msg_Change]message' <- level 3 <gethering terminates here> ∙Constructing Options∙ To construct individual options in OUTLINE.POP, three fields must be included, and entered in a prescribed format. Unlike a speech outline, there is no room for error in organization or syntax. If information is absent or misplaced, results may be unpredictable while using. After constructing new options, select `compile' from the sysop menu, to activate them. The three fields each line requires are: Menu_Level Item_Descriptor ^([Mecca Token]^) 1 2 3 -----------====[ Field #1 - Menu_Level ]====---------- These are represented by dashes only -- at least one, no more than eight. The number of concurrent dashes designate the menu level for that option. Valid types: level one - (one dash) level two -- (two dashes) level three --- (three dashes) level four ---- (four dashes) level five ----- (five dashes) level six ------ (six dashes) level seven ------- (seven dashes) level eight -------- (eight dashes) ---------====[ Field #2 - Item_Decriptor]====----------- Item_Descriptor is the text that will appear in any menu as a selectable description of that option. For Example: Quote Message Menu Change Area ------------====[ Field #3 - ^(Mecca Token^)]====----------- This field contains the associated Mecca token to display when the option is selected from the menus. Three things must be satisfied in order for this field to work. 1. If the item that calls a submenu, this field should be left blank, without ^(^) or [] - If it is a command-executing option, Item_Action must be a valid self-contained Mecca command (or series of commands), executable by display. It is important to remember that you are in the POPMAX menu, and all Mecca tokens should be designed with this in mind. In other words, if you wish to design a mecca token to perform a command from the Change menu, write it like this : [Menu_Cmd (menu option)]Change This way, Maximus will know which menu you are referring to. Additional steps must be taken if you wish to refer to menu options from the Message or File menus. For some reason, Maximus does not recognize all plain references (as above) to calls of options in Message or File areas, so it is important to `fool' Maximus' internal pointers into thinking it's in the Message or File area before calling a menu option. Example: [Menu_Cmd Area_Change]Message <-- won't work [message][Menu_Cmd Area_Change]Message <-- will work So, use the Menheader mecca tokens ([message], [file]) before calls to these menus. Such as: [Quote] - displays a quote [ckoff] - turns control-c checking off [Menu_Cmd Statistics]Main - Displays Stats 2. The whole command must be enclosed with Commo's substitute for curly braces: ^( and ^) ^( open curly braces ^) closed curly braces If a submenu is called, these and the mecca tokens are unnecessary. 3. Lastly, the entire text of the 3rd field (including the curly-brace substitutes) must be enclosed with small quotes: ` and ' ` open small-quote ' closed small-quote If the option is a call to a submenu, there isn't anything inside these quotes. The third field simply appears as a: `' Valid texts for this field would be: `' <----- calls a submenu `^([Menu_Cmd chg_video]Change^)' `^([message][menu_cmd area_change]Message^)' `^([Quote])' Finally, when a line is composed in OUTLINE.POP, the three fields must be merged together to form a continuous line, and placed flush up against the left margin. For example: +------> | Change Video Mode`^([Menu_Cmd chg_video]Change^)' | Change Message Area`^([message][menu_cmd area_change]Message^)' | See Quote`^([Quote])' | +-----> \ left margin Additional Notes: * The outline file must contain one blank line after the last option. * Each line in the outline file may contain short comments to the right of the 3rd field. They will be ignored during the compiling stage. * Within limits, multiple Mecca tokens may be included in one option. However, they must appear back-to-back, and the composite third field must be enclosed with one pair of small quotes. Also, they must occupy one line only. Multiple commands will execute in the sequence in which they appear in the third field. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒TN▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ∙Using the Arrow-Keys∙ You can use the arrow-keys to select options from the menu bar or the pop-down menus, by hitting the appropriate arrow-key (next to the numeric keypad on your computer) Pop-down: moves selector up UPA Menu bar, Offline: clears screen | Online, 1st press: redraws menu bar | 2nd press: clears screen | LFA<------------+------------>RTA Menu bar: moves selector left | Pop-down: moves back 1 menu | menu bar: moves selector to right | pop-down: selects option | v DNA Menu bar: selects option pop-down: moves selector down ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒TO▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ SYSOP LOGINS If you login locally, you will see a blue menu bar at the top of the screen. Most menus will be represented by an option on this bar. You can move around the menus with your arrow-keys (located next to the shift-key on 101-style keyboards), or use the three mouse buttons to move. UP-ARROW will redraw the menu bar. DOWN-ARROW will select the option hilighted in red and yellow. RIGHT-ARROW will move the selctor bar right LEFT-ARROW will move the selector bar left If you select an option, (DOWN-ARROW) a pop-down panel will display containing the menu options for that menu. At this point: UP-ARROW will move the selector bar up an option DOWN-ARROW will move the selector bar down an option RIGHT-ARROW will select an option LEFT-ARROW will revert to the last menu, (or the menu bar) SYSOP SCREEN ```````````` Either locally, or while online, there is a sysop menu you will be able to access, by pressing the F1 or escape and F1 while someone,is online. It contains eight commands: X eXit to max menus S Sysop menu control (disables user) U User menu control (disables sysop) H Hangup N Compile new outline file E Edit outline file D Read POPMAX Docs Q Halt Macro ---------------------- X - Exit to max Menus ---------------------- This will return you to the regular Maximus menus. ------------------------------------- S - Sysop menu control (disable user) ------------------------------------- This will remove the ability of the user to ontrol the menus while online. You may select options for the user after this is pressed. ----------------------------------- U User menu control (disbles sysop) ----------------------------------- This will allow you to return control back to the user while online. Pressing this key in local mode prints a lot of junk to the screen. -------- H Hangup -------- This will hangup on the user. -------------------------- N Compile new outline file -------------------------- This will compile a new outline file into a data file. The outline file contains the menu options, and is fully configurable. ------------------- E Edit outline file ------------------- This will allow you to edit the outline file that contains the options for the various menus. ----------------------- D Read POPMAX Documents ----------------------- This will bring up this doscument online. ------------ Q Halt Macro ------------ In case of an emergency, you may halt macro this way. ---------- ESCAPE KEY ---------- The escape key will restore the normal macro operation, and is used used to get out of the sysop menu. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒END▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒