conventions for .texi files



--- "Vadim V. Zhytnikov" <vvzhy@mail.ru> wrote:

> Robert Dodier writes:

> > - if a function has several variations, @defunx all variations,
> >   explicitly state variations in text (replace "You can also")

> Yes!  I was about to ask how to implement such things with multiple
> function definitions in texinfo.  I hope @defunx is compatible
> with describe?

Yes, describe seems to understand @defunx and @defvarx well enough.

> I also wonder what to do with description for first, 
> second ... tenth in Lists.texi.  Now we have just one item
> 
> @defun first (list) second (list) .. tenth (list)
> 
> Probably we have to make 10 @defun's for each function.

I guess I would suggest here that we put the substantial
discussion under @defun first, and put "See also `second',
`third', etc etc, `tenth'" there. Then make @defun second,
@defun third, etc, and have each one say "The x'th item
in an expression or list. See `first'."

> > - rerun examples with linel: 65
> >   (verifies examples, fixes alignment, and makes lowercase)

> Very important since many examples are cropped from the right side
> in printed material.   There is yet another possibility to fix the
> problem - maybe left indentation for @example smaller globally by
> some TeX magic?

I don't know the appropriate incantation. It seems OK to
just rerun the examples since they need to be verified 
and lowercased anyway.

> I'd like to attract attention to yet another documentation problem.
> At present many functions and features which are available
> as share packages and require some load("foo"); for operation
> are mixed with other built-in Maxima function. 
> This is OK as soon as this required load("foo"); is clearly
> indicated.
> It seems that it is not the case.  Maybe it is good idea to create
> special package index.  Finally, is it possible to create something
> like @defpackage for packages description?

A package index makes a lot of sense to me. I wonder what
is the best way to go about that.

regards,
Robert Dodier


		
__________________________________ 
Do you Yahoo!? 
The all-new My Yahoo! - What will yours do?
http://my.yahoo.com