Commit | Line | Data |
---|---|---|
7fca93e2 | 1 | \input texinfo |
b55349fb GM |
2 | @comment %**start of header |
3 | @setfilename ../../info/htmlfontify | |
7fca93e2 | 4 | @settitle Htmlfontify User Manual |
7fca93e2 | 5 | @exampleindent 2 |
b55349fb GM |
6 | @comment %**end of header |
7 | ||
8 | @copying | |
9 | This manual documents Htmlfontify, a source code -> crosslinked + | |
10 | formatted + syntax colorised html transformer. | |
11 | ||
12 | Copyright @copyright{} 2002, 2003, 2013 Free Software Foundation, Inc. | |
13 | ||
14 | @quotation | |
15 | Permission is granted to copy, distribute and/or modify this document | |
16 | under the terms of the GNU Free Documentation License, Version 1.3 or | |
17 | any later version published by the Free Software Foundation; with no | |
18 | Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' | |
19 | and with the Back-Cover Texts as in (a) below. A copy of the license | |
20 | is included in the section entitled ``GNU Free Documentation License''. | |
21 | ||
22 | (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and | |
23 | modify this GNU manual.'' | |
24 | @end quotation | |
25 | @end copying | |
26 | ||
27 | @dircategory Emacs misc features | |
28 | @direntry | |
29 | * Htmlfontify: (htmlfontify). Convert source code to html. | |
30 | @end direntry | |
7fca93e2 VD |
31 | |
32 | @titlepage | |
33 | @title Htmlfontify User Manual | |
34 | @sp 4 | |
35 | @subtitle Htmlfontify version 0.20 | |
36 | @sp 1 | |
37 | @subtitle Jun 2002 | |
38 | @sp 5 | |
39 | @author Vivek Dasmohapatra | |
40 | @page | |
41 | ||
42 | @vskip 0pt plus 1filll | |
43 | @noindent | |
b55349fb GM |
44 | @insertcopying |
45 | @end titlepage | |
7fca93e2 | 46 | |
b55349fb | 47 | @contents |
7fca93e2 | 48 | |
b55349fb GM |
49 | @ifnottex |
50 | @node Top | |
51 | @top Htmlfontify | |
7fca93e2 | 52 | |
b55349fb GM |
53 | @insertcopying |
54 | @end ifnottex | |
7fca93e2 VD |
55 | |
56 | @menu | |
57 | * Introduction:: About Htmlfontify. | |
58 | * Usage & Examples:: How to use Htmlfontify. | |
b55349fb | 59 | * Customisation:: Fine-tuning Htmlfontify's behaviour. |
7fca93e2 | 60 | * Requirements:: External programs used by Htmlfontify. |
b55349fb GM |
61 | * GNU Free Documentation License:: The license for this documentation. |
62 | * Index:: Index of contents. | |
7fca93e2 VD |
63 | @end menu |
64 | ||
b55349fb | 65 | @node Introduction |
7fca93e2 VD |
66 | @chapter Introduction |
67 | @cindex Introduction | |
68 | ||
b55349fb GM |
69 | Htmlfontify provides a means of converting individual Emacs buffers, |
70 | source files, or entire source trees to html, preserving formatting | |
71 | and Emacs colorisation / syntax highlighting as much as possible | |
7fca93e2 VD |
72 | through careful application of CSS stylesheets and html tags. |
73 | ||
b55349fb GM |
74 | It can also turn instances of functions, methods and (for some |
75 | languages) variables and other constructs and items into links | |
76 | to their definitions, and create an index file (or files) of | |
7fca93e2 VD |
77 | all such symbols, also linked to their points of definition. |
78 | ||
b55349fb GM |
79 | Htmlfontify also provides several customisation items, which should |
80 | allow it to mesh more-or-less seamlessly with various templating or | |
81 | publishing systems (in the event, for instance, that you don't want | |
82 | to produce the html pages directly). | |
7fca93e2 | 83 | |
b55349fb | 84 | @node Usage & Examples |
7fca93e2 VD |
85 | @chapter Usage & Examples |
86 | @cindex Usage & Examples | |
87 | ||
b55349fb GM |
88 | Htmlfontify can be used both interactively and as part of another |
89 | elisp function. If you're running it in a modern Emacs, it will also | |
90 | run when attached to a terminal (i.e., without X) or even when in | |
91 | batch mode. | |
7fca93e2 VD |
92 | |
93 | @menu | |
b55349fb GM |
94 | * Interactive:: Using Htmlfontify interactively. |
95 | * Non-interactive:: Using Htmlfontify from elisp. | |
7fca93e2 | 96 | * Variables:: Variables (other than customisation entries). |
b55349fb GM |
97 | * Data Structures:: Important data structures. |
98 | * Examples:: Example(s) of Htmlfontify in use. | |
7fca93e2 VD |
99 | @end menu |
100 | ||
b55349fb | 101 | @node Interactive |
7fca93e2 VD |
102 | @section Interactive |
103 | @cindex Interactive | |
104 | @cindex functions (interactive) | |
105 | ||
106 | Htmlfontify provides the following interactive functions: | |
107 | ||
108 | @table @code | |
109 | @item htmlfontify-buffer | |
110 | @findex htmlfontify-buffer | |
111 | @anchor{htmlfontify-buffer} | |
112 | ||
113 | @lisp | |
114 | ||
115 | (htmlfontify-buffer &optional @var{srcdir} @var{file}) | |
116 | @end lisp | |
117 | ||
118 | Create a new buffer, named for the current buffer + a .html extension, | |
b55349fb GM |
119 | containing an inline CSS-stylesheet and formatted CSS-markup html that |
120 | reproduces the look of the current Emacs buffer as closely as possible. | |
7fca93e2 | 121 | |
b55349fb GM |
122 | ``Dangerous'' characters in the existing buffer are turned into html |
123 | entities, so you should even be able to do html-within-html fontified | |
124 | display. | |
7fca93e2 VD |
125 | |
126 | You should, however, note that random control or eight-bit characters | |
127 |