octave-maintainers
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: doctest and @example blocks without an actual cope and paste example


From: Oliver Heimlich
Subject: Re: doctest and @example blocks without an actual cope and paste example
Date: Thu, 09 Jul 2015 19:19:57 +0200
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Icedove/31.7.0

On 09.07.2015 19:05, Mike Miller wrote:
On Thu, Jul 9, 2015 at 18:01:39 +0200, Oliver Heimlich wrote:
- ASCII art is probably best used within an @indentedblock @verbatim
environment (@example is semantically wrong, but easier to use, because of
its brevity)

Thanks for the suggestion. So for the uninitiated, that would be written as

   @indentedblock
   @verbatim
   @group
   text goes here
   @end group
   @end verbatim
   @end indentedblock

?

Looks like @indentedblock is only in Texinfo >= 5, am I reading that
right? So that might not yet be suitable since many distros and many
Octave users still have Texinfo 4.13.


We should think about using @display then, and the @group should be started before @verbatim, because no @ macros are processed within the verbatim environment (which is useful for ascii art).

@display
@group
@verbatim
text goes here
@end verbatim
@end group
@end display



reply via email to

[Prev in Thread] Current Thread [Next in Thread]