conventions for .texi files



Robert Dodier <robert_dodier@yahoo.com> writes:

> --- "Vadim V. Zhytnikov" <vvzhy@mail.ru> wrote:
>
>> Additional style proposal:
>>
>> - in the case @defun foo(bar) use @var{bar} for bar in text.
>> This is in accordance with the texinfo conventions and renders
>> bar in italics just like it is rendered by @defun.
>> The only a bit strange thing is that in info bar will
>> be emphasized by uppercasing - BAR.  But to me it is OK.
>> Making @code{} and @var{} differ is more important IMHO.
>
> Hmm, I don't agree with this. The problem is that the
> seeing the name BAR in uppercase leads the user to think
> BAR is what e should type in, and that won't work anymore
> (now that Maxima is case sensitive).

But here BAR isn't what the user types in (unless they want to), it
indicates where they can type in what they want.  Using @var here is
conventional, and Texinfo is used to document a lot of case-sensitive
languages.

Jay