documentation



On Sunday 28 December 2008 14:34:53 Mario Rodriguez wrote:
> I also suggest to check how the output is rendered in the pdf
> documents. Sometimes the lines are too long for the available
> width.

The most important problem in pdf/dvi is the page breaking.
It is really hard to read the examples when display2d stuff comes on 
different pages. For example,

  (%i8) genmatrix (B, 2, 2);
                        [ B      B     ]
  ^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-
    page break here
  ^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-^-
                        [  1, 1   1, 2 ]
  (%o8)                 [              ]
                        [ B      B     ]
                        [  2, 1   2, 2 ]

It could be fixed easily. We just need to add "@group" in "@example":

  @example
  ...
  @group
  (%i8) genmatrix (B, 2, 2);
                          [ B      B     ]
                          [  1, 1   1, 2 ]
  (%o8)                   [              ]
                          [ B      B     ]
                          [  2, 1   2, 2 ]
  @end group
  ...
  @end example

I've added a small Perl script doc/info/example-group which should be 
used after the update_examples.


As for update_examples (or example-group), should I commit its results 
to the CVS?

-- 
Pungenday, Aftermath 71 YOLD 3174
Alexey Beshenov  http://beshenov.ru/