| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| custom:atcodes [2019/07/09 23:53] – [Format Modifiers] Document format modifier exception digital man | custom:atcodes [2019/07/11 14:33] – More Unicode updates. digital man |
|---|
| |
| ^ Modifier ^ Purpose ^ | ^ Modifier ^ Purpose ^ |
| | -L | Pad and left-justify an expanded @-code | | | ''-L'' | Pad and left-justify an expanded @-code | |
| | -R | Pad and right-justify an expanded @-code | | | ''-R'' | Pad and right-justify an expanded @-code | |
| | -C | Pad and center an expanded @-code (added in v3.17b) | | | ''-C'' | Pad and center an expanded @-code (added in v3.17b) | |
| | -D | Displays double-wide using "fullwidth" Unicode code points if possible, spaces between the characters otherwise | | | ''-W'' | Displays double-wide using "fullwidth" Unicode code points if possible, spaces between the characters otherwise | |
| | -Z | Zero-pad and right-justify an expanded @-code (added in v3.17b) | | | ''-Z'' | Zero-pad and right-justify an expanded @-code (added in v3.17b) | |
| | -W | Allow the terminal to wrap (don't truncate) overly-long expanded @-codes (added in v3.17c) | | | ''->'' | Allow the terminal to wrap (don't truncate) overly-long expanded @-codes (added in v3.17c) | |
| |
| === Width Specificity === | === Width Specificity === |
| |
| When a //width// is specified, expanded @-code strings which are **longer** than the specified width will be truncated (shortened) to adhere to the requested width. The left-most characters are preserved/displayed while the right-most characters are truncated (lost). | When a //width// is specified, expanded @-code strings which are **longer** than the specified width will be truncated (shortened) to adhere to the requested width. The left-most characters are preserved/displayed while the right-most characters are truncated (lost). |
| | |
| | By default, //most// expanded @-codes that would reach the last column of the terminal screen are truncated (shortened) so as to not cause an automatic line-wrap of the user's terminal. If you wish for an expanded @-code to be displayed in the last terminal column, or beyond ( possibly causing an automatic line-wrap of the terminal) use the ''->'' format modifier. |
| |
| === Exceptions === | === Exceptions === |
| |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 | |
| | |COPY | |Send a copyright symbol appropriate for the user's terminal, e.g. "(c)" | |
| | |SOUNDCOPY | |Send a sound-copyright symbol appropriate for the user's terminal, e.g. "(P)" | |
| | |REGISTERED | |Send a registered mark appropriate for the user's terminal, e.g. "(r)" | |
| | |TRADEMARK | |Send a trademark symbol appropriate for the user's terminal, e.g. "(tm)" | |
| | |ELLIPSIS | |Send a ellipsis (...) appropriate for the user's terminal | |
| | |DEGREE_C | |Send a degree Celsius symbol appropriate for the user's terminal | |
| | |DEGREE_F | |Send a degree Fahrenheit symbol appropriate for the user's terminal | |
| |EOF | |End-of-file (stop parsing/displaying) | | |EOF | |End-of-file (stop parsing/displaying) | |
| |PAUSE |MORE |Force a screen pause (hit a key) prompt| | |PAUSE |MORE |Force a screen pause (hit a key) prompt| |
| |POFF |NOPAUSE |Toggle automatic screen pause off | | |POFF |NOPAUSE |Toggle automatic screen pause off | |
| |RESETPAUSE | |Reset the automatic screen pause line counter | | |RESETPAUSE | |Reset the automatic screen pause line counter | |
| |UP:n | |Move cursor up n rows | | |UP://n// | |Move cursor up //n// rows | |
| |DOWN:n | |Move cursor down n rows | | |DOWN://n// | |Move cursor down //n// rows | |
| |RIGHT:n | |Move cursor right n columns | | |RIGHT://n// | |Move cursor right //n// columns | |
| |LEFT:n | |Move cursor left n columns | | |LEFT://n// | |Move cursor left //n// columns | |
| |GOTOXY:x,y | |Move cursor to x/y coordinate (1-based) | | |GOTOXY://x,y// | |Move cursor to //x/////y// coordinate (1-based) | |
| |HOME | |Home cursor (to upper left), don't clear| | |HOME | |Home cursor (to upper left), don't clear| |
| |CLRLINE | |Clear the current line (cursor to first column)| | |CLRLINE | |Clear the current line (cursor to first column)| |
| |COLS | |Number of terminal columns | | |COLS | |Number of terminal columns | |
| |ROWS | |Number of terminal rows | | |ROWS | |Number of terminal rows | |
| |TERM | |Terminal-type name | | |TERM | |Terminal-type name (i.e. 'ANSI', 'RIP', 'PETSCII', or 'DUMB') | |
| | |CHARSET | |Terminal character set supported (i.e. 'UTF-8', 'CP437', 'PETSCII', or 'US-ASCII') | |
| |WORDWRAP | |Word-wrap the the following text | | |WORDWRAP | |Word-wrap the the following text | |
| |WRAPOFF | |Mark the end of a word-wrapped text block | | |WRAPOFF | |Mark the end of a word-wrapped text block | |
| |CENTER | |Middle-align the remaining text on the line | | |CENTER | |Middle-align the remaining text on the line | |
| |SYSONLY | |Toggle off/on visibility for non-sysops | | |SYSONLY | |Toggle off/on visibility for non-sysops | |
| |U+<code> | |Send a Unicode character code point (in hexadecimal) to UTF-8 terminal or an automatic fallback character, if supported((Not all Unicode code points support fallback characters for ASCII/CP437/PETSCII terminals)) | | |WIDE://text// | |Display specified //text// double-wide, using Unicode "fullwidth" characters if possible | |
| | |U+//code// | |Send a Unicode character code point (in hexadecimal) to UTF-8 terminal or an automatic fallback character, if supported((Not all Unicode code points support fallback characters for ASCII/CP437/PETSCII terminals)) | |
| | |U+//code//://text// | | Send a Unicode character code point, specifying fallback string) | |
| | |U+//code//,//char// | | Send a Unicode character code point, specifying fallback character value in hexadecimal (or ''0'' for //none//) | |
| | |U+//code//!//char// | | Send a Unicode character code point, specifying fallback character only to used when no automatic fallback is available | |
| |
| ==== Unicode ==== | ==== Unicode ==== |
| |
| The 'U+' @-code supports additional syntax to allow the sysop to specify the CP437 fallback character: | The 'U+' @-code supports additional syntax to allow the sysop to specify the CP437 fallback character: |
| * ''@U+<code>/<char>@'': Send a Unicode character with specified fallback character, in hexadecimal (specify ''0'' to send //no// character to non-UTF-8 terminals) | * ''@U+<code>:<text>@'': Send a Unicode character with specified fallback character sequence (string) |
| | * ''@U+<code>,<char>@'': Send a Unicode character with specified fallback character, in hexadecimal (specify ''0'' to send //no// character to non-UTF-8 terminals) |
| * ''@U+<code>!<char>@'': Send a Unicode character with specified fallback character to be used //only// when no automatic fallback character is supported | * ''@U+<code>!<char>@'': Send a Unicode character with specified fallback character to be used //only// when no automatic fallback character is supported |
| ===== External Content ===== | ===== External Content ===== |
