diff options
| author | Paul Eggert | 2013-01-09 00:17:47 -0800 |
|---|---|---|
| committer | Paul Eggert | 2013-01-09 00:17:47 -0800 |
| commit | 677d5c928c0da0fd0b3172d2ea023bc73777a06c (patch) | |
| tree | cf7e210fb57613c89efcb184f3c9b1b86fdb40a9 /doc | |
| parent | b84e3dda5b63822f233732174f63e4854ca3f878 (diff) | |
| download | emacs-677d5c928c0da0fd0b3172d2ea023bc73777a06c.tar.gz emacs-677d5c928c0da0fd0b3172d2ea023bc73777a06c.zip | |
Spelling fixes.
* lisp/net/tramp-adb.el (tramp-adb-get-toolbox):
Fix misspelling of 'unknown'.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/misc/htmlfontify.texi | 49 |
1 files changed, 25 insertions, 24 deletions
diff --git a/doc/misc/htmlfontify.texi b/doc/misc/htmlfontify.texi index 911cdd3cd5f..6cb8942bf15 100644 --- a/doc/misc/htmlfontify.texi +++ b/doc/misc/htmlfontify.texi | |||
| @@ -7,7 +7,7 @@ | |||
| 7 | 7 | ||
| 8 | @copying | 8 | @copying |
| 9 | This manual documents Htmlfontify, a source code -> crosslinked + | 9 | This manual documents Htmlfontify, a source code -> crosslinked + |
| 10 | formatted + syntax colorised html transformer. | 10 | formatted + syntax colorized html transformer. |
| 11 | 11 | ||
| 12 | Copyright @copyright{} 2002, 2003, 2013 Free Software Foundation, Inc. | 12 | Copyright @copyright{} 2002, 2003, 2013 Free Software Foundation, Inc. |
| 13 | 13 | ||
| @@ -56,7 +56,7 @@ modify this GNU manual.'' | |||
| 56 | @menu | 56 | @menu |
| 57 | * Introduction:: About Htmlfontify. | 57 | * Introduction:: About Htmlfontify. |
| 58 | * Usage & Examples:: How to use Htmlfontify. | 58 | * Usage & Examples:: How to use Htmlfontify. |
| 59 | * Customisation:: Fine-tuning Htmlfontify's behaviour. | 59 | * Customization:: Fine-tuning Htmlfontify's behaviour. |
| 60 | * Requirements:: External programs used by Htmlfontify. | 60 | * Requirements:: External programs used by Htmlfontify. |
| 61 | * GNU Free Documentation License:: The license for this documentation. | 61 | * GNU Free Documentation License:: The license for this documentation. |
| 62 | * Index:: Index of contents. | 62 | * Index:: Index of contents. |
| @@ -68,7 +68,7 @@ modify this GNU manual.'' | |||
| 68 | 68 | ||
| 69 | Htmlfontify provides a means of converting individual Emacs buffers, | 69 | Htmlfontify provides a means of converting individual Emacs buffers, |
| 70 | source files, or entire source trees to html, preserving formatting | 70 | source files, or entire source trees to html, preserving formatting |
| 71 | and Emacs colorisation / syntax highlighting as much as possible | 71 | and Emacs colorization / syntax highlighting as much as possible |
| 72 | through careful application of CSS stylesheets and html tags. | 72 | through careful application of CSS stylesheets and html tags. |
| 73 | 73 | ||
| 74 | It can also turn instances of functions, methods and (for some | 74 | It can also turn instances of functions, methods and (for some |
| @@ -76,7 +76,7 @@ languages) variables and other constructs and items into links | |||
| 76 | to their definitions, and create an index file (or files) of | 76 | to their definitions, and create an index file (or files) of |
| 77 | all such symbols, also linked to their points of definition. | 77 | all such symbols, also linked to their points of definition. |
| 78 | 78 | ||
| 79 | Htmlfontify also provides several customisation items, which should | 79 | Htmlfontify also provides several customization items, which should |
| 80 | allow it to mesh more-or-less seamlessly with various templating or | 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 | 81 | publishing systems (in the event, for instance, that you don't want |
| 82 | to produce the html pages directly). | 82 | to produce the html pages directly). |
| @@ -93,7 +93,7 @@ batch mode. | |||
| 93 | @menu | 93 | @menu |
| 94 | * Interactive:: Using Htmlfontify interactively. | 94 | * Interactive:: Using Htmlfontify interactively. |
| 95 | * Non-interactive:: Using Htmlfontify from elisp. | 95 | * Non-interactive:: Using Htmlfontify from elisp. |
| 96 | * Variables:: Variables (other than customisation entries). | 96 | * Variables:: Variables (other than customization entries). |
| 97 | * Data Structures:: Important data structures. | 97 | * Data Structures:: Important data structures. |
| 98 | * Examples:: Example(s) of Htmlfontify in use. | 98 | * Examples:: Example(s) of Htmlfontify in use. |
| 99 | @end menu | 99 | @end menu |
| @@ -236,7 +236,7 @@ color map specified, otherwise it uses Htmlfontify's built in map. | |||
| 236 | @end lisp | 236 | @end lisp |
| 237 | 237 | ||
| 238 | Return a @code{defface} style alist of possible specifications for | 238 | Return a @code{defface} style alist of possible specifications for |
| 239 | @var{face}, with any entries resulting from user customisation | 239 | @var{face}, with any entries resulting from user customization |
| 240 | (@code{custom-set-faces}) taking precedence. | 240 | (@code{custom-set-faces}) taking precedence. |
| 241 | 241 | ||
| 242 | See also: @ref{hfy-default-face-def} | 242 | See also: @ref{hfy-default-face-def} |
| @@ -268,10 +268,10 @@ does things like deferring fontification until a section of the buffer is | |||
| 268 | exposed and rendered, or until Emacs is idle for a while. Sometimes, in | 268 | exposed and rendered, or until Emacs is idle for a while. Sometimes, in |
| 269 | non-interactive circumstances, or if it can't see X, it doesn't bother | 269 | non-interactive circumstances, or if it can't see X, it doesn't bother |
| 270 | with some of the harder stuff. While this is all great from the perspective | 270 | with some of the harder stuff. While this is all great from the perspective |
| 271 | of a user waiting for Emacs to load a 20000 line file and colorise it, | 271 | of a user waiting for Emacs to load a 20000 line file and colorize it, |
| 272 | it's a pain from the point of view from non-interactive code. This function | 272 | it's a pain from the point of view from non-interactive code. This function |
| 273 | lies, cheats, steals and generally bullies Emacs into fontifying a buffer | 273 | lies, cheats, steals and generally bullies Emacs into fontifying a buffer |
| 274 | from start to finish, with all the extra frills, whether it thinks it nneds | 274 | from start to finish, with all the extra frills, whether it thinks it needs |
| 275 | to or not. Oh yes: it operates on the current buffer. | 275 | to or not. Oh yes: it operates on the current buffer. |
| 276 | 276 | ||
| 277 | @item hfy-link-style-string | 277 | @item hfy-link-style-string |
| @@ -861,7 +861,7 @@ As per @ref{hfy-color} but for background colors. | |||
| 861 | (hfy-kludge-cperl-mode) | 861 | (hfy-kludge-cperl-mode) |
| 862 | @end lisp | 862 | @end lisp |
| 863 | 863 | ||
| 864 | cperl mode does its damndest not to do some of its fontification when not | 864 | cperl mode does its best to not do some of its fontification when not |
| 865 | in a windowing system---we try to trick it@dots{} | 865 | in a windowing system---we try to trick it@dots{} |
| 866 | 866 | ||
| 867 | @item hfy-href | 867 | @item hfy-href |
| @@ -1044,7 +1044,7 @@ Convert an Emacs @code{:width} attribute to a CSS font-stretch attribute. | |||
| 1044 | @section Variables | 1044 | @section Variables |
| 1045 | @cindex variables | 1045 | @cindex variables |
| 1046 | 1046 | ||
| 1047 | Important variables that are not customisation items: | 1047 | Important variables that are not customization items: |
| 1048 | 1048 | ||
| 1049 | @table @code | 1049 | @table @code |
| 1050 | 1050 | ||
| @@ -1234,7 +1234,7 @@ main-content <=MAIN_CONTENT;\n" rtfm-section file style rtfm-section file)) | |||
| 1234 | 1234 | ||
| 1235 | ;; Here's the function I actually call---it asks me for a section label, | 1235 | ;; Here's the function I actually call---it asks me for a section label, |
| 1236 | ;; and source and destination directories, and then binds a couple of | 1236 | ;; and source and destination directories, and then binds a couple of |
| 1237 | ;; customisation variable in a let before calling htmlfontify: | 1237 | ;; customization variable in a let before calling htmlfontify: |
| 1238 | (defun rtfm-build-source-docs (section srcdir destdir) | 1238 | (defun rtfm-build-source-docs (section srcdir destdir) |
| 1239 | (interactive | 1239 | (interactive |
| 1240 | "s section[eg- emacs / p4-blame]:\nD source-dir: \nD output-dir: ") | 1240 | "s section[eg- emacs / p4-blame]:\nD source-dir: \nD output-dir: ") |
| @@ -1252,11 +1252,11 @@ main-content <=MAIN_CONTENT;\n" rtfm-section file style rtfm-section file)) | |||
| 1252 | (htmlfontify-copy-and-link-dir srcdir destdir ".src" ".html"))) | 1252 | (htmlfontify-copy-and-link-dir srcdir destdir ".src" ".html"))) |
| 1253 | @end lisp | 1253 | @end lisp |
| 1254 | 1254 | ||
| 1255 | @node Customisation | 1255 | @node Customization |
| 1256 | @chapter Customisation | 1256 | @chapter Customization |
| 1257 | @cindex variables (customisation) | 1257 | @cindex variables (customization) |
| 1258 | 1258 | ||
| 1259 | Htmlfontify provides the following variable and customisation entries: | 1259 | Htmlfontify provides the following variable and customization entries: |
| 1260 | 1260 | ||
| 1261 | @table @code | 1261 | @table @code |
| 1262 | @comment AUTOGENERATED BLOCK | 1262 | @comment AUTOGENERATED BLOCK |
| @@ -1394,7 +1394,7 @@ when @ref{hfy-display-class} has been set (the normal Htmlfontify way of | |||
| 1394 | extracting potentially non-current face information doesn't necessarily | 1394 | extracting potentially non-current face information doesn't necessarily |
| 1395 | work for @code{default}). | 1395 | work for @code{default}). |
| 1396 | 1396 | ||
| 1397 | For example, I customise this to: | 1397 | For example, I customize this to: |
| 1398 | 1398 | ||
| 1399 | @lisp | 1399 | @lisp |
| 1400 | ((t :background "black" :foreground "white" :family "misc-fixed")) | 1400 | ((t :background "black" :foreground "white" :family "misc-fixed")) |
| @@ -1405,7 +1405,7 @@ For example, I customise this to: | |||
| 1405 | @anchor{hfy-init-kludge-hooks} | 1405 | @anchor{hfy-init-kludge-hooks} |
| 1406 | 1406 | ||
| 1407 | List of functions to call when starting htmlfontify-buffer to do any | 1407 | List of functions to call when starting htmlfontify-buffer to do any |
| 1408 | kludging necessary to get highlighting modes to bahave as you want, even | 1408 | kludging necessary to get highlighting modes to behave as you want, even |
| 1409 | when not running under a window system. | 1409 | when not running under a window system. |
| 1410 | 1410 | ||
| 1411 | @item hfy-shell-file-name | 1411 | @item hfy-shell-file-name |
| @@ -1421,7 +1421,7 @@ Currently this is only required/used when using GNU etags, see | |||
| 1421 | @vindex hfy-optimisations | 1421 | @vindex hfy-optimisations |
| 1422 | @anchor{hfy-optimisations} | 1422 | @anchor{hfy-optimisations} |
| 1423 | 1423 | ||
| 1424 | Optimisations to turn on. So far, the following have been implemented: | 1424 | Optimizations to turn on. So far, the following have been implemented: |
| 1425 | 1425 | ||
| 1426 | @table @option | 1426 | @table @option |
| 1427 | @item merge-adjacent-tags | 1427 | @item merge-adjacent-tags |
| @@ -1454,7 +1454,8 @@ Suppress hyperlinking between files highlighted by different modes. | |||
| 1454 | 1454 | ||
| 1455 | @end table | 1455 | @end table |
| 1456 | 1456 | ||
| 1457 | Note: like compiler optimisations, these optimise the _output_ of the code, | 1457 | Note: like compiler optimizations, these optimize the @emph{output} of |
| 1458 | the code, | ||
| 1458 | not the processing of the source itself, and are therefore likely to slow | 1459 | not the processing of the source itself, and are therefore likely to slow |
| 1459 | Htmlfontify down, at least a little. Except for skip-refontification, | 1460 | Htmlfontify down, at least a little. Except for skip-refontification, |
| 1460 | which can never slow you down, but may result in incomplete fontification. | 1461 | which can never slow you down, but may result in incomplete fontification. |
| @@ -1470,7 +1471,7 @@ Regex to remove from the <style> a variant of an Htmlfontify CSS class. | |||
| 1470 | @anchor{hfy-link-extn} | 1471 | @anchor{hfy-link-extn} |
| 1471 | 1472 | ||
| 1472 | File extension used for href links---useful where the Htmlfontify | 1473 | File extension used for href links---useful where the Htmlfontify |
| 1473 | output files are going to be processed again, with a rersulting change | 1474 | output files are going to be processed again, with a resulting change |
| 1474 | in file extension. If @code{nil}, then any code using this should fall back | 1475 | in file extension. If @code{nil}, then any code using this should fall back |
| 1475 | to @ref{hfy-extn}. | 1476 | to @ref{hfy-extn}. |
| 1476 | 1477 | ||
| @@ -1570,16 +1571,16 @@ money are always welcome. | |||
| 1570 | 1571 | ||
| 1571 | @item | 1572 | @item |
| 1572 | A copy of etags (exuberant-ctags or GNU etags). Htmlfontify attempts | 1573 | A copy of etags (exuberant-ctags or GNU etags). Htmlfontify attempts |
| 1573 | to autodetect the version you have and customise itself accordingly, | 1574 | to autodetect the version you have and customize itself accordingly, |
| 1574 | but you should be able to override this. | 1575 | but you should be able to override this. |
| 1575 | 1576 | ||
| 1576 | See: @ref{Customisation} | 1577 | See: @ref{Customization} |
| 1577 | 1578 | ||
| 1578 | @item | 1579 | @item |
| 1579 | A copy of find (e.g., GNU find) that provides the @code{-path} predicate. | 1580 | A copy of find (e.g., GNU find) that provides the @code{-path} predicate. |
| 1580 | 1581 | ||
| 1581 | You may be able to work around this with a suitable clever shell | 1582 | You may be able to work around this with a suitable clever shell |
| 1582 | command and the customisation entry: @ref{hfy-find-cmd} | 1583 | command and the customization entry: @ref{hfy-find-cmd} |
| 1583 | 1584 | ||
| 1584 | @item | 1585 | @item |
| 1585 | A copy of sed (e.g., GNU sed). | 1586 | A copy of sed (e.g., GNU sed). |
| @@ -1603,7 +1604,7 @@ A copy of the @code{file} command. | |||
| 1603 | @item Functions | 1604 | @item Functions |
| 1604 | @printindex fn | 1605 | @printindex fn |
| 1605 | 1606 | ||
| 1606 | @item Variables & Customisation | 1607 | @item Variables & Customization |
| 1607 | @printindex vr | 1608 | @printindex vr |
| 1608 | 1609 | ||
| 1609 | @end table | 1610 | @end table |