Re: @defun and @defvr in the "same" block?

[Raymond Toy]

On Sun, Feb 5, 2023 at 1:09 PM Gavin Smith <gavinsmith0123@gmail.com> wrote:

On Mon, Nov 21, 2022 at 11:37:10AM -0800, Raymond Toy wrote:
> I'm converting some old documents written with Scribe.  The conversion is
> pretty straightforward since the syntax between Scribe and Texinfo are
> really pretty close.
>
> However, I've run into a small issue.  The original Scribe did things like:
>
> @defun[fun {check-region-query-size}, args {@i[region]}]
> @defhvar1[var {Region Query Size}, val {30}]
> @f[check-region-query-size] counts the lines in @i[region], and if their number
>
> <description>
>
> @enddefun

For what it's worth, I downloaded the source for the manual following
the instructions at https://www.cons.org/cmucl/hemlock/index.html to
look at it.

@defun and @defhvar were not builtin Scribe commands as far as I can tell.
They are not mentioned in any of the documents about Scribe I've been
able to see.

In the Hemlock sources they are defined under src/database/hem.lib,
src/database/dbolio.lib and other files, apparently to use the same features
as Bolio.  (I believe that "Dover" in these files refers to a model of
printer.)

Scribe seems to have been a very large influence on Texinfo but the
definition commands appear to have come from Bolio.

Oh, thanks for pointing that out!  It seems there's a disconnect between https://gitlab.common-lisp.net/cmucl/cmucl that used to hold the original sources for the docs.  These got moved to https://gitlab.common-lisp.net/cmucl/cmucl.common-lisp.dev, but we forgot to move the database things.

I have not tried out your new stuff about generalizing @def*, but I hope with the correct incantation the new @def stuff can be made to work with the hemlock docs.  At least well enough to have things go into the correct index.

Thanks so much for your help on this!

--

Ray