Difference between revisions of "Help Record"
m (moved A Help Record to Help Record: There is no A in TEAM! Oh wait, maybe there is. Instead change for better categorization. More forthcoming.) |
|||
| Line 1: | Line 1: | ||
The block start with the string '''#HELP''' , followed by one or more help records, and ending with the string '''0 $~''' . | |||
This is an example of a helps block: | |||
<nowiki>#HELP</nowiki><br> | |||
record1: see below for a help record for layout<br> | |||
record2: see below for a help record for layout<br> | |||
record3: see below for a help record for layout<br> | |||
0 $~<br> | |||
A help record is laid out as follows: | |||
A B C <br> | |||
D<br> | |||
E<br> | |||
A: This is the lowest level player that can read the help. A 0 means everyone can read it. | A: This is the lowest level player that can read the help. A 0 means everyone can read it. | ||
| Line 15: | Line 22: | ||
C: This is a tilde (the squiggly hyphen). | C: This is a tilde (the squiggly hyphen). | ||
D: This is the text of the help | D: This is the text of the help. The text should be composed of lines no longer than 75 characters, and do NOT use tabs to align things as they cause weird problems. | ||
E: This is a tilde. | E: This is a tilde. | ||
An example of a help record | An example of a help record/block: | ||
<nowiki>#HELP</nowiki><br> | |||
0 SAMPLE~ | 0 SAMPLE~ | ||
<br> | |||
This is a sample help to show you what a help would look like. Had this been a real help, there theoretically would be useful, informative, or otherwise beneficial information contained herein. | This is a sample help to show you what a help would look like. Had this been a real help, there theoretically would be useful, informative, or otherwise beneficial information contained herein. | ||
~<br> | |||
50 COOLPEOPLESAMPLE<BR> | |||
This is another sample help that would only be seen by effective leve 50 and above. Disclaimer from original sample still stand. | |||
~ | |||
0 $~ | |||
[[Category:Area Development]] | [[Category:Area Development]] | ||
Revision as of 20:19, 1 June 2011
The block start with the string #HELP , followed by one or more help records, and ending with the string 0 $~ .
This is an example of a helps block:
#HELP
record1: see below for a help record for layout
record2: see below for a help record for layout
record3: see below for a help record for layout
0 $~
A help record is laid out as follows:
A B C
D
E
A: This is the lowest level player that can read the help. A 0 means everyone can read it.
B: This is a list of keywords that are used to reference the help.
C: This is a tilde (the squiggly hyphen).
D: This is the text of the help. The text should be composed of lines no longer than 75 characters, and do NOT use tabs to align things as they cause weird problems.
E: This is a tilde.
An example of a help record/block:
#HELP
0 SAMPLE~
This is a sample help to show you what a help would look like. Had this been a real help, there theoretically would be useful, informative, or otherwise beneficial information contained herein.
~
50 COOLPEOPLESAMPLE
This is another sample help that would only be seen by effective leve 50 and above. Disclaimer from original sample still stand.
~
0 $~