Re: [exim-dev] Standardizing the Exim documentation

Top Page
Delete this message
Reply to this message
Author: Philip Hazel
Date:  
To: Nigel Metheringham
CC: exim-dev, Nico Erfurth
Subject: Re: [exim-dev] Standardizing the Exim documentation
On Thu, 4 Nov 2004, Nigel Metheringham wrote:

> I've put a shortish chunk in following on from the next line. Lines may
> have additionally wrapped.


Note that SGCAL input is very soft. The markup used for Exim is in a
private "style" - the equivalent of a private DTD if you like. For
example:

> Every message handled by Exim is given a \*message id*\ which is sixteen
> characters long. It is divided into three parts, separated by hyphens, for
> example \"16VDhn-0001bo-D3"\.


I have chosen to use \*....*\ to mean "emphasized text" and \"...."\ to
mean "fixed pitch font or put in quotes (depending on output format)".
The SGCAL header file for the Exim documentation contains definitions as
to what to do with this markup when the document is processed. For HTML
and PS output, the first of those becomes italic and the second a
fixed-pitch font; for text output, the first is ignored and the second
becomes quoted.

> .index pid (process id)||re-use of


Likewise, the use of || to separate primary and secondary index terms is
my choice. SGCAL just spits out the index information; I have a Perl
script that processes it (into further SGCAL input).

If people want to take a serious look at SGCAL, I can make a tarball
available. It is, however, quite old code now, and I was not expecting
it to be developed further.

Philip

-- 
Philip Hazel            University of Cambridge Computing Service,
ph10@???      Cambridge, England. Phone: +44 1223 334714.