Re: Minor documentation layout flaws

[Neil Jerram]

"percy tiglao" <address@hidden> writes:

> Hello. I decided to make a print version of the reference manual; but
> there were so many stuff that ran through the right side of the page
> (technically, overfull hboxes). I'm interested in helping you guys
> remove those things so that all the stuff fits on a page; but I'm
> wondering if there are any standards and such before I start making
> major changes.

Thanks, I'm interested in this too.  Does this depend on what paper
size you are targetting?  Or does Texinfo enforce a particular paper
size, so you don't really have a choice?

> For example: one of the pages had some guile source code with
> "call-with-current-continuation" on it. But the word was so big; that
> it pushed the parameters off the page. The easiest correction is to
> just change the word into "call/cc" instead; but that might conflict
> with your standard...
>
> So I'm just wondering if you got anything like that. If not... I'll be
> working on that documentation patch!

>From a documentation point of view, I'd say the only principle is that
everything has to make sense in its own context.  So in this case,
"call/cc" instead of "call-with-current-continuation" would be fine if
either (a) it is noted near the example that call/cc is a common
abbreviation for call-with-current-continuation, or (b) the section is
sufficiently advanced that it can be assumed all readers would know
(a) already.

Regards,
     Neil