From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Neil Jerram Newsgroups: gmane.lisp.guile.bugs Subject: Re: Minor documentation layout flaws Date: Tue, 29 Aug 2006 23:16:34 +0100 Message-ID: <87wt8rdw71.fsf@ossau.uklinux.net> References: NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: sea.gmane.org 1156889886 14254 80.91.229.2 (29 Aug 2006 22:18:06 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Tue, 29 Aug 2006 22:18:06 +0000 (UTC) Cc: bug-guile@gnu.org Original-X-From: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Wed Aug 30 00:18:03 2006 Return-path: Envelope-to: guile-bugs@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1GIBu7-0006Sj-Gv for guile-bugs@m.gmane.org; Wed, 30 Aug 2006 00:17:55 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1GIBu7-0003IK-13 for guile-bugs@m.gmane.org; Tue, 29 Aug 2006 18:17:55 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1GIBu3-0003Hq-Gp for bug-guile@gnu.org; Tue, 29 Aug 2006 18:17:51 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1GIBu1-0003HW-S7 for bug-guile@gnu.org; Tue, 29 Aug 2006 18:17:51 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1GIBu1-0003HT-PA for bug-guile@gnu.org; Tue, 29 Aug 2006 18:17:49 -0400 Original-Received: from [80.84.72.33] (helo=mail3.uklinux.net) by monty-python.gnu.org with esmtp (Exim 4.52) id 1GIC3I-0000LI-22 for bug-guile@gnu.org; Tue, 29 Aug 2006 18:27:24 -0400 Original-Received: from laruns (host86-129-125-104.range86-129.btcentralplus.com [86.129.125.104]) by mail3.uklinux.net (Postfix) with ESMTP id 913B940A987; Tue, 29 Aug 2006 22:17:48 +0000 (UTC) Original-Received: from laruns (laruns [127.0.0.1]) by laruns (Postfix) with ESMTP id 3301D6FF90; Tue, 29 Aug 2006 23:16:34 +0100 (BST) Original-To: "percy tiglao" In-Reply-To: (percy tiglao's message of "Sun, 27 Aug 2006 13:31:38 -0400") User-Agent: Gnus/5.1007 (Gnus v5.10.7) Emacs/21.4 (gnu/linux) X-BeenThere: bug-guile@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Bug reports for GUILE, GNU's Ubiquitous Extension Language" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Errors-To: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.lisp.guile.bugs:3328 Archived-At: "percy tiglao" 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