This shows you the differences between two versions of the page.
| Both sides previous revision
Previous revision
|
|
manual:chapter4:libs [2018/03/02 09:46]
claudio [Creating user libraries] |
manual:chapter4:libs [2019/09/11 07:57] (current)
claudioadmin [Creating user libraries] |
| ''{ { IDENT NARGS ALLOWINSYMB HELPTEXT } { IDENT NARGS ALLOWINSYMB HELPTEXT } ... }'' | ''{ { IDENT NARGS ALLOWINSYMB HELPTEXT } { IDENT NARGS ALLOWINSYMB HELPTEXT } ... }'' |
| |
| Where ''IDENT'' is the name of the command to be made visible, this is both the name of the variable containing the command in the directory, and the name of the command as it will be seen by the user of the library. ''NARGS'' and ''ALLOWINSYMB'' are integer numbers. The former is the number of arguments that the command takes, and the latter is a true/false value (1 or 0) indicating whether that command will be allowed to be used in symbolic expressions or not. All user commands (when allowed by setting this number to 1), will be accepted as a function call inside expressions, and the number of commands will be checked against the ''NARGS'' number. Finally, ''HELPTEXT'' is a string to be used as help when the user long-presses the name of the command in the menu. The string should be formatted so the text is in 3 lines, with the first 2 describing the command and the third line shows a stack diagram (preferably following the same guidelines as used in the system menus for consistency). | Where ''IDENT'' is the name of the command to be made visible, this is both the name of the variable containing the command in the directory, and the name of the command as it will be seen by the user of the library. ''NARGS'' and ''ALLOWINSYMB'' are integer numbers. The former is the number of arguments that the command takes from the stack, and the latter is a true/false value (1 or 0) indicating whether that command will be allowed to be used in symbolic expressions or not. All user commands (when allowed by setting this number to 1), will be accepted as a function call inside expressions, and the number of arguments will be checked against the ''NARGS'' number. Finally, ''HELPTEXT'' is a string to be used as help when the user long-presses the name of the command in the menu. The string should be formatted so the text is in 3 lines, with the first 2 describing the command and the third line shows a stack diagram (preferably following the same guidelines as used in the system menus for consistency). |
| The ''$VISIBLE'' must therefore be a list of lists, where each sublist has exactly 4 elements: one ident, two integers and one string. Any deviation from this format will cause ''CRLIB'' to issue an ''Invalid $VISIBLE list''. | The ''$VISIBLE'' must therefore be a list of lists, where each sublist has exactly 4 elements: one ident, two integers and one string. Any deviation from this format will cause ''CRLIB'' to issue an ''Invalid $VISIBLE list''. |
| |