Page Under Construction
This page is under construction and using the CommandTemplate. This should be removed once the page is finished.
Color/Colour
Long story short, ANSI color is not natively supported in descriptions, success messages, the say command, or much anywhere else. External commands are required to produce the color codes.
This page is to explain the use of colors in muck descriptions, success, and related messages. For now it is just a copy of the instructions provided by the <color> command. It should be filled out with actual use examples, such as in descriptions, in osucc messages, and in the say command.
Color is now done with lib-nu-color.muf (dbref #14144).
Quick cheat sheet:
Turn color on: @set me=C
Turn color off: @set me=!C
Color is done either with the new format or lib-ansi-free format.
New format: ~`colors_in_here` and ~`` to reset. Auto resets at end of line.
Example: This is ~`red`red~``, back to normal. ~`bg_red,black`Inverse~``. You may use as many commas as desired for padding. Example: ~`red,,,,,` Commas are the separator for color attributes.
Valid attributes and their shortcuts:
Foreground |
(shortcut): |
black |
(bk) |
red |
(r) |
yellow |
(y) |
green |
(g) |
cyan |
(c) |
blue |
(b) |
magenta |
(m) |
white |
(w) |
|
|
Background |
(shortcut): |
bg_black |
(bgbk) |
bg_red |
(bgr) |
bg_yellow |
(bgy) |
bg_green |
(bgg) |
bg_cyan |
(bgc) |
bg_blue |
(bgb) |
bg_magenta |
(bgm) |
bg_white |
(bgw) |
Other |
(shortcut): |
bold |
|
dim |
(dark) |
uline |
(underline) |
flash |
(blink) |
reverse |
To use color in your descriptions: Make a list (say, redesc, by running lsedit me=redesc)
@desc me={eval:{muf:$mpi-color,{list:redesc }}}
The template below is left in place as it is the commands page template. We should evaluate how to fit the color information with it, or be ready to remove the table and sections below if they just can't be made to fit. We should at least have practical examples of its use.
Command Information |
|
Keyword |
<KEYWORD> |
Type |
BuiltIn | Global |
Arguments |
<ARGUMENT_1> |
... |
|
<ARGUMENT_N |
|
Aliases |
<ALIASES> |
Usage |
<USAGE_1> |
... |
|
<USAGE_N> |
|
Purpose
<COMMAND FUNCTION OR PURPOSE>
Syntax
To describe syntax functionality of a program:
<COMMAND> <PARAMETERS_1>
To describe more than one syntax:
page <COMMAND> <ARGUMENTS_N>
Parameters
<ARGUMENT_1>
- A description of the first argument of the command.
<ARGUMENT_N>
- A description of the Nth argument of the command.
Examples
Example 1
If an editor wanted to describe an example of a command, they would type the following:
<COMMAND> <EXAMPLE_ARGUMENTS_1>
They would explain what the user output was for the user executing the command, if any:
<EXEC_USER_OUTPUT_DESC>
Then explain what other users might see, if anything:
<OTHER_USER_OUTPUT_DESC>
Example N
If an editor wanted to continue writing examples, they could write as many as they wanted, following the general format above:
<COMMAND> <EXAMPLE_ARGUMENTS_N>
And keep writing user example output:
<EXEC_USER_OUTPUT_DESC>
And More Output:
<OTHER_USER_OUTPUT_DESC>
Caveats
Caveats for the command being written about should be placed here. These can be things like restrictions, special operations for wizards, &c.
Related
NullPage - These links should point to pages inside the wiki
Parent Topic
This page should have one of the following as it's Command List Page:
List of SpinDizzy MUCK System Built-In and Local Commands List of SpinDizzy MUCK System Global Commands
Specify the category types for this page. All Command pages will have one of the following:
CategoryBuiltincmd - for Built-In Commands
CategoryGlobalcmd - for Global Commands
Built-In Commands will have one the following sub-types:
Global Commands will have one of the following sub-types: