TOhtml project readme

This is the development repository for the standard Vim plugin :TOhtml

:TOhtml (or 2html) converts the current Vim window or set of windows into an HTML document with the same coloring, folding, etc.

See :help convert-to-HTML in Vim for details.

This repository was initially created from a clone of the full Vim repository that I had been using for development, so the history before tag 2html_7.4.2 may look a little strange in places; the conversion wasn't entirely smooth.

License

vim-tohtml is made available under the Vim license, which is GPL compatible. See :help license within Vim for details. Basically: if you modify and distribute this plugin, you must share it back to me and the Vim community.

Installation

Normally, you don't install this plugin. This plugin is distributed with Vim.

If you need a more recent version than that available in the official repository or Mercurial mirror, then you can install this version as follows:

• Using packages (Vim 7.4.1562 and up): clone into ~/.vim/pack/whatever/opt/vim-tohtml, run :helptags ALL or :helptags ~/.vim/pack/whatever/opt/vim-tohtml/doc, and add "packadd! vim-tohtml" to your .vimrc to force it into the runtimepath.
• Using Pathogen: just clone the repository into your bundle directory as normal, and run :Helptags
• Using another plugin manager: consult your plugin manager help for installing from a SourceForge repository
• Manually: the repository has a "plugin", "autoload", and "syntax" directory. Place the files from each of these into the matching subdirectories of your ~/.vim directory. The "doc/tohtml.txt" file is the portion of the syntax.txt help file specific to TOhtml. You'll need to copy the text from this file over the text from the official help file and run :helptags.

Test

This repository contains new-style Vim test framework tests for regression
testing any changes to the TOhtml plugin. These are known to work with GNU Make
on Linux, Mingw on Windows, and the Microsoft Visual Studio "nmake" tools. To
use:

1. Clone the Vim repository and check out the latest version.
2. Build Vim for your system (both console and GUI versions, if applicable).
3. Install java version 8 or above (needed for HTML validation tests).
4. Download the latest vnu.jar HTML validator:
   https://github.com/validator/validator/releases/download/latest/vnu.jar
5. "cd" into <vim-tohtml-directory>/testdir</vim-tohtml-directory>
6. Use the appropriate build tool and makefile to run the tests:
   • make
   • make mingw
   • nmake /F Make_mvc.mak

If you submit changes for inclusion in TOhtml, it can be included faster if you
create (or edit an existing) test_*.vim file that will test your new or
modified code. Be sure to think of potential interactions with other features
and options, especially diff mode, when creating your tests!