Core Help Root: Objects: Help Node: Format Conventions: General


Some general formatting conventions:

White Space

White Space in CML is generally managed ok. However, in some cases it is not--when formatting plaintext. This is due primarily to the problems which arise with multiple output formats. Therefore, you should pay close attention when writing help information that your Whitespace formatting is correct. Are your paragraphs spaced with one blank line them? Do your paragraphs begin at the start of the line, or is there a space first?

Action Examples

When giving an example of an action the user may take, always format it as:

{dfn:example}

In the case of one or more lines, use {br}, such as:

{dfn:example line 1{br}example line 2}

When showing an action and result, use '=>' to represent the result. Do not prefix the action with a prompt, unless it is a command.


General | Commands | Objects


the Cold Dark