From 10f4d6055c80f45b538cfc6657994b31e4abf525 Mon Sep 17 00:00:00 2001 From: Simon Tatham Date: Thu, 25 Mar 2004 19:16:28 +0000 Subject: Obsoleted the `\preamble' command. Preamble text is now taken to be any ordinary displayable paragraph(s) appearing before the first chapter heading, meaning in particular that you can put lists, code paragraphs etc in preambles. Of course, `\preamble' is still supported for backwards compatibility, but it's now a zero-effect paragraph marker. [originally from svn r3981] --- doc/blurb.but | 8 ++++---- doc/input.but | 26 +++++++++----------------- 2 files changed, 13 insertions(+), 21 deletions(-) (limited to 'doc') diff --git a/doc/blurb.but b/doc/blurb.but index 2bb59b1..b644681 100644 --- a/doc/blurb.but +++ b/doc/blurb.but @@ -8,12 +8,12 @@ \cfg{xhtml-body-end}{Comments to anakin@pobox.com} -\preamble Halibut is a free (MIT-licensed) documentation production -system, able to generate multiple output formats from the same input -data. +Halibut is a free (MIT-licensed) documentation production system, +able to generate multiple output formats from the same input data. +This document is its user manual. \copyright This manual is copyright 2004 Simon Tatham. All rights reserved. You may distribute this documentation under the MIT licence. See \k{licence} for the licence text in full. -\versionid $Id: blurb.but,v 1.1 2004/03/25 18:33:02 simon Exp $ +\versionid $Id: blurb.but,v 1.2 2004/03/25 19:16:28 simon Exp $ diff --git a/doc/input.but b/doc/input.but index e5c157b..587836f 100644 --- a/doc/input.but +++ b/doc/input.but @@ -867,16 +867,16 @@ These sometimes occur in books, for specialist purposes such as keyword argument, because there is no sensible way to generate an automatic cross-reference to such a chapter anyway. -\S{input-blurb} \c{\\preamble}, \c{\\copyright}, \c{\\title}, -\c{\\versionid}: Miscellaneous blurb commands +\S{input-blurb} \c{\\copyright}, \c{\\title}, \c{\\versionid}: +Miscellaneous blurb commands -These four commands define a variety of special paragraph types. +These three commands define a variety of special paragraph types. They are all used in the same way: you put the command at the start of a paragraph, and then just follow it with normal text, like this: \c \title My First Manual -The four special paragraph types are: +The three special paragraph types are: \dt \c{\\title} @@ -885,23 +885,15 @@ title is treated specially in some output formats (for example, it's used in a \cw{} tag in the HTML output), so it needs a special paragraph type to point it out. -\dt \c{\\preamble} - -\dd This command indicates ordinary text that appears \e{before} the -first chapter heading. \#{FIXME: figure out what Halibut actually -does do with ordinary text before a chapter heading. Then figure out -whether that's sensible. Then figure out what \preamble has to offer -that's perceptibly different. Fix if necessary.} - \dt \c{\\copyright} \dd This command indicates that the paragraph attached to it contains a copyright statement for the document. This text is -usually displayed inline, in the same way as \c{\\preamble} text, -but in some output formats it is given additional special treatment. -For example, Windows Help files have a standard slot in which to -store a copyright notice, so that other software can display it -prominently. +usually displayed inline, just before the first chapter title but +after any preamble text before that; but in some output formats it +is given additional special treatment. For example, Windows Help +files have a standard slot in which to store a copyright notice, so +that other software can display it prominently. \dt \c{\\versionid} -- cgit v1.1