Page Under Construction
This page is under construction and using the CommandTemplate. This should be removed once the page is finished.
@PAGE@
<Optional Tag If This is a Historical Document that has functionality that has been superceded by another program> This page describes the functionality for the Built-In <COMMAND> command. For more information on how the extended page functionality works, look at the global page command.
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: