xref: /vim-8.2.3635/runtime/plugin/tohtml.vim (revision 8e5af3e5)

" Vim plugin for converting a syntax highlighted file to HTML.
" Maintainer: Ben Fritz <[email protected]>
" Last Change: 2011 Apr 09
"
" The core of the code is in $VIMRUNTIME/autoload/tohtml.vim and
" $VIMRUNTIME/syntax/2html.vim
"
" TODO:
"   * Options for generating the CSS in external style sheets. New :TOcss
"     command to convert the current color scheme into a (mostly) generic CSS
"     stylesheet which can be re-used. Alternate stylesheet support?
"   * Pull in code from http://www.vim.org/scripts/script.php?script_id=3113 :
"	- listchars support
"	- full-line background highlight
"	- other?
"   * Font auto-detection similar to
"     http://www.vim.org/scripts/script.php?script_id=2384
"   * Explicitly trigger IE8+ Standards Mode?
"   * Make it so deleted lines in a diff don't create side-scrolling
"   * Restore open/closed folds and cursor position after processing each file
"     with option not to restore for speed increase
"   * Undercurl support via dotted bottom border?
"   * Add extra meta info (generation time, etc.)?
"   * Tidy up so we can use strict doctype in even more situations
"   * Implementation detail: add threshold for writing the lines to the html
"     buffer before we're done (5000 or so lines should do it)
"   * TODO comments for code cleanup scattered throughout
"
"
" Changelog:
"   7.3_v9 (this version): Add html_pre_wrap option active with html_use_css and
"                          without html_no_pre, default value same as 'wrap'
"                          option, (Andy Spencer). Don't use 'fileencoding' for
"                          converted document encoding if 'buftype' indicates a
"                          special buffer which isn't written.
"   7.3_v8 (85c5a72551e2): Add html_expand_tabs option to allow leaving tab
"                          characters in generated output (Andy Spencer). Escape
"                          text that looks like a modeline so Vim doesn't use
"                          anything in the converted HTML as a modeline.
"                          Bugfixes: Fix folding when a fold starts before the
"                          conversion range. Remove fold column when there are
"                          no folds.
"   7.3_v7 (840c3cadb842): see betas released on vim_dev below:
"                7.3_v7b3: Fixed bug, convert Unicode to UTF-8 all the way.
"                7.3_v7b2: Remove automatic detection of encodings that are not
"                          supported by all major browsers according to
"                          http://wiki.whatwg.org/wiki/Web_Encodings and convert
"                          to UTF-8 for all Unicode encodings. Make HTML
"                          encoding to Vim encoding detection be
"                          case-insensitive for built-in pairs.
"                7.3_v7b1: Remove use of setwinvar() function which cannot be
"                          called in restricted mode (Andy Spencer). Use
"                          'fencoding' instead of 'encoding' to determine by
"                          charset, and make sure the 'fenc' of the generated
"                          file matches its indicated charset. Add charsets for
"                          all of Vim's natively supported encodings.
"   7.3_v6 (0d3f0e3d289b): Really fix bug with 'nowrapscan', 'magic' and other
"                          user settings interfering with diff mode generation,
"                          trailing whitespace (e.g. line number column) when
"                          using html_no_pre, and bugs when using
"                          html_hover_unfold.
"   7.3_v5 ( unreleased ): Fix bug with 'nowrapscan' and also with out-of-sync
"                          folds in diff mode when first line was folded.
"   7.3_v4 (7e008c174cc3): Bugfixes, especially for xhtml markup, and diff mode.
"   7.3_v3 (a29075150aee): Refactor option handling and make html_use_css
"                          default to true when not set to anything. Use strict
"                          doctypes where possible. Rename use_xhtml option to
"                          html_use_xhtml for consistency. Use .xhtml extension
"                          when using this option. Add meta tag for settings.
"   7.3_v2 (80229a724a11): Fix syntax highlighting in diff mode to use both the
"                          diff colors and the normal syntax colors
"   7.3_v1 (e7751177126b): Add conceal support and meta tags in output
"   Pre-v1 baseline: Mercurial changeset 3c9324c0800e

if exists('g:loaded_2html_plugin')
  finish
endif
let g:loaded_2html_plugin = 'vim7.3_v9'

" Define the :TOhtml command when:
" - 'compatible' is not set
" - this plugin was not already loaded
" - user commands are available.
if !&cp && !exists(":TOhtml") && has("user_commands")
  command -range=% TOhtml :call tohtml#Convert2HTML(<line1>, <line2>)
endif

" Make sure any patches will probably use consistent indent
"   vim: ts=8 sw=2 sts=2 noet