Re: broken online help system

Yann LeCun <[email protected]>
Newsgroups gmane.lisp.lush.devel
Organization Courant Institute, NYU
Message-ID <[email protected]>
> > I want to document global variables which have names like
> > '*gnuplot-color-to-linetype*'. The asterisk is a keyword
> > in the help system's markup language and so it happens
> > that the corresponding entry in the formatted help text
> > is 'gnuplot-color-to-linetype*', missing the first leading
> > asterisk. Is there a way to workaround problem?

It was a single-character bug in a regular expression. I fixed it in 
the CVS. The third line of the function parse-help-entry 
in lsh/libstd/help.lsh was:

  (pattern "^[ \t]*((\\**)[ \t]*((<<)?)[ \t]*(.*))$")

It is now:

  (pattern "^[ \t]*((\\**)[ \t]+((<<)?)[ \t]*(.*))$")

> Check this manual section:
> Core Interpreter and Startup Library -> Documentation and Help System ->
> Writing Documentation -> Document Body: Brace Syntax
>
> Most likely you will want to use one of ,$expr or /$expr ,,$expr, to enter
> a string.

That works for funny text in the documentation body,
but it doesn't work for documentation headings.

  -- Yann



-------------------------------------------------------
SF.Net email is sponsored by:
Tame your development challenges with Apache's Geronimo App Server. Download
it for free - -and be entered to win a 42" plasma tv or your very own
Sony(tm)PSP.  Click here to play: http://sourceforge.net/geronimo.php
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.