1" Vim plugin for converting a syntax highlighted file to HTML. 2" Maintainer: Ben Fritz <[email protected]> 3" Last Change: 2015 Sep 08 4" 5" The core of the code is in $VIMRUNTIME/autoload/tohtml.vim and 6" $VIMRUNTIME/syntax/2html.vim 7" 8" TODO: {{{ 9" * Options for generating the CSS in external style sheets. New :TOcss 10" command to convert the current color scheme into a (mostly) generic CSS 11" stylesheet which can be re-used. Alternate stylesheet support? Good start 12" by Erik Falor 13" ( https://groups.google.com/d/topic/vim_use/7XTmC4D22dU/discussion ). 14" * Add optional argument to :TOhtml command to specify mode (gui, cterm, 15" term) to use for the styling. Suggestion by "nacitar". 16" * Add way to override or specify which RGB colors map to the color numbers 17" in cterm. Get better defaults than just guessing? Suggestion by "nacitar". 18" * Disable filetype detection until after all processing is done. 19" * Add option for not generating the hyperlink on stuff that looks like a 20" URL? Or just color the link to fit with the colorscheme (and only special 21" when hovering)? 22" * Bug: Opera does not allow printing more than one page if uncopyable 23" regions is turned on. Possible solution: Add normal text line numbers with 24" display:none, set to display:inline for print style sheets, and hide 25" <input> elements for print, to allow Opera printing multiple pages (and 26" other uncopyable areas?). May need to make the new text invisible to IE 27" with conditional comments to prevent copying it, IE for some reason likes 28" to copy hidden text. Other browsers too? 29" * Bug: still a 1px gap throughout the fold column when html_prevent_copy is 30" "fn" in some browsers. Specifically, in Chromium on Ubuntu (but not Chrome 31" on Windows). Perhaps it is font related? 32" * Bug: still some gaps in the fold column when html_prevent_copy contains 33" 'd' and showing the whole diff (observed in multiple browsers). Only gaps 34" on diff lines though. 35" * Undercurl support via CSS3, with fallback to dotted or something: 36" https://groups.google.com/d/topic/vim_use/BzXA6He1pHg/discussion 37" * Redo updates for modified default foldtext (v11) when/if the patch is 38" accepted to modify it. 39" * Test case +diff_one_file-dynamic_folds+expand_tabs-hover_unfold 40" +ignore_conceal-ignore_folding+no_foldcolumn+no_pre+no_progress 41" +number_lines-pre_wrap-use_css+use_xhtml+whole_filler.xhtml 42" does not show the whole diff filler as it is supposed to? 43" * Bug: when 'isprint' is wrong for the current encoding, will generate 44" invalid content. Can/should anything be done about this? Maybe a separate 45" plugin to correct 'isprint' based on encoding? 46" * Check to see if the windows-125\d encodings actually work in Unix without 47" the 8bit- prefix. Add prefix to autoload dictionaries for Unix if not. 48" * Font auto-detection similar to 49" http://www.vim.org/scripts/script.php?script_id=2384 but for a variety of 50" platforms. 51" * Error thrown when sourcing 2html.vim directly when plugins are not loaded. 52" * Pull in code from http://www.vim.org/scripts/script.php?script_id=3113 : 53" - listchars support 54" - full-line background highlight 55" - other? 56" * Make it so deleted lines in a diff don't create side-scrolling (get it 57" free with full-line background highlight above). 58" * Restore open/closed folds and cursor position after processing each file 59" with option not to restore for speed increase. 60" * Add extra meta info (generation time, etc.)? 61" * Tidy up so we can use strict doctype in even more situations 62" * Implementation detail: add threshold for writing the lines to the html 63" buffer before we're done (5000 or so lines should do it) 64" * TODO comments for code cleanup scattered throughout 65"}}} 66 67if exists('g:loaded_2html_plugin') 68 finish 69endif 70let g:loaded_2html_plugin = 'vim7.4_v2' 71 72" 73" Changelog: {{{ 74" 7.4_v2 (this version): Fix error raised when converting a diff containing 75" an empty buffer. Jan Stocker: allow g:html_font to 76" take a list so it is easier to specfiy fallback 77" fonts in the generated CSS. 78" 7.4_v1 (Vim 7.4.0000): Fix modeline mangling for new "Vim:" format, and 79" also for version-specific modelines like "vim>703:". 80" 81" 7.3 updates: {{{ 82" 7.3_v14 (Vim 7.3.1246): Allow suppressing line number anchors using 83" g:html_line_ids=0. Allow customizing 84" important IDs (like line IDs and fold IDs) using 85" g:html_id_expr evalutated when the buffer conversion 86" is started. 87" 7.3_v13 (Vim 7.3.1088): Keep foldmethod at manual in the generated file and 88" insert modeline to set it to manual. 89" Fix bug: diff mode with 2 unsaved buffers creates a 90" duplicate of one buffer instead of including both. 91" Add anchors to each line so you can put '#L123' 92" or '#123' at the end of the URL to jump to line 123 93" (idea by Andy Spencer). Add javascript to open folds 94" to show the anchor being jumped to if it is hidden. 95" Fix XML validation error: &nsbp; not part of XML. 96" Allow TOhtml to chain together with other commands 97" using |. 98" 7.3_v12 (Vim 7.3.0616): Fix modeline mangling to also work for when multiple 99" highlight groups make up the start-of-modeline text. 100" Improve render time of page with uncopyable regions 101" by not using one-input-per-char. Change name of 102" uncopyable option from html_unselectable to 103" html_prevent_copy. Added html_no_invalid option and 104" default to inserting invalid markup for uncopyable 105" regions to prevent MS Word from pasting undeletable 106" <input> elements. Fix 'cpo' handling (Thilo Six). 107" 7.3_v12b1: Add html_unselectable option. Rework logic to 108" eliminate post-processing substitute commands in 109" favor of doing the work up front. Remove unnecessary 110" special treatment of 'LineNr' highlight group. Minor 111" speed improvements. Fix modeline mangling in 112" generated output so it works for text in the first 113" column. Fix missing line number and fold column in 114" diff filler lines. Fix that some fonts have a 1px 115" gap (using a dirty hack, improvements welcome). Add 116" "colorscheme" meta tag. Does NOT include support for 117" the new default foldtext added in v11, as the patch 118" adding it has not yet been included in Vim. 119" 7.3_v11 ( unreleased ): Support new default foldtext from patch by Christian 120" Brabandt in 121" http://groups.google.com/d/topic/vim_dev/B6FSGfq9VoI/discussion. 122" This patch has not yet been included in Vim, thus 123" these changes are removed in the next version. 124" 7.3_v10 (Vim 7.3.0227): Fix error E684 when converting a range wholly inside 125" multiple nested folds with dynamic folding on. 126" Also fix problem with foldtext in this situation. 127" 7.3_v9 (Vim 7.3.0170): Add html_pre_wrap option active with html_use_css 128" and without html_no_pre, default value same as 129" 'wrap' option, (Andy Spencer). Don't use 130" 'fileencoding' for converted document encoding if 131" 'buftype' indicates a special buffer which isn't 132" written. 133" 7.3_v8 (Vim 7.3.0100): Add html_expand_tabs option to allow leaving tab 134" characters in generated output (Andy Spencer). 135" Escape text that looks like a modeline so Vim 136" doesn't use anything in the converted HTML as a 137" modeline. Bugfixes: Fix folding when a fold starts 138" before the conversion range. Remove fold column when 139" there are no folds. 140" 7.3_v7 (Vim 7-3-0063): see betas released on vim_dev below: 141" 7.3_v7b3: Fixed bug, convert Unicode to UTF-8 all the way. 142" 7.3_v7b2: Remove automatic detection of encodings that are not 143" supported by all major browsers according to 144" http://wiki.whatwg.org/wiki/Web_Encodings and 145" convert to UTF-8 for all Unicode encodings. Make 146" HTML encoding to Vim encoding detection be 147" case-insensitive for built-in pairs. 148" 7.3_v7b1: Remove use of setwinvar() function which cannot be 149" called in restricted mode (Andy Spencer). Use 150" 'fencoding' instead of 'encoding' to determine by 151" charset, and make sure the 'fenc' of the generated 152" file matches its indicated charset. Add charsets for 153" all of Vim's natively supported encodings. 154" 7.3_v6 (Vim 7.3.0000): Really fix bug with 'nowrapscan', 'magic' and other 155" user settings interfering with diff mode generation, 156" trailing whitespace (e.g. line number column) when 157" using html_no_pre, and bugs when using 158" html_hover_unfold. 159" 7.3_v5 ( unreleased ): Fix bug with 'nowrapscan' and also with out-of-sync 160" folds in diff mode when first line was folded. 161" 7.3_v4 (Vim 7.3.0000): Bugfixes, especially for xhtml markup, and diff mode 162" 7.3_v3 (Vim 7.3.0000): Refactor option handling and make html_use_css 163" default to true when not set to anything. Use strict 164" doctypes where possible. Rename use_xhtml option to 165" html_use_xhtml for consistency. Use .xhtml extension 166" when using this option. Add meta tag for settings. 167" 7.3_v2 (Vim 7.3.0000): Fix syntax highlighting in diff mode to use both the 168" diff colors and the normal syntax colors 169" 7.3_v1 (Vim 7.3.0000): Add conceal support and meta tags in output 170"}}} 171"}}} 172 173" Define the :TOhtml command when: 174" - 'compatible' is not set 175" - this plugin was not already loaded 176" - user commands are available. {{{ 177if !&cp && !exists(":TOhtml") && has("user_commands") 178 command -range=% -bar TOhtml :call tohtml#Convert2HTML(<line1>, <line2>) 179endif "}}} 180 181" Make sure any patches will probably use consistent indent 182" vim: ts=8 sw=2 sts=2 noet fdm=marker 183