@example vs @smallexample?

@example vs @smallexample?

[Andrew Cagney]

Eli,

(Just discovered @smallexample, @noindent(after @example) and @b(for 
example input) :-)

I'm wondering if the doco be using @example, @smallexample or both?
For this releasing gdb chapter, I suspect @smallexample is better.

thoughts?
Andrew

Re: @example vs @smallexample?

[Eli Zaretskii]

On Mon, 18 Mar 2002, Andrew Cagney wrote:

> I'm wondering if the doco be using @example, @smallexample or both?
> For this releasing gdb chapter, I suspect @smallexample is better.

IIRC, @smallexample is better, since it does TRT for the @smallbook 
format as well as for the normal format.

Re: @example vs @smallexample?

[Andrew Cagney]

Mind if I try replacing all occurances of @example with @smallexample?

Andrew

> On Mon, 18 Mar 2002, Andrew Cagney wrote:
> 
> 
>> I'm wondering if the doco be using @example, @smallexample or both?
>> For this releasing gdb chapter, I suspect @smallexample is better.
> 
> 
> IIRC, @smallexample is better, since it does TRT for the @smallbook 
> format as well as for the normal format.
> 
> 

Re: @example vs @smallexample?

[Eli Zaretskii]

> Date: Mon, 18 Mar 2002 12:31:16 -0500
> From: Andrew Cagney <ac131313@cygnus.com>
> 
> Mind if I try replacing all occurances of @example with @smallexample?

Please go ahead.  Thanks.

I wonder whether we should add a comment in the manual saying that
only @smallexample should be used.

Re: @example vs @smallexample?

[Andrew Cagney]

> Date: Mon, 18 Mar 2002 12:31:16 -0500
>> From: Andrew Cagney <ac131313@cygnus.com>
>> 
>> Mind if I try replacing all occurances of @example with @smallexample?
> 
> 
> Please go ahead.  Thanks.
> 
> I wonder whether we should add a comment in the manual saying that
> only @smallexample should be used.

In a (er @chapter :-) that documents the conventions used by the manual? 
   At present there is a single brief comment about how input/output are 
presented in the ``sample session'' chapter.

People writing new content would hopefully refer to the conventions 
section (and read these comments) when creating new content.

Andrew

Re: @example vs @smallexample?

[Eli Zaretskii]

On Mon, 18 Mar 2002, Andrew Cagney wrote:

> > I wonder whether we should add a comment in the manual saying that
> > only @smallexample should be used.
> 
> In a (er @chapter :-)

We could make it an @appendix.

> that documents the conventions used by the manual? 

Yes, that sounds like a good place.  Perhaps as a footnote (since it's a 
minor matter for someone who reads the text, not writes new content).

Re: @example vs @smallexample?

[Andrew Cagney]

> On Mon, 18 Mar 2002, Andrew Cagney wrote:
> 
> 
>> > I wonder whether we should add a comment in the manual saying that
>> > only @smallexample should be used.
> 
>> 
>> In a (er @chapter :-)
> 
> 
> We could make it an @appendix.
> 
> 
>> that documents the conventions used by the manual? 
> 
> 
> Yes, that sounds like a good place.  Perhaps as a footnote (since it's a 
> minor matter for someone who reads the text, not writes new content).

I think it is normally found somewhere towards the end of the first 
chapter (assuming that chapter is a general intro of the manual). After 
``we need free documentation''.

Andrew

Re: @example vs @smallexample?

[Eli Zaretskii]

On Tue, 19 Mar 2002, Andrew Cagney wrote:

> I think it is normally found somewhere towards the end of the first 
> chapter (assuming that chapter is a general intro of the manual). After 
> ``we need free documentation''.

I have no problem with that.