Core Help Root: Objects: Help Node: Settings


Settings on a help node:

group = yes
holder = no
index =
nolist = yes

The group setting is used to control if a node lists the group (i.e. its siblings) at the bottom of the page. If group is enabled, they will be listed. Otherwise, they will not be listed. Note: If the help node is a child of $help_obj, $help_sys, $help_cmds or a similar 'place-holder' object, its group should be set to no.

The holder setting is enabled when a help node exists purely for heirarchial reasons. This changes how the object is listed when a title is generated with all heirarchial information. If holder is enabled, no links will be made to the object.

The index setting is used to set the help index (children of $help_index). 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.

The nolist setting is used to make an object 'invisible', so that it does not showup in groups or heirarchial information.


Names | Settings | Creation | Format Conventions | Commands


the Cold Dark