File: README

package info (click to toggle)
bhl 1.7.3-2
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 580 kB
  • sloc: lisp: 3,662; sh: 129; makefile: 92
file content (81 lines) | stat: -rw-r--r-- 2,164 bytes parent folder | download | duplicates (3)
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
The BHL mode

--- Table of contents

 1. What is BHL?
 2. Install BHL
 3. Contact

--- End of the table of contents

This is the  README file of the BHL mode.
This  File is better viewed with the BHL mode.

Last update: 07/03/2003.

1. What is BHL?

BHL is an Emacs mode that enables you to convert brut text files into
HTML, LaTeX and SGML files.  "BHL" is an acronym for: "from *B*rut to
*H*tml and *L*aTeX" (SGML was implemented later).

In order to convert TXT files into other formats, you need to use some
syntactical elements.  The purpose of this mode is to use the most
_invisible_ and _convenient_ syntax.  By *invisible syntax*, I mean
that the source file must be as readable as possible (like any TXT
file must be).  By *convenient syntax*, I mean that the syntax must
fit user's habits.

Here's a list of syntactical elements that BHL handles:

	* title, sections, subsections, subsubsections;
	* bold, emphasis, underlign, bold-italic;
	* lists (nested, ordered, non-ordered, description lists);
	* tables;
	* comments;
	* images (only in the html output);
	* URLs;
	* horizontal rules;
	* footnotes;
	* special chars;
	* quote, verbatim and minipage environments.

BHL handles also a _table of contents_: you can insert the table of
contents of the working file, browse the toc in a new buffer, and
update the numbering of sections with just one keystroke.

2. Install BHL

Edit the _Makefile_. Set the load-path of your elisp files, etc.

When you're ok with the _Makefile_, type in your shell:

	* ~$ make
	* ~$ make install
	* ~$ make info
	* ~$ make install-info
	* ~$ make pdf

You may have to edit the `dir' file in the info path.

This installation procedure will also install some scripts from the
`contrib' directory.  These scripts allow you to perform the core
conversion functions of BHL from a shell.  Thanks to D. Katz for these
contribs. 

3. Contact

The URL of the BHL homepage is:

	* http://www.nongnu.org/bhl

The project pages of bhl are:

	* http://sv.nongnu.org/projects/bhl
	* http://sv.nongnu.org/download/bhl

Please feel free to mail me any bug report or suggestion:

	* mailto:bastien1NOSPAM@free.fr

==Bastien Guerry==