<feed xmlns='http://www.w3.org/2005/Atom'>
<title>halibut/doc/intro.but, branch master</title>
<subtitle>My halibut tree</subtitle>
<link rel='alternate' type='text/html' href='https://www.franklinwei.com/cgit/halibut/'/>
<entry>
<title>New output mode to write CHM files directly.</title>
<updated>2017-05-13T17:37:04+00:00</updated>
<author>
<name>Simon Tatham</name>
<email>anakin@pobox.com</email>
</author>
<published>2017-05-13T17:33:51+00:00</published>
<link rel='alternate' type='text/html' href='https://www.franklinwei.com/cgit/halibut/commit/?id=7e330bca5bc45fa7feb6c31da5c3f1b6b44c208c'/>
<id>7e330bca5bc45fa7feb6c31da5c3f1b6b44c208c</id>
<content type='text'>
I became aware a few months ago that enough is known about CHM files
that free software _can_ write them without benefit of the MS HTML
Help compiler - in particular there's a thing called 'chmcmd' in the
Free Pascal Compiler software distribution which is more or less a
drop-in replacement for hhc.exe itself.

But although depending on chmcmd would be a bit nicer than depending
on hhc.exe, Halibut has always preferred to do the whole job itself if
it can. So here's my own from-scratch code to generate CHM directly
from Halibut source.

The new output mode is presented as a completely separate top-level
thing independent of HTML mode. Of course, in reality, the two back
ends share all of the HTML-generation code, differing only in a few
configuration defaults and the minor detail of what will be _done_
with each chunk of HTML as it's generated (this is what the recent
refactoring in b3db1cce3 was in aid of). But even so, the output modes
are properly independent from a user-visible-behaviour perspective:
they use parallel sets of config directives rather than sharing the
same ones (you can set \cfg{html-foo} and \cfg{chm-foo} independently,
for a great many values of 'foo'), and you can run either or neither
or both as you choose in a given run of Halibut.

The old HTML Help support, in the form of some config directives for
HTML mode to output the auxiliary files needed by hhc.exe, is still
around and should still work the same as it always did. I have no real
intention of removing it, partly for the reasons stated in the manual
(someone might find it useful to have Halibut generate the .HHP file
once and then make manual adjustments to it, so that they can change
styling options that the direct CHM output doesn't permit), and mostly
because it wouldn't save a great deal of code or complexity in any
case - the big two of the three auxiliary files (the HHC and HHK) have
to be generated _anyway_ to go inside the .CHM, so all the code would
have to stay around regardless.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
I became aware a few months ago that enough is known about CHM files
that free software _can_ write them without benefit of the MS HTML
Help compiler - in particular there's a thing called 'chmcmd' in the
Free Pascal Compiler software distribution which is more or less a
drop-in replacement for hhc.exe itself.

But although depending on chmcmd would be a bit nicer than depending
on hhc.exe, Halibut has always preferred to do the whole job itself if
it can. So here's my own from-scratch code to generate CHM directly
from Halibut source.

The new output mode is presented as a completely separate top-level
thing independent of HTML mode. Of course, in reality, the two back
ends share all of the HTML-generation code, differing only in a few
configuration defaults and the minor detail of what will be _done_
with each chunk of HTML as it's generated (this is what the recent
refactoring in b3db1cce3 was in aid of). But even so, the output modes
are properly independent from a user-visible-behaviour perspective:
they use parallel sets of config directives rather than sharing the
same ones (you can set \cfg{html-foo} and \cfg{chm-foo} independently,
for a great many values of 'foo'), and you can run either or neither
or both as you choose in a given run of Halibut.

The old HTML Help support, in the form of some config directives for
HTML mode to output the auxiliary files needed by hhc.exe, is still
around and should still work the same as it always did. I have no real
intention of removing it, partly for the reasons stated in the manual
(someone might find it useful to have Halibut generate the .HHP file
once and then make manual adjustments to it, so that they can change
styling options that the direct CHM output doesn't permit), and mostly
because it wouldn't save a great deal of code or complexity in any
case - the big two of the three auxiliary files (the HHC and HHK) have
to be generated _anyway_ to go inside the .CHM, so all the code would
have to stay around regardless.
</pre>
</div>
</content>
</entry>
<entry>
<title>Remove Subversion expanded keywords everywhere.</title>
<updated>2014-09-24T10:32:41+00:00</updated>
<author>
<name>Simon Tatham</name>
<email>anakin@pobox.com</email>
</author>
<published>2014-09-24T10:32:41+00:00</published>
<link rel='alternate' type='text/html' href='https://www.franklinwei.com/cgit/halibut/commit/?id=aa2709b2fdd600b9300c52eb534d13672a572239'/>
<id>aa2709b2fdd600b9300c52eb534d13672a572239</id>
<content type='text'>
The \versionids in the docs are now added by the bob script; the one
in inputs/test.but has been replaced by fixed text (it didn't matter
what it contained anyway, of course, for test purposes), and the one
in misc/halibut.vim has simply been removed (it wasn't actually
expanded by svn anyway - it still had its old CVS value).

[originally from svn r10253]
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
The \versionids in the docs are now added by the bob script; the one
in inputs/test.but has been replaced by fixed text (it didn't matter
what it contained anyway, of course, for test purposes), and the one
in misc/halibut.vim has simply been removed (it wasn't actually
expanded by svn anyway - it still had its old CVS value).

[originally from svn r10253]
</pre>
</div>
</content>
</entry>
<entry>
<title>GNU manuals are fairly clear that "Info" is spelt in mixed case and set</title>
<updated>2007-04-08T00:17:52+00:00</updated>
<author>
<name>Ben Harris</name>
<email>bjh21@bjh21.me.uk</email>
</author>
<published>2007-04-08T00:17:52+00:00</published>
<link rel='alternate' type='text/html' href='https://www.franklinwei.com/cgit/halibut/commit/?id=ac6717da27f479e197ba4bec763bc1fa571f909e'/>
<id>ac6717da27f479e197ba4bec763bc1fa571f909e</id>
<content type='text'>
in a Roman font.  Follow suit.

[originally from svn r7450]
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
in a Roman font.  Follow suit.

[originally from svn r7450]
</pre>
</div>
</content>
</entry>
<entry>
<title>Support for the MS HTML Help system in the HTML back end. As yet I</title>
<updated>2006-12-11T19:43:10+00:00</updated>
<author>
<name>Simon Tatham</name>
<email>anakin@pobox.com</email>
</author>
<published>2006-12-11T19:43:10+00:00</published>
<link rel='alternate' type='text/html' href='https://www.franklinwei.com/cgit/halibut/commit/?id=7a4700f5f5afcea1580ec4fcfb628afe6beb3e6b'/>
<id>7a4700f5f5afcea1580ec4fcfb628afe6beb3e6b</id>
<content type='text'>
don't know how to write out a .CHM directly, but I am at least able
to have the HTML back end write out the three auxiliary files which
enable a .CHM to be generated using the MS HTML Help compiler.

[originally from svn r6991]
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
don't know how to write out a .CHM directly, but I am at least able
to have the HTML back end write out the three auxiliary files which
enable a .CHM to be generated using the MS HTML Help compiler.

[originally from svn r6991]
</pre>
</div>
</content>
</entry>
<entry>
<title>Mention PDF before PostScript everywhere, partly because PDF is the</title>
<updated>2006-12-09T15:02:32+00:00</updated>
<author>
<name>Ben Harris</name>
<email>bjh21@bjh21.me.uk</email>
</author>
<published>2006-12-09T15:02:32+00:00</published>
<link rel='alternate' type='text/html' href='https://www.franklinwei.com/cgit/halibut/commit/?id=3a989950162ce14a357e1ae49f767e604efe509b'/>
<id>3a989950162ce14a357e1ae49f767e604efe509b</id>
<content type='text'>
dominant format for print-oriented documents, but mostly because it's
hard to mention pdfmark without having mentioned PDF already.

Also mention pdfmark.

[originally from svn r6975]
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
dominant format for print-oriented documents, but mostly because it's
hard to mention pdfmark without having mentioned PDF already.

Also mention pdfmark.

[originally from svn r6975]
</pre>
</div>
</content>
</entry>
<entry>
<title>Add \versionid.</title>
<updated>2005-02-17T22:20:32+00:00</updated>
<author>
<name>Jacob Nevins</name>
<email>jacobn@chiark.greenend.org.uk</email>
</author>
<published>2005-02-17T22:20:32+00:00</published>
<link rel='alternate' type='text/html' href='https://www.franklinwei.com/cgit/halibut/commit/?id=f832d3e02171bb43e3ba9e4330257e4e9de2128c'/>
<id>f832d3e02171bb43e3ba9e4330257e4e9de2128c</id>
<content type='text'>
[originally from svn r5338]
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
[originally from svn r5338]
</pre>
</div>
</content>
</entry>
<entry>
<title>... oh, except that minimal documentation might be helpful.</title>
<updated>2004-04-14T18:14:41+00:00</updated>
<author>
<name>Simon Tatham</name>
<email>anakin@pobox.com</email>
</author>
<published>2004-04-14T18:14:41+00:00</published>
<link rel='alternate' type='text/html' href='https://www.franklinwei.com/cgit/halibut/commit/?id=d7e234693f1eb9d0aafb251e1e4e7999ec8b3cfa'/>
<id>d7e234693f1eb9d0aafb251e1e4e7999ec8b3cfa</id>
<content type='text'>
[originally from svn r4075]
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
[originally from svn r4075]
</pre>
</div>
</content>
</entry>
<entry>
<title>Add documentation for the info backend.</title>
<updated>2004-04-10T09:48:28+00:00</updated>
<author>
<name>Simon Tatham</name>
<email>anakin@pobox.com</email>
</author>
<published>2004-04-10T09:48:28+00:00</published>
<link rel='alternate' type='text/html' href='https://www.franklinwei.com/cgit/halibut/commit/?id=662f8ee7b6ba45a226b2f11ebd35805a33651762'/>
<id>662f8ee7b6ba45a226b2f11ebd35805a33651762</id>
<content type='text'>
[originally from svn r4052]
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
[originally from svn r4052]
</pre>
</div>
</content>
</entry>
<entry>
<title>First instalment of a manual for Halibut. This lot covers the</title>
<updated>2004-03-25T18:33:02+00:00</updated>
<author>
<name>Simon Tatham</name>
<email>anakin@pobox.com</email>
</author>
<published>2004-03-25T18:33:02+00:00</published>
<link rel='alternate' type='text/html' href='https://www.franklinwei.com/cgit/halibut/commit/?id=187d4791fd0873b4058b381aa3d3a591b846463e'/>
<id>187d4791fd0873b4058b381aa3d3a591b846463e</id>
<content type='text'>
(nearly nonexistent) invocation syntax and the input format.

[originally from svn r3979]
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
(nearly nonexistent) invocation syntax and the input format.

[originally from svn r3979]
</pre>
</div>
</content>
</entry>
</feed>
