annotate runtime/plugin/tohtml.vim @ 2642:840c3cadb842

Updated runtime files.
author Bram Moolenaar <bram@vim.org>
date Tue, 16 Nov 2010 20:34:40 +0100
parents 0d3f0e3d289b
children 85c5a72551e2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1 " Vim plugin for converting a syntax highlighted file to HTML.
2321
1902913f2049 Improved version of 2html.vim.
Bram Moolenaar <bram@vim.org>
parents: 2304
diff changeset
2 " Maintainer: Ben Fritz <fritzophrenic@gmail.com>
2642
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
3 " Last Change: 2010 Oct 28
2304
a59e6ac5ed28 When the buffer is in diff mode, have :TOhtml create HTML to show the diff
Bram Moolenaar <bram@vim.org>
parents: 7
diff changeset
4 "
2321
1902913f2049 Improved version of 2html.vim.
Bram Moolenaar <bram@vim.org>
parents: 2304
diff changeset
5 " The core of the code is in $VIMRUNTIME/autoload/tohtml.vim and
1902913f2049 Improved version of 2html.vim.
Bram Moolenaar <bram@vim.org>
parents: 2304
diff changeset
6 " $VIMRUNTIME/syntax/2html.vim
2432
80229a724a11 Updated runtime files. :TOhtml improvements by Benjamin Fritz.
Bram Moolenaar <bram@vim.org>
parents: 2401
diff changeset
7 "
80229a724a11 Updated runtime files. :TOhtml improvements by Benjamin Fritz.
Bram Moolenaar <bram@vim.org>
parents: 2401
diff changeset
8 " TODO:
2642
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
9 " * Patch to leave tab characters in when noexpandtab set (Andy Spencer)
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
10 " * Make folds show up when using a range and dynamic folding
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
11 " * Remove fold column when there are no folds and using dynamic folding
2546
0d3f0e3d289b Updates for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents: 2508
diff changeset
12 " * Restore open/closed folds and cursor position after processing each file
0d3f0e3d289b Updates for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents: 2508
diff changeset
13 " with option not to restore for speed increase
2432
80229a724a11 Updated runtime files. :TOhtml improvements by Benjamin Fritz.
Bram Moolenaar <bram@vim.org>
parents: 2401
diff changeset
14 " * Add extra meta info (generation time, etc.)
2642
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
15 " * Tidy up so we can use strict doctype in even more situations?
2546
0d3f0e3d289b Updates for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents: 2508
diff changeset
16 " * Implementation detail: add threshold for writing the lines to the html
0d3f0e3d289b Updates for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents: 2508
diff changeset
17 " buffer before we're done (5000 or so lines should do it)
2432
80229a724a11 Updated runtime files. :TOhtml improvements by Benjamin Fritz.
Bram Moolenaar <bram@vim.org>
parents: 2401
diff changeset
18 " * TODO comments for code cleanup scattered throughout
2642
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
19 "
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
20 "
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
21 " Changelog:
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
22 " 7.3_v7 (this version): see betas released on vim_dev below:
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
23 " 7.3_v7b3: Fixed bug, convert Unicode to UTF-8 all the way.
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
24 " 7.3_v7b2: Remove automatic detection of encodings that are not
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
25 " supported by all major browsers according to
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
26 " http://wiki.whatwg.org/wiki/Web_Encodings and convert
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
27 " to UTF-8 for all Unicode encodings. Make HTML
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
28 " encoding to Vim encoding detection be
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
29 " case-insensitive for built-in pairs.
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
30 " 7.3_v7b1: Remove use of setwinvar() function which cannot be
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
31 " called in restricted mode (Andy Spencer). Use
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
32 " 'fencoding' instead of 'encoding' to determine by
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
33 " charset, and make sure the 'fenc' of the generated
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
34 " file matches its indicated charset. Add charsets for
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
35 " all of Vim's natively supported encodings.
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
36 " 7.3_v6 (0d3f0e3d289b): Really fix bug with 'nowrapscan', 'magic' and other
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
37 " user settings interfering with diff mode generation,
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
38 " trailing whitespace (e.g. line number column) when
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
39 " using html_no_pre, and bugs when using
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
40 " html_hover_unfold.
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
41 " 7.3_v5 ( unreleased ): Fix bug with 'nowrapscan' and also with out-of-sync
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
42 " folds in diff mode when first line was folded.
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
43 " 7.3_v4 (7e008c174cc3): Bugfixes, especially for xhtml markup, and diff mode.
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
44 " 7.3_v3 (a29075150aee): Refactor option handling and make html_use_css
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
45 " default to true when not set to anything. Use strict
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
46 " doctypes where possible. Rename use_xhtml option to
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
47 " html_use_xhtml for consistency. Use .xhtml extension
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
48 " when using this option. Add meta tag for settings.
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
49 " 7.3_v2 (80229a724a11): Fix syntax highlighting in diff mode to use both the
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
50 " diff colors and the normal syntax colors
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
51 " 7.3_v1 (e7751177126b): Add conceal support and meta tags in output
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
52 " Pre-v1 baseline: Mercurial changeset 3c9324c0800e
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
53
2401
e7751177126b Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents: 2334
diff changeset
54 if exists('g:loaded_2html_plugin')
e7751177126b Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents: 2334
diff changeset
55 finish
e7751177126b Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents: 2334
diff changeset
56 endif
2642
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2546
diff changeset
57 let g:loaded_2html_plugin = 'vim7.3_v7'
2401
e7751177126b Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents: 2334
diff changeset
58
2304
a59e6ac5ed28 When the buffer is in diff mode, have :TOhtml create HTML to show the diff
Bram Moolenaar <bram@vim.org>
parents: 7
diff changeset
59 " Define the :TOhtml command when:
a59e6ac5ed28 When the buffer is in diff mode, have :TOhtml create HTML to show the diff
Bram Moolenaar <bram@vim.org>
parents: 7
diff changeset
60 " - 'compatible' is not set
a59e6ac5ed28 When the buffer is in diff mode, have :TOhtml create HTML to show the diff
Bram Moolenaar <bram@vim.org>
parents: 7
diff changeset
61 " - this plugin was not already loaded
a59e6ac5ed28 When the buffer is in diff mode, have :TOhtml create HTML to show the diff
Bram Moolenaar <bram@vim.org>
parents: 7
diff changeset
62 " - user commands are available.
a59e6ac5ed28 When the buffer is in diff mode, have :TOhtml create HTML to show the diff
Bram Moolenaar <bram@vim.org>
parents: 7
diff changeset
63 if !&cp && !exists(":TOhtml") && has("user_commands")
a59e6ac5ed28 When the buffer is in diff mode, have :TOhtml create HTML to show the diff
Bram Moolenaar <bram@vim.org>
parents: 7
diff changeset
64 command -range=% TOhtml :call tohtml#Convert2HTML(<line1>, <line2>)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65 endif
2321
1902913f2049 Improved version of 2html.vim.
Bram Moolenaar <bram@vim.org>
parents: 2304
diff changeset
66
1902913f2049 Improved version of 2html.vim.
Bram Moolenaar <bram@vim.org>
parents: 2304
diff changeset
67 " Make sure any patches will probably use consistent indent
2334
3c9324c0800e Improved :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents: 2321
diff changeset
68 " vim: ts=8 sw=2 sts=2 noet