Generate NSIS documentation with original halibut

f0rt · 26th July 2009, 19:51

I tried my luck to generate the NSIS documentation with the original halibut (version 1.0) tool.
http://www.chiark.greenend.org.uk/~sgtatham/halibut

I was able to retain most of the layout and formatting from the original documentation except the free text cross reference and relative links in the CHM format.

The modifications itself are documented in the following
tracker item:
http://sf.net/support/tracker.php?aid=1651225

I would appreciate your feedback regarding these modifications.

Halibut is a simple but efficient documentation tool.
Have there been any ideas and thoughts switching to another documentation tool?

kichik · 3rd August 2009, 08:56

Awesome! It would be great if you can finally move to cutting edge. And if all that's left is adding a free text cross reference patch, it should be easy enough. Simon has shown interest in the past to include our patches.

f0rt · 4th August 2009, 18:09

I adapted the patch so it could be applied to the latest code base (SVN revision 5997):
alioth.debian.org/~thomaz-guest/nsis/01-docs_via_std_halibut_svn5997.dpatch.gz

Please be aware that I replaced free text cross reference \R with \K,
e.g. \R{license}{license} with license [\K{license}] resulting in license [Appendix I].

So that might be something to revert if the author of halibut accepts patches to support the free text cross reference.

The output for the CHM format would also need further fine tuning.

kichik · 4th August 2009, 21:05

Ah right, there was also the CHM patches. The links don't work because \W is not the same as \L. One of them is local link. With the CHM configuration, those links get special treatment so they'd actually work.

26th July 2009, 19:51	#1
f0rt Junior Member Join Date: Jul 2009 Posts: 33	Generate NSIS documentation with original halibut I tried my luck to generate the NSIS documentation with the original halibut (version 1.0) tool. http://www.chiark.greenend.org.uk/~sgtatham/halibut I was able to retain most of the layout and formatting from the original documentation except the free text cross reference and relative links in the CHM format. The modifications itself are documented in the following tracker item: http://sf.net/support/tracker.php?aid=1651225 I would appreciate your feedback regarding these modifications. Halibut is a simple but efficient documentation tool. Have there been any ideas and thoughts switching to another documentation tool?

3rd August 2009, 08:56	#2
kichik M.I.A. [NSIS Dev, Mod] Join Date: Oct 2001 Location: Israel Posts: 11,337	Awesome! It would be great if you can finally move to cutting edge. And if all that's left is adding a free text cross reference patch, it should be easy enough. Simon has shown interest in the past to include our patches. NSIS FAQ \| NSIS Home Page \| Donate $ "I hear and I forget. I see and I remember. I do and I understand." -- Confucius

4th August 2009, 21:05	#4
kichik M.I.A. [NSIS Dev, Mod] Join Date: Oct 2001 Location: Israel Posts: 11,337	Ah right, there was also the CHM patches. The links don't work because \W is not the same as \L. One of them is local link. With the CHM configuration, those links get special treatment so they'd actually work. NSIS FAQ \| NSIS Home Page \| Donate $ "I hear and I forget. I see and I remember. I do and I understand." -- Confucius

Thread Tools	Search this Thread
Show Printable Version Email this Page	Search this Thread: Advanced Search
Display Modes
Linear Mode Switch to Hybrid Mode Switch to Threaded Mode

4th August 2009, 18:09	#3
f0rt Junior Member Join Date: Jul 2009 Posts: 33	I adapted the patch so it could be applied to the latest code base (SVN revision 5997): alioth.debian.org/~thomaz-guest/nsis/01-docs_via_std_halibut_svn5997.dpatch.gz Please be aware that I replaced free text cross reference \R with \K, e.g. \R{license}{license} with license [\K{license}] resulting in license [Appendix I]. So that might be something to revert if the author of halibut accepts patches to support the free text cross reference. The output for the CHM format would also need further fine tuning.