Constants that are used throughout the script. All are exported by default.
- No constant here will ever be zero.
- All constants are exported by default.
These are only groups of constants, but should be treated like typedefs or enums. Each one represents a distinct type and their values should only be one of their constants or undef.
The types of entries that can appear in the menu.
|MENU_TITLE||The title of the menu.|
|MENU_SUBTITLE||The sub-title of the menu.|
|MENU_FILE||A source file, relative to the source directory.|
|MENU_LINK||A web link.|
|MENU_FORMAT||The version of Natural Docs the menu file was generated with.|
|MENU_ENDOFORIGINAL||A dummy entry that marks where the original group content ends. This is used when automatically changing the groups so that the alphabetization or lack thereof can be detected without being affected by new entries tacked on to the end.|
|MENU_DATA||Data not meant for user editing.|
PreviousMenuState.nd depends on these values all being able to fit into a UInt8, i.e. <= 255.
What happened to a file since Natural Docs’ last execution.
|FILE_NEW||The file has been added since the last run.|
|FILE_CHANGED||The file has been modified since the last run.|
|FILE_SAME||The file hasn’t been modified since the last run.|
|FILE_DOESNTEXIST||The file doesn’t exist, or was deleted.|
These constants can be combined with each other.
Menu Entry Flags
The various flags that can apply to a menu entry. You cannot mix flags of different types, since they may overlap.
|MENU_FILE_NOAUTOTITLE||Whether the file is auto-titled or not.|
|MENU_GROUP_UPDATETITLES||The group should have its auto-titles regenerated.|
|MENU_GROUP_UPDATESTRUCTURE||The group should be checked for structural changes, such as being removed or being split into subgroups.|
|MENU_GROUP_UPDATEORDER||The group should be resorted.|
|MENU_GROUP_HASENDOFORIGINAL||Whether the group contains a dummy MENU_ENDOFORIGINAL entry.|
|MENU_GROUP_ISINDEXGROUP||Whether the group is used primarily for MENU_INDEX entries. MENU_TEXT entries are tolerated.|
|MENU_GROUP_UNSORTED||The group’s contents are not sorted.|
|MENU_GROUP_FILESSORTED||The group’s files are sorted alphabetically.|
|MENU_GROUP_FILESANDGROUPSSORTED||The group’s files and sub-groups are sorted alphabetically.|
|MENU_GROUP_EVERYTHINGSORTED||All entries in the group are sorted alphabetically.|