summaryrefslogtreecommitdiff
path: root/app/tools/halibut/README
blob: b602834178442f60f08ab065a72dd5a31965a2e7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
HALIBUT Readme
==============

This version of Halibut has been adapted to the needs of the XTrkCad
Project. It is based on version 1 of Halibut. 

The original version is available at:

http://www.chiark.greenend.org.uk/~sgtatham/halibut/

This site also has the full documentation.

XTrkCad Modifications
---------------------

The following changes have been made:

1. Backends - only the HTML backend is included

2. \f: Emphasize more
	This formating instruction is similar to the \e. It is usually rendered
	as bold on HTML
	
	Example: Here is some \f{bold text}.
	
	Nesting of \e and \f is unsupported.
	
3 \G: Include graphic
	This instruction is used to include bitmaps into the document. Note that
	there are no checks for presence of the file nor whether its a valid
	graphics format. 
	
	\G just takes the filename as a parameter.
	
	Example: Include a bitmap here \G{png.d/bitmap.png}.