Template:Cmd: Difference between revisions

From Unwritten Legends Wiki
Try to fix visual editor whitespace issue
Try to fix visual editor whitespace issue
 
(2 intermediate revisions by the same user not shown)
Line 8: Line 8:
"description": "The user command. If the command should have placeholders, this parameter contains only the text before the first placeholder (including a trailing space, if needed).",
"description": "The user command. If the command should have placeholders, this parameter contains only the text before the first placeholder (including a trailing space, if needed).",
"required": true,
"required": true,
"example": "put ",
"example": "put "
"type": "unbalanced-wikitext"
},
},
"2": {
"2": {
Line 15: Line 14:
"description": "A placeholder that the user will substitute for something else. NOTE: Remember to describe what the placeholder means in the surrounding text.",
"description": "A placeholder that the user will substitute for something else. NOTE: Remember to describe what the placeholder means in the surrounding text.",
"required": false,
"required": false,
"example": "item",
"example": "item"
"type": "line"
},
},
"3": {
"3": {
Line 82: Line 80:
"9",
"9",
"10"
"10"
],
]
"format": "inline"
}
}
</templatedata>
</templatedata>

Latest revision as of 23:09, 14 December 2025

Represents user input.

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
command1

The user command. If the command should have placeholders, this parameter contains only the text before the first placeholder (including a trailing space, if needed).

Example
put
Unknownrequired
placeholder 12

A placeholder that the user will substitute for something else. NOTE: Remember to describe what the placeholder means in the surrounding text.

Example
item
Unknownoptional
command, continued3

More of the user command, up to the second placeholder (if there is one). Remember to include leading and/or trailing space, if needed.

Example
in
Lineoptional
placeholder 24

A placeholder that the user will substitute for something else. NOTE: Remember to describe what the placeholder means in the surrounding text.

Example
target
Lineoptional
command, continued5

More of the user command, up to the third placeholder (if there is one). Remember to include leading and/or trailing space, if needed.

Example
's
Lineoptional
placeholder 36

A placeholder that the user will substitute for something else. NOTE: Remember to describe what the placeholder means in the surrounding text.

Example
container
Lineoptional
command, continued7

More of the user command, up to the fourth placeholder (if there is one). Remember to include leading and/or trailing space, if needed.

Lineoptional
placeholder 48

A placeholder that the user will substitute for something else. NOTE: Remember to describe what the placeholder means in the surrounding text.

Lineoptional
command, continued9

More of the user command, up to the fifth placeholder (if there is one). Remember to include leading and/or trailing space, if needed.

Lineoptional
placeholder 510

A placeholder that the user will substitute for something else. NOTE: Remember to describe what the placeholder means in the surrounding text.

Lineoptional

It is important to describe each placeholder in the surrounding text. This can improve clarity for all users, but it is vital for users who rely on a screen reader, because it is the only way they can tell which words are placeholders.

Example

When you have brought the package to its destination, type {{Cmd|deliver |item| to |person}}, where {{Cmd/ph|item}} is the package and {{Cmd/ph|person}} is the NPC who is meant to receive it.

When you have brought the package to its destination, type deliver item to person, where item is the package and person is the NPC who is meant to receive it.