The package itself is a patch of Maxima's online help system to allow the user to generate and save documentation that is accessible through the online help. This package is released under the same GPL licence as Maxima itself.
Here's a sample of how it works:
- Code: Select all
(%i4) ? user_doc
-- Usage: user_doc(name,doc,created)
The args name and doc should be strings, created a boolean. In the final form the user is prompted to input a documentation string. This may stretch over several lines.
Each user-generated documentation event is appended to the file named by the maxima variable 'maxima_userinfo_lisp' in the directory named by 'maxima_userdir'. This file may also be edited manually. Entries in this file are never overwritten.
The user can load maxima_userinfo_lisp into a Maxima session by calling 'load_userinfo_lisp();'
Enter documentation string surrounded by quotes '"'. End input with ';'.
"sin(x) = x - x^3/6 + ...";
See also: ?, ??, maxima_userinfo_lisp, maxima_userdir, load_userinfo_lisp.
Created: 2009-06-10 15:22:35+01:00