IMM_LISTHELP
Keywords: IMM_LISTHELP, WIZ_LISTHELP
=== STAFF MANUAL ===
Usage: listhelp
listhelp <category>
Description:
Print a numbered index of every help entry the engine has
loaded, with each entry's category and keyword list. This is
the companion view to hedit -- it lets you audit the shape
of the help corpus, find entries sitting in the wrong
category, and quickly locate a topic by scanning the list.
Argument:
<category> ..... Optional filter. Pass the name of any
HelpCategory and only entries in that
category are listed. Abbreviations are
accepted, so build matches Building.
The valid categories are:
None, Basics, Communication, Movement,
Combat, Items, Character, Clans,
Information, Vehicles, Building, Admin.
An unrecognized category is rejected with:
Unknown category '<arg>'. Valid categories:
Followed by the full list so you can pick the right
spelling.
Output:
Each row shows the entry's index, its category, and the
full keyword line exactly as stored on the HelpManager entry:
42: [Building ] WIZ_REDIT REDIT IMM_REDIT
The filtered form adds a header identifying the category:
Help files [Building]:
The unfiltered form simply starts with:
Help files:
Output is paged via SendPaged, so long lists are broken
up across multiple screens.
Restrictions:
- Requires the Help staff permission.
- The category argument is resolved with
GetEnumByNameAbbrev; anything that does not match a
known category (including the empty-on-failure case)
is rejected rather than silently falling through to the
unfiltered listing.
Notes:
- The index numbers are assigned at display time, not
persisted -- they change whenever entries are added,
removed, or filtered.
- Entries sitting in the None category are visible
under listhelp none; consider re-categorizing them
via hedit so they show up on topic-specific listings.
Related Helpfiles: WIZ_HEDIT
=== END MANUAL ===