Administrivia: update a TODO and a .cvsignore.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4077 cda61777-01e9-0310-a592-d414129be87e

After printing out the PDF manual and reading it through, here's a
collection of minor edits for clarity, and also quite a few intended
to keep down the length of lines in code paragraphs (because Courier
is not just a thoroughly ugly font but is also WAY TOO WIDE).

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4076 cda61777-01e9-0310-a592-d414129be87e

... oh, except that minimal documentation might be helpful.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4075 cda61777-01e9-0310-a592-d414129be87e

Display the page numbers on every page. Right. I think this is now
basically usable, and certainly it entirely includes the level of
functionality which was provided by our ancestor Perl script. So I
think I'll stop coding frantically and have a rest!

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4074 cda61777-01e9-0310-a592-d414129be87e

And now the page numbers in the index are PDF cross-references too.
Funny, I thought that would be as hard again as the main index
processing, and it turned out to be nearly trivial.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4073 cda61777-01e9-0310-a592-d414129be87e

Implemented an index. Good _grief_, that was hard work to get all
the fine details right.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4072 cda61777-01e9-0310-a592-d414129be87e

Typo during restructuring caused all code paragraphs to be
permanently bold. Fixed.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4071 cda61777-01e9-0310-a592-d414129be87e

The contents section now contains PDF cross-references.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4070 cda61777-01e9-0310-a592-d414129be87e

Support for a contents section.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4069 cda61777-01e9-0310-a592-d414129be87e

Restructuring to remove the requirement for a printed paragraph to
correspond exactly to a source paragraph. Should allow me to create
multiple printed paragraphs from the same source paragraph (i.e. a
contents entry for each heading in addition to the heading itself),
and invent entirely new printed paragraphs of my own (e.g. for index
entries).

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4068 cda61777-01e9-0310-a592-d414129be87e

Implemented PDF outlines.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4067 cda61777-01e9-0310-a592-d414129be87e

Implemented horizontal rules.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4066 cda61777-01e9-0310-a592-d414129be87e

Implemented lines under chapter titles.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4065 cda61777-01e9-0310-a592-d414129be87e

Fine-tuned the page breaking algorithm by adding penalties and
bonuses for breaking in particular places. (For example, it's
especially bad to break just after a heading, and especially good to
break just before one.)

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4064 cda61777-01e9-0310-a592-d414129be87e

I wrote the info backend _days_ ago. About time the manpage stopped
listing its absence as a bug :-)

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4063 cda61777-01e9-0310-a592-d414129be87e

Fix the TODO comments up a bit.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4062 cda61777-01e9-0310-a592-d414129be87e

Implemented all the missing rendering features (such as different
font selection in headings, mentioning section numbers, bullets,
list item numbers, code paragraphs etc). The PS/PDF output now
actually looks like the document it's supposed to be :-)

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4061 cda61777-01e9-0310-a592-d414129be87e

Implement PDF link annotations: both internal hyperlinks within the
document, and references to external URLs for which acroread will
start a web browser.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4060 cda61777-01e9-0310-a592-d414129be87e

Aha, _that's_ why paragraphs weren't properly justified. Confusion
of semantics as to whether a `last' pointer pointed to the last
relevant thing in a list, or the one beyond that. Oops.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4059 cda61777-01e9-0310-a592-d414129be87e

Initial work on PS and PDF output. Because these two backends share
an enormous amount of preprocessing and differ only in their final
output form, I've introduced a new type of layer called a
`pre-backend' (bk_paper.c is one). This takes all the information
passed to a normal backend and returns an arbitrary void *, which is
cached by the front end and passed on to any backend(s) which state
a desire for the output of that particular pre-backend. Thus, all
the page layout is done only once, and the PS and PDF backends
process the same data structures into two output files.
Note that these backends are _very_ unfinished; all sorts of vital
things such as section numbers, list markers, and title formatting
are missing, the paragraph justification doesn't quite work, and
advanced stuff like indexes and PDF interactive features haven't
even been started. But this basic framework generates valid output
files and is a good starting point, so I'm checking it in.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4058 cda61777-01e9-0310-a592-d414129be87e

Double yikes! I meant to check in just biblio.c, but instead I
checked in all my just-started PS and PDF framework. I'm backing
that lot back out until it actually does something. Ahem.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4057 cda61777-01e9-0310-a592-d414129be87e

Yikes! Stack trash I'd never noticed before. Oops.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4056 cda61777-01e9-0310-a592-d414129be87e

Forgot to mention the info backend in the command-line help. Oops.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4055 cda61777-01e9-0310-a592-d414129be87e

Forgot to mention the info backend in the man page.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4054 cda61777-01e9-0310-a592-d414129be87e

The Emacs and Jed info readers don't like my index format: Info menu
items of the form `* stuff: Section 1.2.' are parsed by standalone
info as `Section 1.2' followed by a period, but are parsed by other
readers as `Section 1' followed by a period and then some spare
text. Therefore, I've changed strategy, and the index is now full of
*Note cross-references rather than menu items. On the plus side,
this means there are no longer any special characters which we can't
tolerate in an index entry; on the minus side, my shiny new
infrastructure for tracking the filepos of index entries is now
rendered pointless. I'll leave it in, though, since it may come in
handy again.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4053 cda61777-01e9-0310-a592-d414129be87e

Add documentation for the info backend.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4052 cda61777-01e9-0310-a592-d414129be87e

Info backend now takes care to avoid magic characters in node names
and index terms (the Info format doesn't like them). In the course
of this I've had to introduce some infrastructure for carrying a
filepos forward from the definition of every RHS index term so that
a particular backend can provide a usefully localised report of
which index term had a problem.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4051 cda61777-01e9-0310-a592-d414129be87e

It would probably help to add a test of the INFO-DIR-ENTRY mechanism
to the test file. Ahem.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4050 cda61777-01e9-0310-a592-d414129be87e

Add a config directive to generate the INFO-DIR-ENTRY things that
appear to be used to automatically construct /usr/info/dir.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4049 cda61777-01e9-0310-a592-d414129be87e

Why hadn't I got round to creating a .cvsignore in the main source
directory before? Silly me.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4048 cda61777-01e9-0310-a592-d414129be87e

Added an info(1) backend, which constructs .info files directly
without going through the .texi source stage. A few things left to
do, notably documentation, but the basics all seem to be there.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4047 cda61777-01e9-0310-a592-d414129be87e

Ahem; let's have all the man page headings at the same level!

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4045 cda61777-01e9-0310-a592-d414129be87e

Add a horrid md5sum manifest mechanism similar to the one I used in
the Unix PuTTY archive, to automatically generate version numbers
for Halibut release builds.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4044 cda61777-01e9-0310-a592-d414129be87e

Add installation instructions.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4043 cda61777-01e9-0310-a592-d414129be87e

Add a man page.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4042 cda61777-01e9-0310-a592-d414129be87e

Jacob pointed out various important facts missing from the Halibut
manual. Added them.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4038 cda61777-01e9-0310-a592-d414129be87e

Limit unicode hex to 4 digits

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4036 cda61777-01e9-0310-a592-d414129be87e

Stop \n clobbering \nocite (etc)
Comments

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4035 cda61777-01e9-0310-a592-d414129be87e

Add stuff to butCmd para so that constructs like \c don't break inside
\quote{...}

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4034 cda61777-01e9-0310-a592-d414129be87e

Restrict characters allowed in commands -- deals with "\date)."
Comments

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4033 cda61777-01e9-0310-a592-d414129be87e

Oops, fix bracing comment stuff.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4032 cda61777-01e9-0310-a592-d414129be87e

Inline comments respect escaped braces.
Special handling for \U so that it works. Tweak \title.
Make butTextArg transparent so that emphasis (e.g. in a header) shows
through.
Comment tweaks.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4031 cda61777-01e9-0310-a592-d414129be87e

typo

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4030 cda61777-01e9-0310-a592-d414129be87e

GCC 3.0 doesn't like you not including <string.h> if you use things in it.
We do, so let's.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4029 cda61777-01e9-0310-a592-d414129be87e

For some reason I decided it was better to say `output format'
consistently in the documentation than to confuse matters by saying
`back end'. One rogue back end removed.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4028 cda61777-01e9-0310-a592-d414129be87e

Forgot to mention the default behaviour is to run all backends.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4027 cda61777-01e9-0310-a592-d414129be87e

Help and usage messages.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4026 cda61777-01e9-0310-a592-d414129be87e

Make the command-line --licence option do something useful.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4025 cda61777-01e9-0310-a592-d414129be87e

Having done all these command-line options and new \cfg directives,
I'd better document them...

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4024 cda61777-01e9-0310-a592-d414129be87e

Homogenise the licence, and bring it up to date.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4023 cda61777-01e9-0310-a592-d414129be87e

Now I've got a mechanism for formatting HTML file names to a
parametric template, reuse the same mechanism to allow the <a
name="..."> markers on each section to be parametrised as well. That
way, any user who so desires can arrange for everything in a section
URL to be constructed from internal keywords, making it pretty
robust against section numbering changes.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4019 cda61777-01e9-0310-a592-d414129be87e

Arrange a mechanism whereby each backend can be passed a filename
from its command-line option (`--text=foo.txt') and automatically
convert it into one or more notional \cfg directives. In the HTML
case this mechanism enables single-file mode as well as setting the
filename.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4018 cda61777-01e9-0310-a592-d414129be87e

Add \cfg / -C directives to allow the user to choose the output file
name (or name schema, in HTML).

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4017 cda61777-01e9-0310-a592-d414129be87e

Fix a couple of memory leaks in backends.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4016 cda61777-01e9-0310-a592-d414129be87e

Oops, appendices.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4015 cda61777-01e9-0310-a592-d414129be87e

Initial revision

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4014 cda61777-01e9-0310-a592-d414129be87e

Add the -C command-line option, which allows arbitrary \cfg
directives to be supplied on the Halibut command line.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4013 cda61777-01e9-0310-a592-d414129be87e

Make a start on command-line options. Here I introduce --text,
--html, --winhelp and --man (plus spelling variations :-), which
allow you to choose to run only a subset of backends.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4012 cda61777-01e9-0310-a592-d414129be87e

Oops; uninitialised variable.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4011 cda61777-01e9-0310-a592-d414129be87e

After so much fuss was made about this being an _XHTML_ back end
rather than merely HTML, I thought it might be instructive to run it
through the W3C's XHTML validator. Consequent changes in this
checkin...

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4010 cda61777-01e9-0310-a592-d414129be87e

Bah, there's always one. Missing file.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4007 cda61777-01e9-0310-a592-d414129be87e

\lcont and \quote were being confused by whitespace (in particular,
a single newline) immediately after their opening brace; this was
causing a normal paragraph to be started, thus making it fiddly and
annoying to arrange the first paragraph of a \lcont to be a code
para or anything else special. Now fixed.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4005 cda61777-01e9-0310-a592-d414129be87e

Fix index sorting so that it collates in a sensible order.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4004 cda61777-01e9-0310-a592-d414129be87e

Make \ii work!

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4003 cda61777-01e9-0310-a592-d414129be87e

The navigation links now contain a link to the index page.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4002 cda61777-01e9-0310-a592-d414129be87e

Simplify treatment of the copyright notice, now I've also simplified
the preamble: \copyright paragraphs are now treated identically to
normal paragraphs (so they appear precisely where they're put
instead of in a fixed location), _except_ that the Windows Help
backend also copies their text into the help file's copyright slot.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4001 cda61777-01e9-0310-a592-d414129be87e

I always meant to remove emphasis in the index by default. Now I do
so. It's restorable using \IM.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@4000 cda61777-01e9-0310-a592-d414129be87e

The manual is now fully indexed.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@3999 cda61777-01e9-0310-a592-d414129be87e

Couple of extra points: forgot about the \i\cw special case, and
Jacob points out that I didn't specify whether inline formatting
commands can surround line breaks (they can).

git-svn-id: svn://svn.tartarus.org/sgt/halibut@3994 cda61777-01e9-0310-a592-d414129be87e

Fix bug in HTML index generation: any index tags appearing in a
section title (which is not remotely unreasonable) got index
references added to them not only when the section title was
processed as part of its section, but also when it was processed as
part of contents navigation displays - in which situation it tended
to cause a link to, for example, the last section in the _previous_
file. Now we keep constant track of whether or not we're supposed to
be indexing things as we process text.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@3991 cda61777-01e9-0310-a592-d414129be87e

Second instalment of the manual: added a chapter on output formats.
I _think_ the manual now contains all the information a user should
need, even if not yet in an optimal order for a beginner to learn
from.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@3989 cda61777-01e9-0310-a592-d414129be87e

Introduce \. as a NOP command. The purpose of this is to act as a
zero-width delimiter between a macro invocation and text beyond it,
so that you can define (say) a macro which expands to a Euro sign
and then write `\eur\.2500' to avoid having space between the Euro
sign and the number.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@3982 cda61777-01e9-0310-a592-d414129be87e

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.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@3981 cda61777-01e9-0310-a592-d414129be87e

First instalment of a manual for Halibut. This lot covers the
(nearly nonexistent) invocation syntax and the input format.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@3979 cda61777-01e9-0310-a592-d414129be87e

Add a \quote{...} directive, working like <blockquote> in HTML.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@3978 cda61777-01e9-0310-a592-d414129be87e

Apparently we must include the .TH directive in a man page even when
there's nothing to go in it.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@3977 cda61777-01e9-0310-a592-d414129be87e

Cleanups to complete the man page backend. Also, an additional new
markup feature: a \c line in a code paragraph can now be followed by
an optional \e line indicating emphasised bits of its preceding \c.
This allows discretionary bolding and (italic/underline) emphasis
within code paragraphs, but without introducing an escape character
or breaking any existing input files. Users are warned that not all
backends are required to actually render these hints, and so they
should avoid depending on them 100% to convey semantic information
unless they know they're writing for a restricted range of backends.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@3965 cda61777-01e9-0310-a592-d414129be87e

Oops, nearly forgot. Nesting one numbered list inside another should
not break the numbering of the outer one!

git-svn-id: svn://svn.tartarus.org/sgt/halibut@3955 cda61777-01e9-0310-a592-d414129be87e

Man-page back end for Halibut. Also, a couple of additional markup
features commonly used in man pages: (a) the ability to nest
paragraph breaks, code paragraphs and other lists inside list items,
and (b) description lists as normally used in man pages to describe
command-line options.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@3954 cda61777-01e9-0310-a592-d414129be87e

WinHelp backend segfaults when it finds a nonexistent cross-
reference. (The broken link will already have been reported in the
mid-end, but this won't inhibit output generation, so the onus is
still on us to at the very least not go *crash*.)

git-svn-id: svn://svn.tartarus.org/sgt/halibut@2507 cda61777-01e9-0310-a592-d414129be87e

Of course, when I start freeing things in response to valgrind's
complaints, it would probably help if I arranged that those things
had been _allocated_ in all cases, otherwise we merely exchange a
memory leak for a core dump. Duh.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@1916 cda61777-01e9-0310-a592-d414129be87e

Just had a play with this newfangled `valgrind' memory debugger
thingy, which seems moderately cool and has reported a few very
small memory leaks. Now apparently fixed.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@1863 cda61777-01e9-0310-a592-d414129be87e

Add configurability for section heading formats, in much the same
way as bk_text already does it (you can choose to have or not have
the "Section" at the start, and you can configure the suffix between
number and title).

git-svn-id: svn://svn.tartarus.org/sgt/halibut@1839 cda61777-01e9-0310-a592-d414129be87e

Add configurability for the suffix after the section number and
before the section title (the ": " in "Section 1: Introduction").

git-svn-id: svn://svn.tartarus.org/sgt/halibut@1838 cda61777-01e9-0310-a592-d414129be87e

Arrange for multiple \cfg, \IM and \BR paragraphs to not require
blank-line separators (config directives visually _want_ to be in a
single chunk).

git-svn-id: svn://svn.tartarus.org/sgt/halibut@1837 cda61777-01e9-0310-a592-d414129be87e

Fix the bug in the text back end whereby bulletted paragraphs' width
failed to be decreased to compensate for the additional indent.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@1834 cda61777-01e9-0310-a592-d414129be87e

Add `topclean' target to the top-level Makefile, to remove the
output from running Halibut on a test input file.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@1833 cda61777-01e9-0310-a592-d414129be87e

Slightly improve the handling of headings in HTML single-file mode.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@1832 cda61777-01e9-0310-a592-d414129be87e

Upgrade to Halibut xhtml backend, to allow leaf_level to be zero (in
which case the whole of the HTML output will be in a single file,
currently called Manual.html in the absence of configurability).
This includes the index, if present.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@1831 cda61777-01e9-0310-a592-d414129be87e

Rename Buttress to Halibut. I _think_ I've caught everything in this pass.

git-svn-id: svn://svn.tartarus.org/sgt/halibut@1800 cda61777-01e9-0310-a592-d414129be87e