Help and text: Difference between revisions

From Color 64 BBS Wiki
← Older edit
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
[[installation|Installation]] - <strong>Help & Text Files</strong>
[[installation|Installation]] - <strong>Help & Text Files</strong>


A full set of help files are included with your Color 64 package, but no text files. The Help Files and Text Files work the same, so use the Help Files as a guide when setting up your text files. There needs to be a file in the Help Files disk called "@help files". Notice that instead of having a check mark as the first character of the filename, it has an “@” symbol.  This symbol will prevent the file from showing up in the download directory, but still allow your remote SYSOPs to download, scratch and re-upload these files as necessary. As a matter of fact, anyone can download these help files (you will just have to tell them how). This is an easy way for your callers to download them if their terminal program does not support an ASCII file capture.  
A complete set of Help Files is included with the Color 64 package, but no Text Files are provided by default. Help Files and Text Files function identically, so the included Help Files serve as a model when creating your own Text Files.
 
There must be a file on the Help Files disk called "@help files". Notice that this filename begins with an “@” symbol instead of the check mark (√). The “@” prevents the file from appearing in download directories, while still allowing remote SYSOPs to download, scratch, or re-upload it as needed. In practice, any user can download these help files if you provide instructions. This is particularly useful for callers whose terminal software does not support ASCII capture.


[[File:helpfile.png|center|200px]]
[[File:helpfile.png|center|200px]]


Both the Help and Text files are optional features for your BBS. I recommend you have at least the HELP files available for new users to the BBS scene.
Both Help Files and Text Files are optional features. However, it is strongly recommended that at least the Help Files be available, especially for users new to the BBS scene.
 
The "@help files" file acts as a menu. When displayed, it should instruct callers which number to enter to read a specific help file. The format of this menu is entirely up to you. It may be simple text or full graphics, and the numbering does not need to be sequential if you prefer a custom layout.
 
Each help file on disk must follow this naming convention:


The "@help files" file is a menu file that when read should tell your callers what number to enter to read the desired file.  This menu file can be in any format you want, even use graphics if desired and you can use any number of numbers in any order you want. Each help file on disk should have the filename format of "@help1", "@help2", "@help3", etc. When your caller enters "1", they will read "@help1".
@help1  
@help2
@help3   


[[File:helpfilelisting.png|center|200px]]
[[File:helpfilelisting.png|center|200px]]
When a caller enters “1”, the BBS will load and display "@help1".
Text Files operate in the same way, except the menu file must be named "@text files", and the individual files follow this format:
@text1 
@text2 
@text3 
If the "@text files" menu file does not exist, callers selecting Text Files will see a message stating that none are available. The same behavior applies if "@help files" is missing.
There is no internal limit to the number of Help or Text files you may create beyond available disk space. If you anticipate exceeding the standard BBS message line limits, use the stand-alone message editor (+EDITOR), which allows messages up to approximately 500 lines.
Be creative when designing Text Files. They can help define the personality of your BBS. Examples might include current news, Color 64 BBS lists, recipes, movie reviews, technical notes, or hobby content relevant to your audience.


Text files work the same only you use "@text files" to describe “@text1", "@text2", etc.  If the "@text files" file is not on the disk when a caller asks for the text files, he will see a message saying that there are not any text files online.  Same goes for the "@help files" file.  There is not any limit to the maximum number of help files or text files allowed other than the amount of free space on your disk drive. If you think you will need more than the BBS-limited number of message lines to support your text file, then use the stand-alone message editor (+EDITOR) which permits up to 500 lines. Be creative in what you want to have as text files. This can help support the uniqueness of your BBS. For my system, I scour the internet for the latest news and Color 64 BBS Lists and populate those into several different text files. You could do something like recipes, latest movie reviews, trends, etc.  
After editing your system messages, use a file copier to copy all sample Help Files to the drive designated in the SETUP Drive Assignments section. Then use the Message Editor to read and, if desired, modify each file. These Help Files serve as both documentation for your users and a guide to understanding the system’s features.


After editing all the system messages, you should use a file copier to copy all the sample help files onto the disk you assigned on the drive assignments screen of SETUP.  Then use MSG EDITOR to read (and if necessary, edit) each of these help files.  They will tell you and all your new users how to use this BBS to its fullest.
Next Section: [[email notification|Email Notification Option]]


[[installation|Installation]]
[[installation|Installation]]

Latest revision as of 04:35, 16 February 2026

Installation - Help & Text Files

A complete set of Help Files is included with the Color 64 package, but no Text Files are provided by default. Help Files and Text Files function identically, so the included Help Files serve as a model when creating your own Text Files.

There must be a file on the Help Files disk called "@help files". Notice that this filename begins with an “@” symbol instead of the check mark (√). The “@” prevents the file from appearing in download directories, while still allowing remote SYSOPs to download, scratch, or re-upload it as needed. In practice, any user can download these help files if you provide instructions. This is particularly useful for callers whose terminal software does not support ASCII capture.

Both Help Files and Text Files are optional features. However, it is strongly recommended that at least the Help Files be available, especially for users new to the BBS scene.

The "@help files" file acts as a menu. When displayed, it should instruct callers which number to enter to read a specific help file. The format of this menu is entirely up to you. It may be simple text or full graphics, and the numbering does not need to be sequential if you prefer a custom layout.

Each help file on disk must follow this naming convention:

@help1 @help2 @help3

When a caller enters “1”, the BBS will load and display "@help1".

Text Files operate in the same way, except the menu file must be named "@text files", and the individual files follow this format:

@text1 @text2 @text3

If the "@text files" menu file does not exist, callers selecting Text Files will see a message stating that none are available. The same behavior applies if "@help files" is missing.

There is no internal limit to the number of Help or Text files you may create beyond available disk space. If you anticipate exceeding the standard BBS message line limits, use the stand-alone message editor (+EDITOR), which allows messages up to approximately 500 lines.

Be creative when designing Text Files. They can help define the personality of your BBS. Examples might include current news, Color 64 BBS lists, recipes, movie reviews, technical notes, or hobby content relevant to your audience.

After editing your system messages, use a file copier to copy all sample Help Files to the drive designated in the SETUP Drive Assignments section. Then use the Message Editor to read and, if desired, modify each file. These Help Files serve as both documentation for your users and a guide to understanding the system’s features.

Next Section: Email Notification Option

Installation

Retrieved from "https://www.color64wiki.itchybutt.org/index.php?title=Help_and_text&oldid=753"