home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / mag7demo.zip / HLP_DIR.ZIP / MSGHELP.BBS < prev    next >
File List  |  1993-09-01  |  23KB  |  437 lines

  1. @A12 @c18
  2. NOTE: This help file also serves as an example of a regular ASCII text
  3.       file that you, as SYSOP of a Magnum BBS can create. Although a
  4.       regular ASCII text file, created with any text editor, it can
  5.       offer sophisticated menus, customization, and multitudes of other
  6.       things limited only by your imagination.
  7.  
  8. @P0 @C8
  9.  
  10.                  @A14 Gilmore Systems MESSAGE HELP @A13
  11.  
  12.         [G] - General Explanation of Commands
  13.         [R] - Reading Messages Explained (and how to reply)
  14.         [C] - Message Conferences Explained (and changing conference area)
  15.         [E] - Entering Messages
  16.         [M] - MILC - "MAGNUM Interpreted Language Commands" for your messages!
  17.         [Q] - Quit Help
  18.  
  19.         Enter Choice (G,R,C,E,M,Q) => @Z0('GRCEMQ');
  20.         @B1(z0="G"); @B2(z0="R"); @B3(z0="C"); @B4(z0="E"); @B5(z0="M"); @C16
  21. @P1  @C8 @A14 Gilmore Systems General Explanation of Message Commands @A10
  22.  
  23. [Q] - Quits Message section and returns back to Main Menu
  24.  
  25. [R] - Read Messages (requires a default conference area to be chosen).
  26.       This option takes you to a submenu where there are several different
  27.       ways of reading messages. See@a13 [R] - Reading Messages Explained@a10
  28.  
  29. [E] - Enter a message. This menu selection allows you to enter any kind
  30.       of message with the online message editor. The message can be public,
  31.       private (if allowed), to ALL or to SYSOP. If your message is addressed
  32.       to ALL, then any user with access to the conference area you enter the
  33.       message in can read the message.
  34.  
  35. [T] - Text Search. All messages are required to have one line of text which
  36.       describe the nature of the message - this description is called the
  37.       message SUBJECT. When you specify a Text Search, whatever you type
  38.       as your search criteria (ie: Communications) will start MAGNUM BBS
  39.       on a search of all message SUBJECTs which contain your search word(s).
  40.       The less you type (parts of a word rather than whole words), the more
  41.       matches will be found. For instance, both "Com" and "cat" are part of
  42.       the word "Communications", so all SUBJECTs containing "Com" and "cat"
  43.       anywhere in the description will be matched and displayed - also note
  44.       that message subjects such as "Catalog Programs" or "Compilers" will
  45.       also be matched. To narrow down your match, user longer words such
  46.       as "Communic". Also note that upper and lowercase are not important -
  47.       MAGNUM BBS internally converts everything to uppercase before actually
  48.       performing the search. Therefore, "Cat" and "cAt" are identical.
  49.  
  50. [G] - Goodbye - disconnect from the BBS (hang up).
  51.  
  52. [C] - Change Message Area. To Read Messages requires a "default" message
  53.       conference area. There are up to 26 areas (not all of which are
  54.       necessarily used, nor are all sections used available at your
  55.       security level). If you first select [R]ead Messages, you will be
  56.       asked for a default conference. You will remain at that default
  57.       conference until you choose [C] to change the conference area.
  58.       Selecting [C] will show which conference areas are available to you.
  59.       Conference areas range from A-Z, but note that there is a conference
  60.       labeled 0 (zero), which means you are choosing "All conferences" as
  61.       your default area - this will make all conferences which you are
  62.       authorized to read available to you.@A12 NOTE: MAGNUM BBS allows the
  63.       SYSOP to restrict ANY conference area to any user as "read-only",
  64.       "write-only", or "list-only", or any combination of the three.
  65.       "Read-only" means you can only "read" but not write to that conference
  66.       area. "Write only" means you can only "write" to (but not read from)
  67.       that area (as is the case with "Comments to Sysop"), and "List-only"
  68.       means the conference will only appear in the conference list but you
  69.       will not be able to choose that conference as a default.@a10
  70.  
  71. [S] - Scan Messages. This function allows you to enter a DATE to start
  72.       scanning from. Only the message 'headers' but not the actual messages
  73.       will be shown. If during the scan you find a message subject which
  74.       looks interesting to you, you can jot down the message REF# and
  75.       select [R]ead with the [R]ef# submenu choice.
  76.  
  77. [D] - Delete a Message (if available - depends on Sysop) allows you to
  78.       delete any message that YOU entered. You need only supply the REF#.
  79.  
  80. [P] - Personal Mail Check. This option allows you to scan for all mail
  81.       addressed to you since the last message you read which was addressed
  82.       to you. It is identical to the "Check Your Mailbox?" prompt when you
  83.       first log on.
  84.  
  85. [?] - Presents this help screen.
  86.  
  87.  
  88. @C9 @B0(0=0);
  89. @P2   @C8 @A14      READING MESSAGES (and how to reply) @A10
  90.  
  91. To Read Messages is very simple. Simply select [R] from the message menu.
  92. You are required to pick a default message conference (A-Z or 0 for ALL
  93. conferences combined). If this is the first time you choose [R] this
  94. session, you will be presented a list of conferences available to you, and
  95. asked to pick one. If you wish to change to another conference later, simply
  96. pick the [C]hange option from the message menu.
  97.  
  98. The [R]ead option will present the following submenu:
  99.  
  100.        B = Backwards Read (newest first)
  101.        D = Date to start from
  102.        M = Match Text
  103.        R = by Reference #
  104.        S = Since Last Read
  105.        U = To/From User (or to/from you)
  106.        V = View my unread mail
  107.        Q = Quit
  108.  
  109. Choosing "B" will start with the latest (newest) messages and go backward
  110. from there - all other choices default to forward. Choosing "D" will prompt
  111. you for a specific date to read from - this only works in a forward fashion.
  112. Choosing "M" will prompt you for text to match up with the SUBJect field of
  113. the message headers. Choosing "R" will prompt you for a specific Reference #
  114. to read (messages do not have regular numbers). Choosing "S" will display
  115. all messages since the last message you've read (for your current
  116. conference). Choosing "U" will display all messages TO or FROM the User ID
  117. you supply. Choosing "V" will display all message TO YOU which you have
  118. not yet read.
  119.  
  120. When reading messages, all messages are preceeded by a message "header".
  121. This header will look similar to the following:
  122.  
  123.    @a10 CONF: @a11 A@a15 General Mail
  124.    @a10 SUBJ: @a15 WELCOME!
  125.    @a10 FROM: @a15 /0 (CHUCK B GILMORE)
  126.    @a10   TO: @a15 ALL
  127.    @a10 DATE: @a15 06/27/1989 @a10 TIME: @a15 12:30
  128.    @a10 TIMES READ: @a15 40 @a10 REF # @a15 A61B0901D38
  129. @a10
  130. This is a general message header showing which CONFerence the message is
  131. assigned to, the SUBJect nature, who the message is FROM, who it is TO, the
  132. DATE and TIME the message was entered, how many TIMES READ, and the
  133. message's REF #. There may also be one additional line following the header
  134. which will indicate if the message is <PRIVATE>, <CC> or <FWD>. If the
  135. message is <PRIVATE>, it means the message is either addressed TO or FROM
  136. you. If a <CC> exists, the message was originally sent to someone else with
  137. a Carbon Copy to you. If <FWD> is present, then that means someone who read
  138. a message which was addressed to them had FORWARDED a copy of the message to
  139. you! Also note that if the above message was addressed to an individual
  140. instead of ALL, there would be an additional field stating that the message
  141. was RECEIVED if the addressee has read (received) the message, showing date
  142. and time of receipt. If the message has an EXPIRATION DATE associated with
  143. it, that date will be displayed as part of the header as well.
  144.  
  145. After the message header appears, the body (or text) of the message follows.
  146. When the message ends, several options are available to you. The options
  147. always available are "[N]ext, [R]eply, [C]ontinuous, [-/+] and [Q]uit".
  148. The "[N]ext" option, merely tells MAGNUM BBS to display the next message.
  149. "[R]eply" tells MAGNUM BBS that you wish to reply to the message with the
  150. same subject. "[C]ontinuous" tells MAGNUM BBS to display all the rest of the
  151. message in a non-stop fashion (ie: you will not be presented with the -More-
  152. prompt). "[-/+]" is to tell MAGNUM BBS which direction to go. The default is
  153. to read messages in chronological order. Pressing '-' instructs MAGNUM BBS
  154. to present messages in reverse chronological order (backwards), whereas '+'
  155. tells MAGNUM BBS to revert back to the forward direction. "[Q]uit" tells
  156. MAGNUM BBS to return back to the "Read Messages" submenu.
  157.  
  158. If there are replies to the current message, a "[T]hread" option will
  159. appear. Choosing "[T]hread" means you wish to skip all messages not dealing
  160. with the current SUBJect and only wish to see the next message on the same
  161. subject (the reply). If the current message is a response to another message
  162. of the same SUBJect, an "[O]rigin" option will appear. If you choose the
  163. "[O]rigin" option, MBBS will search for the first message dealing with the
  164. current SUBJect and display that message. If the current message is a reply
  165. within a thread, "[B]ackthread" should also appear - this will take you to
  166. the previous message in the thread.
  167.  
  168. If the message is addressed either TO or FROM you, then the "[K]ill" option
  169. will be displayed IF the Sysop allows you the capability of deleting
  170. messages. Also, if the "[E]dit" option appears, you may edit (revise) the
  171. message - this option will appear if the message is addressed to or from
  172. you.
  173.  
  174. If the message is addressed to you, the "[F]orward" option will appear. If
  175. you think you'd like someone else to have a look at the message, you may
  176. choose the "[F]orward" option and "forward" (send) a copy of that message to
  177. them.
  178.  
  179. NOTE that messages do NOT have traditional numbering schemes which start at
  180. 1 and ascend. These numbering schemes have been found to be confusing on
  181. other BBS's for 3 reasons: 1) numbers assigned are unpredictable as to
  182. which conference any message number belongs to, 2) private messages cannot
  183. be viewed by the public and are therefore skipped, and 3) when other BBS's
  184. "pack" or "clean-up" their messages, the messages are frequently re-numbered
  185. adding yet more to the confusion. Instead, MAGNUM BBS uses a Reference
  186. number (REF #) consisting of 11 characters - the first character is always
  187. the letter of the conference the message is in. The rest of the characters
  188. are merely a unique sequence of characters that can never be duplicated by
  189. any other message - the REF # is always assigned by MAGNUM BBS. To redisplay
  190. a message, or to view a message after doing a [S]can, simply jot down the
  191. REF # and do a [R]ead by Reference #.
  192.  
  193. @c9 @B0(0=0);
  194. @P3   @C8 @A14 Message Conferences Explained (and how to change areas) @A10
  195.  
  196. All functions require you to be in a default (preselected) message
  197. conference. There are up to 26 conferences (labeled A-Z). You may not have
  198. access to all the areas, and all areas may or may not be used (depending on
  199. how the SYSOP configured the system). There is an additional default
  200. conference, conference 0 (zero), which tells MBBS you don't want to be
  201. limited to just one conference at a time - you want them all at once. Keep
  202. in mind that viewing all conferences at once can get a little confusing -
  203. it's best to stick with a single conference at a time. To change to a
  204. different conference area, simply use the "[C]hange" option from the message
  205. menu.
  206.  
  207. @c9 @B0(0=0);
  208. @P4   @C8           @A14 Entering Messages @A10
  209.  
  210. There are two built-in text (message) editors: Line-oriented and ANSI.
  211. If you're using a communications package capable of ANSI terminal emulation
  212. you can use the ANSI editor - you don't have to have your color settings on
  213. in order to use this editor (color escape sequences simply won't be sent if
  214. your color setting is 'off' but all other ANSI sequences will be sent).
  215.  
  216. If you're using the ANSI text editor, help is online and on your screen at
  217. all times during message entry, therefore, no explanation of its use will be
  218. presented here. There is, however, one feature in the ANSI editor not found
  219. in the line-editor: if you're replying to a message, the ANSI editor will
  220. let you re-read the message you're replying to.
  221.  
  222. The remainder of this help panel will discuss the line-editor:
  223.  
  224. The line-oriented text editor features automatic word-wrap. This means that
  225. anytime the current line you're typing reaches the end of the line, it will
  226. move the last word to the beginning of the next line automatically if the
  227. word will not fit on the current line. This means you needn't press your CR
  228. or ENTER key unless you wish to start a new sentence or paragraph. The same
  229. feature is built into the ANSI editor.
  230.  
  231. You may enter up to 150 lines of text. Unlike other BBS's, entering a blank
  232. line with the line-editor does just that - other BBS's end your message when
  233. you enter a blank line. To end typing your message, enter "/EXIT" (without
  234. the quotes) on a line by itself beginning in the first column of the line.
  235.  
  236. To start entering a message, choose the "[E]nter" option from the message
  237. menu. If you do not have a default conference selected, you will be prompted
  238. as to which conference you'd like the message to go into. Next, you will be
  239. asked who the message is to be addressed to. If you type "ALL" (without the
  240. quotes), the message will not be directed to anyone in particular but anyone
  241. with access to that conference can read and/or reply to that message. If you
  242. choose to send it to someone in particular, enter that user's ID# - if you
  243. do not know their ID#, merely enter a "?" and you will be presented with a
  244. userlist search prompt - if you find that the user's ID# is 10 for example,
  245. you would then address the message to "/10" (without quotes). If you want
  246. the message to go to the SYSOP, you may either type "SYSOP" or "/0" (without
  247. quotes) - the SYSOP's ID# is always "/0".
  248.  
  249. If the message is not addressed to ALL, you will be prompted as to whether
  250. you want this to be a PRIVATE or a PUBLIC message (PRIVATE means that ONLY
  251. the addressee and YOU can read the message).
  252.  
  253. You will then be asked to type a line of text describing the SUBJect nature
  254. of the message. Try to make this as definitive as possible.
  255.  
  256. You will then be asked for an EXPIRATION DATE. The expiration date is
  257. optional and if you do not enter one, there will be no expiration date.
  258. Please try to make use of the expiration date feature - especially if you're
  259. announcing something that is time-sensitive. For example, you wouldn't want
  260. to post a message stating that the "next user-group meeting is 8/1/89" and
  261. have the message still show up after that date - same thing with announcing
  262. a special price on a product good through a certain date. Regardless,
  263. general messages do get old, and if the message is that important that it
  264. needs to be posted forever, then don't enter an expiration date.
  265.  
  266. If the message is not addressed to ALL, you will be asked if you want a
  267. RECEIPT for the message. If you select "Y" (yes), MAGNUM BBS will write a
  268. message to you and drop it in your mailbox stating that the addressee of the
  269. message has received (read) the message you are about to create.
  270.  
  271. You will now be placed in the text editor. Merely type like you would on a
  272. typewriter. The Backspace key on your keyboard will move back to the
  273. previous character (erasing it as it goes back) to allow you to correct any
  274. mistakes. You may press the backspace key as long as there are characters to
  275. the left of the current cursor postion. The TAB key will move the cursor to
  276. the next tabstop position (tabstops are preset at 8, 16, 24, etc to the end
  277. of the line).
  278.  
  279. When you are all done with your message, enter the word "/EXIT" (without
  280. quotes) on a line by itself. If you'd like the more traditional way of ending
  281. a message with a null line (2 successive presses of your ENTER key), you may
  282. choose the [E]nvironment option from the main menu to tell Magnum that you'd
  283. like to end your messages with a null line. A submenu will now display:
  284.  
  285.      Edit Commands: [S]ave, [T]ype, [D]elete, [I]nsert, [C]ontinue,
  286.                     [A]bort, [E]dit line, [R]eplace line
  287.  
  288. Choosing [S]ave will save your message and post it on the board. If the
  289. sysop has configured MAGNUM BBS to compensate you for time spent
  290. entering the message, MAGNUM BBS will count the number of words you've
  291. entered in your message, and compensate you with a predetermined amount
  292. of seconds for each word. Half-minutes and above will be rounded to the
  293. next highest minute. Under half-minutes will not be compensated. Only
  294. public messages are compensated. Once again, if the sysop did not choose
  295. time compensation, you will not be compensated for time spent typing.
  296.  
  297. Choosing [T]ype will type all lines of your message for you for review.
  298.  
  299. Choosing [D]elete will prompt you for which line(s) you wish to delete (all
  300. lines have numbers during message entry and during "type"). Keep in mind
  301. that once you delete a line or group of lines, the lines following will be
  302. renumbered - use [T]ype after a [D]elete to see the changes in line number
  303. and confirm the deletion.
  304.  
  305. Choosing [I]nsert will prompt you for a line # which you wish to insert a
  306. new line at. In other words, if you choose line 6, you will be adding a new
  307. line which now becomes line 6, while the previous line 6 becomes line 7,
  308. line 7 becomes 8, etc.
  309.  
  310. Choosing [C]ontinue will put you back into message entry mode at the end of
  311. the last line you typed - you are merely continuing (or appending) from
  312. where you left off.
  313.  
  314. Choosing [A]bort tells MAGNUM BBS that you changed your mind and no longer
  315. wish to enter a message - it will be as though you never entered a message
  316. at all. MAGNUM BBS will first prompt you as to whether you really wish to
  317. abort the message or if you chose abort by mistake.
  318.  
  319. Choosing [E]dit will allow you to change certain characters on a line. For
  320. example, if you mispelled something like "Tuesday night meating", you will
  321. be prompted first for the line number, then for the mispelled word(s) - you
  322. would enter "meating" (without quotes), then you will be prompted for the
  323. right spelling in which case you'd enter "meeting". You could use this
  324. method to insert a word or delete a word as well. For example the line
  325. might contain "Tuesday meeting" and you want to change it to "Tuesday night
  326. meeting". You would supply "Tuesday meeting" for the words to replace, and
  327. "Tuesday night meeting" for the words to replace it with.
  328.  
  329. Choosing [R]eplace will let you replace any line altogether. If you choose
  330. line 6 for example, you will be asked to type in the NEW line 6. What you
  331. type will replace the old line 6.
  332. @a11
  333. @c9 @B0(0=0);
  334. @P5 
  335.     @a14 MILC - "MAGNUM Interpreted Language Commands" for your messages!@a10
  336. @c10
  337. MILC (MAGNUM Interpreted Language Commands) are available for your messages!
  338. There are hundreds of commands in MILC, however, the SYSOP has only given you
  339. access to just a handful of commands. MILC commands are special commands that
  340. you can imbed in your messages to create special effects. All MILC commands
  341. start with the @ character. Following, is the MILC command syntax for only
  342. the MILC command(s) that your sysop has allowed you to use.
  343.  
  344. While you are entering messages, you can safely imbed color commands into
  345. the messages without having to worry about ANSI escape sequences. MAGNUM BBS
  346. incorporates an interpreted language within the messages which allow you to
  347. create@a11 different@a12 colors@a13 throughout@a14 your@a31 messages @a10
  348. without worrying about whether the reader has their color settings turned on
  349. or off. If the reader's color settings are on, great! Otherwise, the
  350. imbedded commands are removed when they read the message. To insert colors,
  351. the command is @c7% @Axxx where 'xxx' is one to three digits (0 to 255)
  352. representing a color. For example, if you entered the following line:
  353.  
  354.          There is @a12 danger @a10 involved in mountain climbing!
  355.  
  356. The reader with their color settings set to ON would see it as:
  357.  
  358.          There is %a12 danger %a10 involved in mountain climbing!
  359.  
  360. If your color setting was set to OFF, you would only see it as a regular
  361. sentence:
  362.  
  363.          There is  danger  involved in mountain climbing.
  364.  
  365. The basic rules are, The @ character starts a command and can appear
  366. anywhere. If it is followed by an 'A' character, it tells MAGNUM BBS that 1
  367. to 3 digits of an attribute (color) code are about to follow. After the last
  368. digit, there must be a blank (space).
  369.  
  370. Below is a color table:
  371. %a11
  372.    @A0 - BLACK on BLACK         @A8  - GRAY on BLACK
  373.    @A1 - BLUE on BLACK          @A9  - hi-intensity BLUE on BLACK
  374.    @A2 - GREEN on BLACK         @A10 - hi-intensity GREEN on BLACK
  375.    @A3 - CYAN on BLACK          @A11 - hi-intensity CYAN on BLACK
  376.    @A4 - RED on BLACK           @A12 - hi-intensity RED on BLACK
  377.    @A5 - MAGENTA on BLACK       @A13 - hi-intensity MAGENTA on BLACK
  378.    @A6 - BROWN on BLACK         @A14 - bright YELLOW on BLACK
  379.    @A7 - WHITE on BLACK         @A15 - hi-intensity WHITE on BLACK
  380.  
  381.  
  382.    @A16  to @A31  - same as @A0 to @A15 but on BLUE background
  383.    @A32  to @A47  - same as @A0 to @A15 but on GREEN background
  384.    @A48  to @A63  - same as @A0 to @A15 but on CYAN background
  385.    @A64  to @A79  - same as @A0 to @A15 but on RED background
  386.    @A80  to @A95  - same as @A0 to @A15 but on MAGENTA background
  387.    @A96  to @A111 - same as @A0 to @A15 but on BROWN background
  388.    @A112 to @A127 - same as @A0 to @A15 but on WHITE background
  389.  
  390.    @A128 to @A255 - same as @A0 to @A127 but blinking
  391.                     (simply add 128 to any of the above for blinking effect)
  392. %a10
  393. In addition to the above, the sysop has chosen the following additional MILC
  394. commands for your use. When any of these commands appear anywhere within your
  395. message, it will be replaced with the proper values:
  396. %a11
  397.          @O0  - Hours (ranges from 0 to 23)
  398.  
  399.          @O1  - Minutes (ranges from 00 to 59)
  400.  
  401.          @O2  - Seconds (ranges from 00 to 59)
  402.  
  403.          @O3  - Hundredths of seconds (ranges from 00 to 99)
  404.  
  405.          @O4  - Day of month (ranges from 00 to 31)
  406.  
  407.          @O5  - Month (ranges from 1 to 12)
  408.  
  409.          @O6  - Year (the current 4-digit year)
  410.  
  411.          @O7  - Day of week (string: "Sunday", "Monday", etc)
  412.  
  413.          @O8  - Month (string: "January", "February", etc)
  414.  
  415.          @O9  - Time (string: "3:57 PM", "12:01 AM", etc)
  416.  
  417.          @O10 - User's age
  418.  
  419.          @O11 - Minutes user has been online this call
  420.  
  421.          @O12 - COM PORT # user is on
  422.  
  423.          @O13 - Total calls received on PORT #
  424.  
  425.          @O14 - Previous caller's name (up to 62 chars)
  426.  
  427.          @O15 - Previous caller's location (up to 62 chars)
  428. %a10
  429. There are many, many other MILC commands which may be imbedded within
  430. messages, but until we figure out just which commands to let users use
  431. in messages, we'll limit them to the color (@Axxx) and optional (@Ox)
  432. commands for now. But later on, we'll give you the capability of
  433. interacting with the reader(s) of your message(s) in a way that you've
  434. never seen on any other BBS before!
  435. %c7@ @c11
  436. @c9 @B0(0=0);
  437.