Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
custom:atcodes [2019/09/20 01:47] digital man Added FILESIZE, FILEBYTES, FILEKB, FILEMB, and FILEGB |
custom:atcodes [2019/09/24 01:34] (current) digital man [Format Modifiers] Document the pipe modifier separator and the new (T) thousands modifier letter |
||
|---|---|---|---|
| Line 20: | Line 20: | ||
| ==== Format Modifiers ==== | ==== Format Modifiers ==== | ||
| - | Most @-codes support an optional format modifier. Modifiers are appended to the end of the @-code variable name and before the terminating ''@'' character. Only one format modifier may be used per @-code instance; you cannot combine format modifiers. | + | Most @-codes support an optional format modifier. Modifiers are appended to the end of the @-code variable name and before the terminating ''@'' character, separated from the code itself with either a hyphen (''-'') or a pipe (''|'') character. |
| + | |||
| + | When using the hyphen (''-'') modifier separator, only one format modifier may be used per @-code instance (you cannot combine format modifiers) and @-code arguments (separated from the code with a colon) are **not** supported). | ||
| + | |||
| + | When using the pipe (''|'') modifier separator, some modifiers may be combined with others (e.g. ''|TR'') and @-code arguments (separated from the code with a colon) **are** supported. | ||
| ^ 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) | |
| - | | ''-W'' | 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) | |
| - | | ''->'' | Allow the terminal to wrap (don't truncate) overly-long expanded @-codes (added in v3.17c) | | + | | ''T'' | Thousands-separated (e.g. with a comma) numeric values, may be combined with other modifiers (added in v3.17c) | |
| + | | ''>'' | Allow the terminal to wrap (don't truncate) overly-long expanded @-codes (added in v3.17c) | | ||
| === Width Specificity === | === Width Specificity === | ||
| Line 34: | Line 39: | ||
| A string //width//, specified as a positive decimal number, may immediately follow a format modifier. | A string //width//, specified as a positive decimal number, may immediately follow a format modifier. | ||
| - | Example: ''@NODE-L2@'' for a left-justified 2 character (space padded) node number or ''@NODE-Z2@'' for a right-justified 2 digit (zero-padded) node number. | + | Example: ''@NODE|L2@'' for a left-justified 2 character (space padded) node number or ''@NODE|Z2@'' for a right-justified 2 digit (zero-padded) node number. |
| Another method of specifying the width of an expanded @-code is to include non-numeric non-space characters between the modifier and the trailing ''@'' character. | Another method of specifying the width of an expanded @-code is to include non-numeric non-space characters between the modifier and the trailing ''@'' character. | ||
| - | Example: ''@ALIAS-R###########@'' for a right-justified 20 character user alias (any non-numeric non-space characters could have been used in place of the ''#'' characters). | + | Example: ''@ALIAS|R###########@'' for a right-justified 20 character user alias (any non-numeric non-space characters could have been used in place of the ''#'' characters). |
| === Truncation === | === Truncation === | ||
| Line 44: | Line 49: | ||
| 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. | + | 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 === | ||
| - | @-codes that take an argument value, preceded by a colon ('':'') character cannot be used with format modifiers. | + | @-codes that take an argument value, preceded by a colon ('':'') character, cannot be used with format modifiers when using the hyphen (-) modifier separator; use the pipe (|) modifier separator instead. |
| ===== System Information ===== | ===== System Information ===== | ||
