IMM_HEDIT
Keywords: IMM_HEDIT, WIZ_HEDIT
=== STAFF MANUAL ===
Usage: hedit <keyword>
Description:
Interactive editor for the game's help entries -- the topic
pages served by the help command and stored in the single
help.hlp file. Pass an existing topic keyword to edit that
entry; pass a keyword that does not yet match an existing
topic and the editor creates a fresh entry under that keyword,
seeded with the placeholder body "This help entry is
unfinished.", minimum level 0, and category None.
Main Menu:
1 Keywords -- the whitespace-separated keyword list
used to match this entry. Entering an empty
string reverts the field to "UNDEFINED".
2 Entry body -- opens the full-screen string editor
on the entry's text. Use /s to save the body
back to the scratch entry and /h for string
editor help.
3 Minimum level -- integer between 0 and LVL_CODER.
Values outside the range are rejected.
4 Category -- opens a numbered submenu listing every
HelpCategory the engine knows about: None,
Basics, Communication, Movement, Combat,
Items, Character, Clans, Information,
Vehicles, Building, Admin.
Q Quit -- prompts to save if anything was modified.
Saving:
The editor works on a scratch copy of the entry. On save,
the scratch is copy-assigned into the live HelpManager entry
(for edits) or appended as a new entry (for creates), and
HelpManager::Save rewrites the entire help.hlp file to
disk. The save is logged to the staff wiznet as:
OLC: <name> edits help '<keywords>'.
The invoker also sees:
Saving changes to help - no need to 'hedit save'!
Restrictions:
- Requires the Help staff permission.
- A keyword argument is required. An empty keyword
entered at field 1 is stored as the literal string
"UNDEFINED", not rejected.
- The minimum level must fall within 0 --
LVL_CODER.
Notes:
- The entire help.hlp file is rewritten on every save.
Because edits are serialized in-process, the game
server's in-memory help table is the authoritative
copy -- any file-level edits made while the server is
running risk being clobbered by the next hedit save.
- To view a topic's current category list without
opening it, use listhelp [<category>].
- Edits are visible to players immediately; there is
no need to reboot the help file.
Related Helpfiles: WIZ_LISTHELP, WIZ_REBOOT
=== END MANUAL ===