From: Neil Jerram <neil@ossau.uklinux.net>
Cc: bug-guile@gnu.org
Subject: Re: Minor documentation layout flaws
Date: Tue, 29 Aug 2006 23:16:34 +0100 [thread overview]
Message-ID: <87wt8rdw71.fsf@ossau.uklinux.net> (raw)
In-Reply-To: <aec19dbb0608271031w18daabdbm56a0628aa1211b87@mail.gmail.com> (percy tiglao's message of "Sun, 27 Aug 2006 13:31:38 -0400")
"percy tiglao" <prtiglao@gmail.com> 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
_______________________________________________
Bug-guile mailing list
Bug-guile@gnu.org
http://lists.gnu.org/mailman/listinfo/bug-guile
next prev parent reply other threads:[~2006-08-29 22:16 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2006-08-27 17:31 Minor documentation layout flaws percy tiglao
2006-08-28 21:51 ` Kevin Ryde
2006-08-28 23:10 ` percy tiglao
2006-08-29 22:16 ` Neil Jerram [this message]
2006-09-02 2:31 ` percy tiglao
2006-09-04 7:02 ` Ludovic Courtès
2006-09-07 20:48 ` Kevin Ryde
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/guile/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87wt8rdw71.fsf@ossau.uklinux.net \
--to=neil@ossau.uklinux.net \
--cc=bug-guile@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).