Re: documentation



James Amundson writes:

>On Thu, 2004-11-11 at 09:08, C Y wrote:
>  
>
>>--- Robert Dodier <robert_dodier@yahoo.com> wrote:
>>
>>    
>>
>>>--- "Vadim V. Zhytnikov" <vvzhy@mail.ru> wrote:
>>>
>>>      
>>>
>>>>Now all Maxima built-in functions and variables 
>>>>are UPPERCASE and all sample session logs reflects old 
>>>>Maxima CS behavior.  Shall we update maxima texinfo
>>>>according to new planned strict CS behavior?
>>>>        
>>>>
>
>Yes.
>
>  
>
>>>Well, making built-ins uppercase is a way to give
>>>them emphasis in 7 bit ascii sans control characters.
>>>So I guess that I'm hesitant to change SAVE and LOAD
>>>to save and load unless we have a way to emphasize
>>>them. Maybe @code{foo} is enough, since it renders
>>>as `foo', but to be honest I'm not really a big fan
>>>of that. But FOO is pretty ugly too. Better still
>>>would be bold face or maybe italics, but either of
>>>those makes assumptions about display capabilities.
>>>      
>>>
>>Hmm.  Where do you feel they need emphasis?  The only
>>environment where I think we need to assume very
>>primative display capabilities is the terminal interface
>>itself.  I personally feel that @code{foo} is better than
>>FOO, since FOO could get confusing in a case sensitive
>>environment if foo is what is actually used.  (Plus, all
>>caps anything looks rather dated.)
>>    
>>
>
>CY is correct; we can't leave the commands in all caps in the manual.
>
>--Jim
>
>  
>
I suggest the following scheme:

1. Change all function and variable definitions, sample sessions,
and in-text pieces of code to LC according to current Maxima CS
convention.

2. Put all in-text pieces of code into @code{}.  In printed
material @code{foo} is rendered in fixed width typewriter
font while in text mode (info/pinfo) foo is emphasized
by surrounding quotes and if possible by brightness.
IMHO It is very important to make clear distinction between
common text and Maxima commands in the documentation.

I also noticed that some session samples are too wide
and get cropped from the right in printed material.
Something have to be done with it.  Probably such
sessions must be recreated with smaller linenum.

If nobody minds I'll start doing this together
further .texi clean up (I mean removing or fixing
outdated pieces).

-- 
     Vadim V. Zhytnikov

      <vvzhy@mail.ru> 
     <vvzhy@netorn.ru>