From help-octave-request at bevo dot che dot wisc dot edu  Sat Feb 17 11:05:14 2001
Subject: How to type texinfo doc-strings? [was: tex documentation]
From: "John W. Eaton" <jwe at bevo dot che dot wisc dot edu>
To: "help-octave at bevo dot che dot wisc dot edu" <help-octave@bevo.che.wisc.edu>
Date: Sat, 17 Feb 2001 11:05:09 -0600

On 17-Feb-2001, John W. Eaton <jwe at bevo dot che dot wisc dot edu> wrote:

| On 17-Feb-2001, Christoph Spiel <cspiel at hammersmith-consulting dot com> wrote:
| 
| | As we are at it ...  How do the gurus type in the doc-string?
| 
| I do it the hard way (fixing up the escape characters manually), but I
| agree that it would be nice to have something automatic.  For me, a
| minor mode for Emacs would probably be sufficient.  We'd need one for
| C++ source and one for M-files (although the latter should be really
| easy, since it is just a matter of fixing up the fill prefix, I
| think). Any volunteers to write these?.

Sorry to follow up to myself, but after thinking about it for a few
more minutes, it seems that a minor mode would probably be more
trouble than it is worth.  Perhaps an `octave-edit-docstring' command
would be useful.  It would extract the current docstring (if any),
strip the escape characters, stuff the resulting text into a scratch
buffer in Texinfo mode.  A corresponding command, say
`octave-finish-docstring' would automatically put in the newline and
escape characters and reinsert the resulting mess into the source
file.

I have some similar Emacs Lisp functions for editing guile docstrings
if anyone wants to take a look at it and modify it to work with Octave
source code.

Thanks,

jwe



-------------------------------------------------------------
Octave is freely available under the terms of the GNU GPL.

Octave's home on the web:  http://www.octave.org
How to fund new projects:  http://www.octave.org/funding.html
Subscription information:  http://www.octave.org/archive.html
-------------------------------------------------------------