vim-latex-live-preview


Ⅰ. 插件描述

A Vim Plugin for Lively Previewing LaTeX PDF Output

Ⅱ. 基本信息

创建日期:  2012-05-16
使用用户:  518
Github星:  533
插件作者:  Hong Xu

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:
Plugin 'xuhdev/vim-latex-live-preview'
… 然后在Vim中运行以下命令:
:source %
:PluginInstall

对于Vundle版本 < 0.10.2,请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:
NeoBundle 'xuhdev/vim-latex-live-preview'
… 然后在Vim中运行以下命令:
:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:
Plug 'xuhdev/vim-latex-live-preview'
… 然后在Vim中运行以下命令:
:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:
cd ~/.vim/bundle
git clone https://github.com/xuhdev/vim-latex-live-preview

Ⅳ. 文档说明

A Vim Plugin for Lively Previewing LaTeX PDF Output

This plugin provides a live preview of the output PDF of your LaTeX file. The
display of the output PDF file will be updated lively as you type (just hold
the cursor and you will see the PDF file updated). Currently,
vim-latex-live-preview only support UNIX-like systems. [Please let me know if
you have any suggestions.](.github/CONTRIBUTING.md)

Table of Contents

Installation

Before installing, you need to make sure your Vim version is later than 7.3,
and is compiled with +python feature.

vim-plug

Add the plugin in the vim-plug section of your ~/.vimrc:

call plug#begin('~/.vim/plugged')
[...]
" A Vim Plugin for Lively Previewing LaTeX PDF Output
Plug 'xuhdev/vim-latex-live-preview', { 'for': 'tex' }
[...]
call plug#end()

Then reload the config and install the new plugin. Run inside vim:

:so ~/.vimrc
:PlugInstall

Vundle

Add the plugin in the Vundle section of your ~/.vimrc:

call vundle#begin()
[...]
" A Vim Plugin for Lively Previewing LaTeX PDF Output
Plugin 'xuhdev/vim-latex-live-preview'
[...]
call vundle#end()

Then reload the config and install the new plugin. Run inside vim:

:so ~/.vimrc
:PluginInstall

Manually

Copy plugin/latexlivepreview.vim to ~/.vim/plugin.

Usage

Simply execute :LLPStartPreview to launch the previewer. Then try to type in
Vim and you should see the live update. The updating time could be set by Vim's
['updatetime'][] option. If your pdf viewer crashes when updates happen, you can
try to set 'updatetime' to a higher value to make it update less frequently. The
suggested value of 'updatetime' is 1000.

If the root file is not the file you are currently editing, you can specify it
by executing :LLPStartPreview <root-filename> or executing :LLPStartPreview
with the following declaration in the first line of your source file:

% !TEX root = <root-filename>

The path to the root file can be an absolute path or a relative path, in which
case it is relative to the parent directory of the current file.

:warning: if <root-filename> contains special characters (such as space), they
must be escaped manually.

Configuration

PDF viewer

By default, you need to have [evince][] or [okular][] installed as pdf viewers.
But you can specify your own viewer by setting g:livepreview_previewer
option in your .vimrc:

let g:livepreview_previewer = 'your_viewer'

Please note that not every pdf viewer could work with this plugin. Currently
evince and okular are known to work well. You can find a list of known working
pdf viewers here.

TeX engine

LLP uses pdflatex as default engine to output a PDF to be previewed. It
fallbacks to xelatex if pdflatex is not present. These defaults can be
overridden by setting g:livepreview_engine variable:

let g:livepreview_engine = 'your_engine' . ' [options]'

Autocmd

By default, the LaTeX sources will be recompiled each time the buffer is written
to disk, but also when the cursor holds. To prevent recompilation on cursor
hold (autocmd events CursorHold and CursorHoldI), use the feature flag:

let g:livepreview_cursorhold_recompile = 0

Known issues

Swap error

An error E768: Swap file exists may occur. See
issue #7 to avoid
swap filename collision.

Project tree

Currently, root file must be in the same directory or upper in the project tree
(otherwise, one has to save file to update the preview).

E492: Not an editor command: LLPStartPreview

See issue #12,
provided the plugin is correctly installed, this is likely a Python issue.

Python-related issues

See issue #24,
currently vim-latex-live-preview does not support python/dyn and Vim
must be recompiled with Python support.

Screenshot

Screenshot with Evince

<!--
The screenshot is at ./misc/screenshot-evince.gif
-->

添加新评论