Synchronet v3.19b-Win32 (install) has been released (Jan-2022).

You can donate to the Synchronet project using PayPal.

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
custom:atcodes [2020/04/30 02:11] – [External Content] Add JS:name digital mancustom:atcodes [2020/05/29 00:15] – [See Also] nelgin
Line 1: Line 1:
-====== @-codes ======+====== Message Variables (@-codes) ======
  
-Synchronet sysop-posted messages, text and menu files, and some lines in the ''[[dir:ctrl]]/[[text.dat]]'' file may contain special variables called //@-codes// ("at codes", some BBS authors and sysops refer to these types of codes as "MCI codes"((and not because of the defunct phone company))). @-codes may also be displayed using the ''bbs.atcode()'' JavaScript method.+Synchronet sysop-posted messages, text and menu files, and some lines in the ''[[dir:ctrl]]/[[text.dat]]'' file may contain special //Message Variables//, also called //@-codes// ("at codes", some BBS authors and sysops refer to these types of codes as "MCI codes"((and not because of the defunct phone company))). @-codes may also be displayed using the ''bbs.atcode()'' JavaScript method.
  
-@-codes are called such because they begin and end with the ''@'' (ASCII 64) ("at") character. The code names themselves (sandwiched between the @'s) must be entered using only ''UPPERCASE'' letters.+@-codes are called such because they begin and end with the ''@'' (ASCII 64) ("at") character. The code names themselves (sandwiched between the @'s) must be entered using only ''UPPERCASE'' letters. Some additional symbols and numbers may also be included in the @-code, but never a space.
  
-Some of the @-codes supported in Synchronet have unusual names or aliases specifically for //PCBoard// and/or //Wildcat!// BBS Software compatibility.+Some of the @-codes supported in Synchronet have unusual names or aliases specifically for //PCBoard// and/or //Wildcat!// BBS Software compatibility. Although this compatibility with these other BBS packages is less of a concern these days, the unusual code names remain.
  
 Synchronet also, optionally, supports some [[custom:colors|Color Codes]] which begin and/or end with the ''@'' character (again, specifically for //PCBoard// and/or //Wildcat!// BBS Software compatibility). These //PCBoard// and //Wildcat!// color codes are not usually referred to as @-codes and **do not** fall under the usage/formatting guidelines given on this page. Synchronet also, optionally, supports some [[custom:colors|Color Codes]] which begin and/or end with the ''@'' character (again, specifically for //PCBoard// and/or //Wildcat!// BBS Software compatibility). These //PCBoard// and //Wildcat!// color codes are not usually referred to as @-codes and **do not** fall under the usage/formatting guidelines given on this page.
Line 324: Line 324:
 |BEEP            |BELL    |Generate a beep sound on the user's terminal | |BEEP            |BELL    |Generate a beep sound on the user's terminal |
 |CLS             |        |Clear the screen  | |CLS             |        |Clear the screen  |
-|CLEAR           |        |Clear the screen and eat the next newline sequence |+|CLEAR           |        |Clear the screen, all existing mouse hot-spots and eat the next newline sequence | 
 +|CLEAR_HOT       |        |Clear all existing mouse hot-spots | 
 +|HOT             |        |Define a new mouse hot-spot color (the color of the @-code defines the hot-spot attributes) | 
 +|HOT:HUNGRY      |        |Define a new mouse hot-spot color for defining hungry hot-spots (hungry hot-spots are the default type) | 
 +|HOT:STRICT      |        |Define a new mouse hot-spot color for defining strict hot-spots | 
 +|HOT:OFF         |        |Disable hot-spot by color/attribute definitions for the remainder of the file (or until re-enabled) | 
 +|~//text//       |        |Define a single hungry hot-spot (where the displayed text and command keys are the same) | 
 +|~//text//~//cmd// |      |Define a single hungry hot-spot with an alternate command to stuff in the keyboard input buffer | 
 +|`//text//       |        |Define a single strict hot-spot (where the displayed text and command keys are the same) | 
 +|`//text//`//cmd// |      |Define a single strict hot-spot with an alternate command to stuff in the keyboard input buffer |
 |CRLF            |        |Send a carriage return/line-feed pair   | |CRLF            |        |Send a carriage return/line-feed pair   |
 |CHECKMARK       |        |Send a check mark symbol appropriate for the user's terminal | |CHECKMARK       |        |Send a check mark symbol appropriate for the user's terminal |
Line 349: Line 358:
 |GOTOXY://x,y//  |        |Move cursor to //x/////y// coordinate (1-based) | |GOTOXY://x,y//  |        |Move cursor to //x/////y// coordinate (1-based) |
 |POS://x//       |        |Move cursor to column //x// (1-based) | |POS://x//       |        |Move cursor to column //x// (1-based) |
-|HOME            |        |Home cursor (to upper left), don't clear|+|HOME            |        |Home cursor (to upper left), don't clear the screen |
 |CLRLINE         |        |Clear the current line (cursor to first column)| |CLRLINE         |        |Clear the current line (cursor to first column)|
 |CLR2EOL         |        |Clear to end of line (cursor doesn't move)| |CLR2EOL         |        |Clear to end of line (cursor doesn't move)|
Line 415: Line 424:
   * [[custom:menu_files|Menu Files]]   * [[custom:menu_files|Menu Files]]
   * [[custom:|Customization]]   * [[custom:|Customization]]
 +  * [[custom:ctrl-a_codes|ctrl-a (Attribute) codes]]
   * [[http://synchro.net/docs/customization.html#MessageVariables|Old documentation of this feature (stale)]]   * [[http://synchro.net/docs/customization.html#MessageVariables|Old documentation of this feature (stale)]]
  
 {{tag>customization}} {{tag>customization}}
  

Trace: