<feed xmlns='http://www.w3.org/2005/Atom'>
<title>halibut/doc/output.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>Typo fix in the docs.</title>
<updated>2014-08-11T18:41:10+00:00</updated>
<author>
<name>Simon Tatham</name>
<email>anakin@pobox.com</email>
</author>
<published>2014-08-11T18:41:10+00:00</published>
<link rel='alternate' type='text/html' href='https://www.franklinwei.com/cgit/halibut/commit/?id=9aee9eb51dbf4b3156d0e893b1f97596bab85deb'/>
<id>9aee9eb51dbf4b3156d0e893b1f97596bab85deb</id>
<content type='text'>
Also from J. Lewis Muir.

[originally from svn r10213]
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Also from J. Lewis Muir.

[originally from svn r10213]
</pre>
</div>
</content>
</entry>
<entry>
<title>Add \s for 'strong' text, i.e. bold rather than italics. I've missed</title>
<updated>2013-03-10T16:58:01+00:00</updated>
<author>
<name>Simon Tatham</name>
<email>anakin@pobox.com</email>
</author>
<published>2013-03-10T16:58:01+00:00</published>
<link rel='alternate' type='text/html' href='https://www.franklinwei.com/cgit/halibut/commit/?id=dcf080aa0e011de37a154e9e8a97dd7546a4a1b1'/>
<id>dcf080aa0e011de37a154e9e8a97dd7546a4a1b1</id>
<content type='text'>
this a couple of times in Halibut markup recently (in particular, it's
handy to have a typographical distinction between 'this term is
emphasised because it's new' and 'this term is emphasised because I
want you to pay attention to it'), so here's an implementation,
basically parallel to \e.

One slight oddity is that strong text in headings will not be
distinguished in some output formats, since they already use bolded
text for their headings.

[originally from svn r9772]
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
this a couple of times in Halibut markup recently (in particular, it's
handy to have a typographical distinction between 'this term is
emphasised because it's new' and 'this term is emphasised because I
want you to pay attention to it'), so here's an implementation,
basically parallel to \e.

One slight oddity is that strong text in headings will not be
distinguished in some output formats, since they already use bolded
text for their headings.

[originally from svn r9772]
</pre>
</div>
</content>
</entry>
<entry>
<title>Fix missing docs for \cfg{paper-contents-indent-step} and</title>
<updated>2009-01-20T18:50:18+00:00</updated>
<author>
<name>Simon Tatham</name>
<email>anakin@pobox.com</email>
</author>
<published>2009-01-20T18:50:18+00:00</published>
<link rel='alternate' type='text/html' href='https://www.franklinwei.com/cgit/halibut/commit/?id=e5c863517af2d2faeec6f87540165766237f9b55'/>
<id>e5c863517af2d2faeec6f87540165766237f9b55</id>
<content type='text'>
\cfg{paper-contents-margin}. Also correct the spelling of the
former.

[originally from svn r8424]
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
\cfg{paper-contents-margin}. Also correct the spelling of the
former.

[originally from svn r8424]
</pre>
</div>
</content>
</entry>
<entry>
<title>Cut-and-paste error: reference to "man page" in Windows Help section.</title>
<updated>2008-11-23T15:05:19+00:00</updated>
<author>
<name>Jacob Nevins</name>
<email>jacobn@chiark.greenend.org.uk</email>
</author>
<published>2008-11-23T15:05:19+00:00</published>
<link rel='alternate' type='text/html' href='https://www.franklinwei.com/cgit/halibut/commit/?id=8bfb2c177992712467fe7ce994fac518d713c3ad'/>
<id>8bfb2c177992712467fe7ce994fac518d713c3ad</id>
<content type='text'>
[originally from svn r8320]
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
[originally from svn r8320]
</pre>
</div>
</content>
</entry>
<entry>
<title>New option *-section-shownumber, alongside *-section-numeric and in</title>
<updated>2008-02-25T19:36:12+00:00</updated>
<author>
<name>Simon Tatham</name>
<email>anakin@pobox.com</email>
</author>
<published>2008-02-25T19:36:12+00:00</published>
<link rel='alternate' type='text/html' href='https://www.franklinwei.com/cgit/halibut/commit/?id=0d791fb645abb77b339d90c95882ef315d1f912c'/>
<id>0d791fb645abb77b339d90c95882ef315d1f912c</id>
<content type='text'>
both the back ends which currently support that, to leave out
chapter and section numbers totally in section headings. Can be
useful for publishing man pages (which don't normally want section
numbers) on the web.

[originally from svn r7892]
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
both the back ends which currently support that, to leave out
chapter and section numbers totally in section headings. Can be
useful for publishing man pages (which don't normally want section
numbers) on the web.

[originally from svn r7892]
</pre>
</div>
</content>
</entry>
<entry>
<title>Typo.</title>
<updated>2007-12-02T11:41:21+00:00</updated>
<author>
<name>Simon Tatham</name>
<email>anakin@pobox.com</email>
</author>
<published>2007-12-02T11:41:21+00:00</published>
<link rel='alternate' type='text/html' href='https://www.franklinwei.com/cgit/halibut/commit/?id=9f1e64f3255128130020f9bb636e17234f8a3d69'/>
<id>9f1e64f3255128130020f9bb636e17234f8a3d69</id>
<content type='text'>
[originally from svn r7799]
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
[originally from svn r7799]
</pre>
</div>
</content>
</entry>
<entry>
<title>Add support for doing different underlining of different heading levels</title>
<updated>2007-04-08T11:16:23+00:00</updated>
<author>
<name>Ben Harris</name>
<email>bjh21@bjh21.me.uk</email>
</author>
<published>2007-04-08T11:16:23+00:00</published>
<link rel='alternate' type='text/html' href='https://www.franklinwei.com/cgit/halibut/commit/?id=9c83f06784539ca3a4dc6661542a11592e137f60'/>
<id>9c83f06784539ca3a4dc6661542a11592e137f60</id>
<content type='text'>
in the Info backend, with the defaults chosen to match what Emacs
recognises and renders prettily.

[originally from svn r7452]
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
in the Info backend, with the defaults chosen to match what Emacs
recognises and renders prettily.

[originally from svn r7452]
</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>
</feed>
