user_doc, line break?




On Wed, 15 Jul 2009, Martin Sch?necker wrote:

< Thank you for your suggestions!

Martin, thanks for finding a use for user_doc.

< Just I'm not aware of a way to produce the newline.  Anyway, using the
< documentation from a .mac file (providing a package with the functions to be
< documented), it works with newlines, which is enough for me.  Only issue is
< then that with every load("the_package.mac"), the maxima-userinfo.lisp is
< enlarged.
 
I have updated the user_doc's documentation. It includes an example that
uses 'printf' to insert newlines into a documentation string. This works
in any frontend.

I have also documented the function 'print_user_doc' that allows a user
to export the hashtable containing all user-generated documentation.
By default, this overwrites maxima-userinfo.lisp, but a user can direct
output to another file either by changing the global variable 
maxima_userinfo_lisp or passing a filename. This allows project-specific 
documentation to be stored in project directories.

Also, since the hashtable contains only one entry per key, exporting
user-generated documentation via print_user_doc will automatically kill
all duplicate entries (only the latest entry per key is saved).

https://sourceforge.net/apps/phpbb/maxima/viewtopic.php?f=3&t=2
http://www.maths.ed.ac.uk/~lbutler/maxima-packages.html

Leo
-- 
The University of Edinburgh is a charitable body, registered in
Scotland, with registration number SC005336.