menus
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
menus [2019/03/24 21:19] – [Table] g00r00 | menus [2019/03/24 21:24] (current) – [MENU SYSTEM] g00r00 | ||
---|---|---|---|
Line 4: | Line 4: | ||
| [[themes|Themes]] | | [[themes|Themes]] | ||
| [[menu_commands|Menu Command Reference]] | | [[menu_commands|Menu Command Reference]] | ||
+ | |||
+ | ----- | ||
+ | ===== ANATOMY OF A MENU ===== | ||
+ | |||
+ | The BBS menus are the core of the BBS system. | ||
+ | commands and functions available to the user are defined and setup. | ||
+ | Mystic BBS supports an unlimited number of defined menus which can | ||
+ | be setup in any way, allowing a totally customizable and unique | ||
+ | interface for the user. | ||
+ | |||
+ | Each menu consists of a Settings page where general options are | ||
+ | defined for the menu, along with an command/ | ||
+ | that appear on the menu are defined. | ||
+ | "menu commands" | ||
+ | the option is selected by the user. In order words, a menu option | ||
+ | defines the option that is presented to the user and the menu command(s) | ||
+ | configured inside of the option define what the BBS actually does when | ||
+ | the option is executed. | ||
+ | |||
+ | Menus can be configured to automatically generate a menu of options for | ||
+ | the user based on the options configured, or the internally generated menu | ||
+ | can be replaced by a display file (in the Settings page). | ||
+ | |||
+ | There are many more advanced techniques such as automatic execution | ||
+ | of menu options based on specific criteria or time-based intervals, | ||
+ | or menu option chaining and branching that will be discussed in their | ||
+ | own sections. | ||
+ | |||
+ | In addition to the standard type of menu, there are also Lightbar, Grid, | ||
+ | and Prompt menu styles which build off of the standard menu system. | ||
+ | types of menus will also be covered in more detail in their own sections. | ||
+ | |||
+ | ----- | ||
+ | ===== MENU EDITOR OVERVIEW ===== | ||
+ | |||
+ | When first entering the menu editor, you will be prompted to select | ||
+ | which theme definition you'd like to edit. It is possible to have | ||
+ | different sets of menus for each theme! | ||
+ | |||
+ | After you've selected the theme you'd like to edit, you will be | ||
+ | shown the main menu selection screen below. | ||
+ | you wish to search for an item just start typing the text you wish | ||
+ | to search for. | ||
+ | |||
+ | < | ||
+ | |||
+ | | ||
+ | █ Menu Name | ||
+ | █ ───────────────────────────────────────────────────── █ | ||
+ | █ account | ||
+ | █ autosig | ||
+ | █ bbslist | ||
+ | █ demos Demos of various things | ||
+ | █ doors | ||
+ | █ file File base menu ░ | ||
+ | █ flist | ||
+ | █ fnewscan | ||
+ | █ fqueue | ||
+ | █ goodbye | ||
+ | █ ───────────────────────────────────────────────────── █ | ||
+ | | ||
+ | | ||
+ | </ | ||
+ | |||
+ | *Select Slash (⁄) to see the Insert, Delete or Copy individual menus | ||
+ | *Highlight any menu and hit ENTER to modify it. | ||
+ | |||
+ | === Command List === | ||
+ | |||
+ | When a menu is first opened for editing, the default view is the list | ||
+ | of options defined in the menu. This view is presented first because | ||
+ | it is the most widely used, but each menu also has a Settings page as | ||
+ | well that can be accessed from the command list by typing / | ||
+ | |||
+ | < | ||
+ | █▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ Options list (account) ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▄ | ||
+ | █ HotKey | ||
+ | █ ──────────────────────────────────────────────────────────── █ | ||
+ | █ A (A) Address | ||
+ | █ B (B) City/ | ||
+ | █ C (C) Zip Code | ||
+ | █ D (D) Home Phone | ||
+ | █ E (E) Data Phone | ||
+ | █ F (F) E-mail Address | ||
+ | █ G (G) Password | ||
+ | █ H (H) Screen Length | ||
+ | █ I (I) Graphics Mode -> | ||
+ | █ J (J) Date Format | ||
+ | █ ──────────────────────────────────────────────────────────── █ | ||
+ | █ Press / for command list █ | ||
+ | ▀▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄█ | ||
+ | </ | ||
+ | * Highlight and hit ENTER to select a command | ||
+ | * Use the slash (⁄) key to see a menu of more options. | ||
+ | |||
+ | < | ||
+ | █▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▄ | ||
+ | █ S Settings | ||
+ | █ I Insert | ||
+ | █ D Delete | ||
+ | █ C Copy █ | ||
+ | █ P Paste █ | ||
+ | █ V View █ | ||
+ | ▀▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄█ | ||
+ | </ | ||
+ | |||
+ | * **Insert** | ||
+ | * **Delete** | ||
+ | * **Copy** | ||
+ | * **Paste** | ||
+ | * **View** | ||
+ | * **Settings** - Adjust the settings of the menu | ||
+ | |||
+ | === Menu settings === | ||
+ | The Menu Settings page will allow for the adjustment of many different features of the menu. | ||
+ | |||
+ | < | ||
+ | █▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ Menu Settings (account) ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▄ | ||
+ | █ █ | ||
+ | █ Description | ||
+ | █ Access | ||
+ | █ Fallback | ||
+ | █ Menu Type │ Standard | ||
+ | █ Input Type │ User Defined | ||
+ | █ Input Chars │ Uppercase | ||
+ | █ Use Global | ||
+ | █ Node Status | ||
+ | █ Display File │ █ | ||
+ | █ Display Cols │ 1 █ | ||
+ | █ Menu Header | ||
+ | █ Menu Prompt | ||
+ | █ X │ 0 █ | ||
+ | █ Y │ 0 █ | ||
+ | ▀▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄█ | ||
+ | </ | ||
+ | |||
+ | * **Description** - Set the description of the Menu as seen in the Menu List. | ||
+ | |||
+ | * **Access** | ||
+ | |||
+ | * **Fallback** | ||
+ | |||
+ | * **Menu Type** | ||
+ | |||
+ | * **Input Type** | ||
+ | |||
+ | * **Input Chars** - This defines how user input is visually represented on the menu. If set to Uppercase, then the user input will be displayed as uppercase. | ||
+ | |||
+ | * **Use Global** | ||
+ | |||
+ | * **Node Status** - Sets the text that will be displayed for the user's " | ||
+ | |||
+ | * **Display File** - When left blank, Mystic will automatically generate a menu based on the configured menu options and the user's access to them. However, a menu can be replaced by defining the base filename (the filename without the .asc or .ans extension) to be loaded from the Theme' | ||
+ | |||
+ | * **Display Cols** - Sets the number of columns Mystic will use to format the menu options when generating a menu. Valid options are 1-9, or H for Hidden. | ||
+ | |||
+ | * **Menu Header** - Defines the header to be displayed before the list of generated menu commands. | ||
+ | |||
+ | * **Menu Prompt** - Defines the prompt to be displayed after the menu is displayed. | ||
+ | |||
+ | * **X, Y** - The X and Y positions to park the cursor after the menu has been drawn on the screen. | ||
+ | === Menu Types === | ||
+ | ^Type^Description^ | ||
+ | |Standard|Uses the standard displayed menu| | ||
+ | |Lightbar|The LightBar High and LightBar Low text can be placed anywhere on the screen| | ||
+ | |Lightbar/ | ||
+ | |Lightbar/ | ||
+ | |||
+ | === Option Editor === | ||
+ | The Option Editor is used for editing the individual menu options. | ||
+ | < | ||
+ | █▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ Option | ||
+ | █ Display Text │ █ | ||
+ | █ LightBar Low │ █ | ||
+ | █ LightBar High │ █ | ||
+ | █ Hot Key │ Q █ | ||
+ | █ Access | ||
+ | █ Display Type │ Access | ||
+ | █ X Y │ 0 0 | ||
+ | █ Timer │ 0 Right │ 0 | ||
+ | █ Timer Type │ Interval | ||
+ | █ Command ────────────────── Access ───── Data ───────────────────────────── | ||
+ | █ (GO) Go to new menu | ||
+ | █ ░ | ||
+ | █ ░ | ||
+ | █ ░ | ||
+ | █ █ | ||
+ | ▀▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄ (TAB) to edit menu commands ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄█ | ||
+ | </ | ||
+ | |||
+ | * **Display Text** - The text that is displayed in the Command List window list. | ||
+ | |||
+ | * **Lightbar Low** - The text that is displayed when this lightbar menu option is cold (deselected). | ||
+ | |||
+ | * **Lightbar High** - The text that is displayed when this lightbar menu option is hot (selected). | ||
+ | |||
+ | * **Hot Key** - The key(s) that the user must enter in otder to activate this command. | ||
+ | |||
+ | * **Access** - Define the ACS string required for this menu option to be executable by the user | ||
+ | |||
+ | * **X, Y** - The X,Y location for the Lightbar Low and and Lightbar High text | ||
+ | |||
+ | * **Timer** - Sets the number of seconds to activate the Timer-based execution or 0 to disable a time-based execution of this menu command. | ||
+ | |||
+ | * **Timer Type** - Sets the type of time-based execution. | ||
+ | |||
+ | * **Redraw** - If set to TRUE the menu will be redrawn after this menu selection is executed. | ||
+ | |||
+ | * **Up, Down, Left, Right, Home, Escape, Tab, PageUp, PageDn, End** - These are used only by Grid style menus and each one defines which menu command ID to switch to when the user presses the key with this command highlighted. | ||
+ | This allows very intricate configuration of menu selection behavior at the expense of complexity. | ||
+ | |||
+ | Each option can perform several sub-tasks in a series when the option is selected and these tasks are defined by creating a menu command or a list of menu commands within the option. | ||
+ | |||
+ | === Menu Command Editor === | ||
+ | |||
+ | Many menu commands can be defined to be executed by a single menu option. | ||
+ | |||
+ | A list of menu commands can be found in the [[menu_commands|Menu Command Reference]] | ||
< | < | ||
Line 20: | Line 238: | ||
* **Access** - The access string (ACS) that the user must meet in order to execute this menu command. | * **Access** - The access string (ACS) that the user must meet in order to execute this menu command. | ||
* **Execute** - Used only for Grid style menus. | * **Execute** - Used only for Grid style menus. | ||
+ | |||
----- | ----- | ||
===== CREATING STANDARD MENU ===== | ===== CREATING STANDARD MENU ===== |
menus.1553480357.txt.gz · Last modified: 2019/03/24 21:19 by g00r00