Core Help Root: Objects: Help Node: Creation


When creating a help node, be sure to keep the following conventions in mind:

Command nodes always descend from $help_cmds, but have the prefix 'help_cmd_' (non-plural). Command nodes always go in the Command help index ($help_index_cmds).

ColdCore help descends from $help_coldcore

Subsystems descend from $help_sys

Object help descends from $help_obj (generally libraries)

When naming an object, include its parentage where appropriate. However, dont include all levels of descending in the name. Use what is necessary to make it unique without being overbearing. For instance, $help_coldc_func is perfectly fine, where $help_coldcore_prog_coldc_func would be the ''full'' name (use the former, not the latter). All help nodes should begin with the 'help_' prefix, but not 'help_node_'.

only specify an index for a help node, when the help node is a unique concept (specifically in the name). For instance, the node 'Events' exists, and has several children nodes including the node 'Registering'. In this situation 'Events' is indexed but 'Registering' is not.

make sure the node settings are correct. These can be confusing, so try to navigate the tree from various directions and make sure everything is functioning and displaying properly. (see Help Node Settings for more information)}


Names | Settings | Creation | Format Conventions | Commands


the Cold Dark