AmendHub

--- GUIDE Mon Nov 27 20:01:11 2023 +++ GUIDE Tue Nov 28 13:02:46 2023 @@ -33,12 +33,13 @@ Most of the administration is done through the BBS its a sysop and accessing the sysop menu. BBS settings, file areas, message boards, and user accounts can all be modified through this menu. -Editing views must be done from console, as it is easier to work in large -blocks of text in a Mac window than through telnet. +Editing view tepmlates is done by editing plaintext files in the "views" +directory created where the BBS database lives. When first run, Subtext will ask to open an existing BBS database. Clicking Cancel will prompt to save a new database. On subsequent runs, Subtext -will automatically try to open the last database that it successfully opened. +will automatically try to open the last database that it successfully opened +unless the Command key is held down at startup. When creating a new database, Subtext will create a default sysop user with the username "sysop" and password "p4ssw0rd". It will also fill in @@ -52,28 +53,33 @@ Sysop menu, and then S will enter the BBS Settings men To enable dialin access, change the Modem Port setting to 1 for the modem port or 2 for the printer port depending on where the modem is connected. An appropriate Modem Init String can also be configured, though it should -*not* be configured for Auto-Answer. +*not* be configured for Auto-Answer. The number of rings after which an +"ATA" is issued can be configured in the settings menu. To enable Telnet access, set the Telnet Port to anything other than 0, such as the standard telnet port of 23. Enabling Telnet requires MacTCP to be -installed. +installed and configured. View Templates ================================================================== -In the BBS -> Views menu, each view used in the BBS can be edited: +In the "views" directory automatically created where the BBS database +lives are a number of text files that are used throughout the BBS: - - Pre-Login (Issue) - - Main Menu - - Short Menu (shown after user has seen main menu) - - Account Signup - - No Free Nodes - - Session Signoff + - issue.txt: Pre-login welcome screen ("issue" file) + - menu.txt: Main menu + - menu_options.txt: Menu commands, see Main Menu Configuration below + - no_free_nodes.txt: "No Free Nodes" message shown through telnet + - page_sysop.txt: Text shown before paging the sysop + - short_menu.txt: Short menu shown after user has seen the main menu + - signoff.txt: Session signoff + - signup.txt: Account signup text +After editing view text files, they must be reloaded through the BBS's +console menu option, or through the sysop menu when logged in. + Views support expansion of variables, which are put inside {{ and }} -characters, such as "You are connected to {{node}}." +characters, such as "You are connected to {{node}}." Supported variables: -Supported variables: - - {{B}} Enable bold attribute if the user's terminal supports ANSI (otherwise it prints nothing). @@ -129,10 +135,10 @@ Or when printing mail for the user: Main Menu Configuration ================================================================== In addition to creating a custom menu layout, it may be desirable to change -the mapping of keys to functions. This can be done through Edit Menu -Options. The mapping is one action per line, with the Action, Menu Key, -All Keys list, and Label, separated by a colon. Blank lines and those starting -with # are ignored. +the mapping of keys to functions. This can be done by editing the +menu_options.txt file and then reloading it through the BBS. The mapping is +one action per line, with the Action, Menu Key, All Keys list, and Label, +separated by a colon. Blank lines and those starting with # are ignored. When there is no custom Main Menu view defined, a list of options will be programmatically generated by showing all menu options with a Menu Key