Re: broken online help system

You can make your files part of the main manual
in a rather permanent way by adding an entry in
lush/local/local-manual.hlp that would look like this:

#? *** << /mydirectory/myfile.lsh

Unfortunately, you also have to redo "make" and "make install"
after that because the index of the manual is "precompiled" in 
the binary dump file that Lush loads at startup.
The text of individual help entries is re-read from
file every time though.

A more convenient solution is to do what Leon suggests:
(helptool "myfile.lsh") for a Lush file or 
(helptool "myfile.hlp") for help file.
These files can contain include directives
#? ** << myotherfile.lsh
if your documentation is spread accross multiple files.

I suppose there should be a simple method to dynamically
add en entry to the currently active help-book.
Somewhow, I left that out.

  -- Yann



On Thursday 27 October 2005 10:52 am, Leon Bottou wrote:
> > Second observation: When I change text in a module (.lsh file) and
> > then reload the module, the function and and class objects get updated
> > but not the associated help texts. More general, if I load my own
> > modules, the help texts in them don't become available to lush's
> > search facility.
>
> The help system worked like this long ago (before the thing was called
> lush). The current system only consider help text from files
> included by a master document (by default lsh/lush-manual.hlp.)
>
> Note that you can call helptool with another master document.
> For instance (helptool "myfile.lsh")
>
> Yann implemented this because there seems to be no good way
> to simultaneously consider the help text contained in every
> loaded file and maintain a meaningful manual structure.
>
> Personally I prefer the old way of doing things.
> But Yann studied the problem more closely and chose the other option...
>
> - L.
>
>
> -------------------------------------------------------
> This SF.Net email is sponsored by the JBoss Inc.
> Get Certified Today * Register for a JBoss Training Course
> Free Certification Exam for All Training Attendees Through End of 2005
> Visit http://www.jboss.com/services/certification for more information
> _______________________________________________
> Lush-devel mailing list
> [email protected]
> https://lists.sourceforge.net/lists/listinfo/lush-devel



-------------------------------------------------------
This SF.Net email is sponsored by the JBoss Inc.
Get Certified Today * Register for a JBoss Training Course
Free Certification Exam for All Training Attendees Through End of 2005
Visit http://www.jboss.com/services/certification for more information