From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Stephen Compall Newsgroups: gmane.lisp.guile.devel Subject: [PATCH]preface.texi (Manual Layout) Date: Tue, 11 Nov 2003 18:44:13 GMT Sender: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Message-ID: <200311111844.hABIiDDu011851@csserver.evansville.edu> NNTP-Posting-Host: deer.gmane.org X-Trace: sea.gmane.org 1068578462 22056 80.91.224.253 (11 Nov 2003 19:21:02 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Tue, 11 Nov 2003 19:21:02 +0000 (UTC) Original-X-From: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Tue Nov 11 20:21:00 2003 Return-path: Original-Received: from monty-python.gnu.org ([199.232.76.173]) by deer.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 1AJe4R-0001IW-00 for ; Tue, 11 Nov 2003 20:20:59 +0100 Original-Received: from localhost ([127.0.0.1] helo=monty-python.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.24) id 1AJemQ-0000yg-Dq for guile-devel@m.gmane.org; Tue, 11 Nov 2003 15:06:26 -0500 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.24) id 1AJeYR-0007IE-LW for guile-devel@gnu.org; Tue, 11 Nov 2003 14:51:59 -0500 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.24) id 1AJeXn-00072J-8v for guile-devel@gnu.org; Tue, 11 Nov 2003 14:51:50 -0500 Original-Received: from [192.195.228.35] (helo=csserver.evansville.edu) by monty-python.gnu.org with esmtp (TLSv1:DES-CBC3-SHA:168) (Exim 4.24) id 1AJeXl-00071C-Lk for guile-devel@gnu.org; Tue, 11 Nov 2003 14:51:18 -0500 Original-Received: from csserver.evansville.edu (localhost.localdomain [127.0.0.1]) by csserver.evansville.edu (8.12.8/8.12.8) with ESMTP id hABIiDBT011855 for ; Tue, 11 Nov 2003 12:44:13 -0600 Original-Received: (from sc87@localhost) by csserver.evansville.edu (8.12.8/8.12.8/Submit) id hABIiDDu011851; Tue, 11 Nov 2003 18:44:13 GMT Original-To: guile-devel@gnu.org X-BeenThere: guile-devel@gnu.org X-Mailman-Version: 2.1.2 Precedence: list List-Id: Developers list for Guile, the GNU extensibility library List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Xref: main.gmane.org gmane.lisp.guile.devel:2997 X-Report-Spam: http://spam.gmane.org/gmane.lisp.guile.devel:2997 I would have done a text workup along with the syntax bits I did, but decided it wouldn't really help that much. But if you think revising the text would be useful, I'd be happy to look it over. 2003-11-11 Stephen Compall * preface.texi (Manual Layout): Wrap POSIX, API, and SLIB in @acronym. Change from paragraph format (somewhat clumsy-looking on paper, at least) to @table format, with headers @strong. Made example modules complete sentences. Snag the patch at http://csserver.evansville.edu/~sc87/dist/Manual-Layout-1sirian.patch Here is the Info output, though you really can't see *most* of the changes I made there: Layout of this Manual ********************* The manual is divided into five parts. *Part I: Introduction to Guile* Provides an overview of what Guile is and how you can use it. A whirlwind tour shows how Guile can be used interactively and as a script interpreter, how to link Guile into your own applications, and how to write modules of interpreted and compiled code for use with Guile. Everything introduced here is documented again and in full by the later parts of the manual. This part also explains how to obtain and install new versions of Guile, and how to report bugs effectively. *Part II: Writing and Running Guile Scheme* *Part III: Programming with Guile* Document all aspects of practical programming using Guile. This covers both the Scheme level -- where we provide an introduction to the key ideas of the Scheme language -- and use of Guile's `scm' interface to write new primitives and objects in C, and to incorporate Guile into a C application. It also covers the use of Guile as a POSIX-compliant script interpreter and how to use the Guile debugger. *Part IV: Guile API Reference* Documents Guile's core API. Most of the variables and procedures in Guile's core programming interface are available in both Scheme and C and are related systematically such that the C interface can be inferred from the Scheme interface and vice versa. Therefore, this part of the manual documents the Guile API in functionality-based groups with the Scheme and C interfaces presented side by side. Where the Scheme and C interfaces for a particular functional area do differ -- which is sometimes inevitable, given the differences in the structure of the two languages -- this is pointed out and explained. In all cases the overriding principle is that all the reference documentation for a given functional area is grouped together. *Part V: Guile Modules* Describes some important modules, distributed as part of the Guile distribution, that extend the functionality provided by the Guile Scheme core. Two important examples are: * The POSIX module, which provides Scheme-level procedures for system and network programming that conform to the POSIX standard. * The SLIB module, which makes Aubrey Jaffer's portable Scheme library available for use in Guile. -- Stephen Compall or s11 or sirian The eye is a menace to clear sight, the ear is a menace to subtle hearing, the mind is a menace to wisdom, every organ of the senses is a menace to its own capacity. ... Fuss, the god of the Southern Ocean, and Fret, the god of the Northern Ocean, happened once to meet in the realm of Chaos, the god of the center. Chaos treated them very handsomely and they discussed together what they could do to repay his kindness. They had noticed that, whereas everyone else had seven apertures, for sight, hearing, eating, breathing and so on, Chaos had none. So they decided to make the experiment of boring holes in him. Every day they bored a hole, and on the seventh day, Chaos died. -- Chuang Tzu David John Oates Marxist Ft. Bragg csystems ASIO Mole Crowell SCUD missile cryptanalysis S Key AIEWS tempest Crypto AG Watergate terrorism _______________________________________________ Guile-devel mailing list Guile-devel@gnu.org http://mail.gnu.org/mailman/listinfo/guile-devel