This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision |
| reference:help_formatting [2017/02/07 07:28] – [Markup] gawrilow | user_guide:extend:help_formatting [2019/01/29 21:46] (current) – external edit 127.0.0.1 |
|---|
| ====== Formatting Help Blocks ====== | ====== Formatting Help Blocks ====== |
| For many items defined in the [[rulefiles]], short descriptive texts can (and ought to) be placed immediately above the definition in form of comment blocks. These texts are "automagically" gathered by polymake and made available to the users of the interactive shell by the means of ''help'' command; they can also be transformed into HTML pages which then become part of the official release documentation. Currently the following definitions can be accompanied by help blocks: "big" object types, their properties and property types, user functions and methods (including those embedded in [[clients#connection to perl|C++ clients]]), preference labels, custom variables, and option lists. | For many items defined in the [[rulefiles]], short descriptive texts can (and ought to) be placed immediately above the definition in form of comment blocks. These texts are "automagically" gathered by polymake and made available to the users of the interactive shell by the means of ''help'' command; they can also be transformed into HTML pages which then become part of the official release documentation. Currently the following definitions can be accompanied by help blocks: "big" object types, their properties and property types, user functions and methods (including those embedded in [[user_guide:extend:clients#connection to perl|C++ clients]]), preference labels, custom variables, and option lists. |
| |
| Besides this, arbitrary topics can be inserted into the help system using the special [[rulefiles#credits and help|@topic notation]] in the first line of the comment block. For example, ''@topic application'' titles a text describing the application as a whole; usually this block is located in the application's ''main.rules'' or ''help.rules''. Repeating occurrences of text blocks ascribed to the same topic are concatenated together. | Besides this, arbitrary topics can be inserted into the help system using the special [[rulefiles#credits and help|@topic notation]] in the first line of the comment block. For example, ''@topic application'' titles a text describing the application as a whole; usually this block is located in the application's ''main.rules'' or ''help.rules''. Repeating occurrences of text blocks ascribed to the same topic are concatenated together. |