forked from jceb/vim-hier
-
Notifications
You must be signed in to change notification settings - Fork 2
/
README
92 lines (70 loc) · 3.7 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
*hier.txt* For Vim version 7.3 Last change: 2011 August 27
Copyright (c) 2011 Jan Christoph Ebersbach
Hier *hier*
DESCRIPTION |hier-description|
USAGE |hier-usage|
CUSTOMIZATION |hier-customization|
INSTALLATION |hier-installation|
RELATED PLUGINS |hier-related|
CHANGELOG |hier-changelog|
==============================================================================
DESCRIPTION *hier-description*
Highlight quickfix errors and location list entries in buffer. This plugin
was designed to support the editqf vim script
(http://www.vim.org/scripts/script.php?script_id=3557) but it also works
very well stand alone.
This script can be downloaded from
http://www.vim.org/scripts/script.php?script_id=3564. The latest development
version is available at https://github.com/jceb/vim-hier.
==============================================================================
USAGE *hier-usage*
The following commands are provided:
:HierStart " enable hier highlighting
:HierStop " disable hier highlighting
:HierUpdate " update error highlighting for current buffer
:HierClear " remove highlighting - it will be displayed
" again when :HierUpdate is called
==============================================================================
CUSTOMIZATION *hier-customization*
The highlight group can be customized by setting the following variables.
Setting a variable to the string "" will disable highlighting of that
group. Every type can be highlighted differently (error, warning, info):
let g:hier_highlight_group_qf = 'SpellBad'
let g:hier_highlight_group_qfw = 'SpellLocal'
let g:hier_highlight_group_qfi = 'SpellRare'
let g:hier_highlight_group_loc = 'SpellBad'
let g:hier_highlight_group_locw = 'SpellLocal'
let g:hier_highlight_group_loci = 'SpellRare'
Enable/disable highlighting highlighting by default:
let g:hier_enabled = 1
==============================================================================
INSTALLATION *hier-installation*
1. Download hier.vba.gz
2. Open file in vim and run :so % to install plugin
3. Restart vim
==============================================================================
RELATED PLUGINS *hier-related*
- editqf is a plugin that let's you edit and add entries in quickfix window.
The hier plugin is a useful extension to the editqf plugin
(http://www.vim.org/scripts/script.php?script_id=3557)
- quickfixsigns is a plugin similar to hier. The main difference is that it
highlights the quickfix locations in a separate column. quickfixsigns also
support the highlighting of marks which is not in the focus of hier.
(http://www.vim.org/scripts/script.php?script_id=2584)
==============================================================================
CHANGLOG *hier-changelog*
1.3
- fix problem when disabling the highlighting by setting the
hier_highlight_group variables to the empty string ""
1.2
- add highlighting groups for warning and info entries
- make clearing of highlighting behave more graceful towards other
plugins
- add function s:Getlist to remove duplicated code
1.1
- add commands :HierStart and :HierStop
- add support for highlighting location list entries
- add support for highlighting pattern entries
1.0
- inital release
vim:tw=78:ts=8:ft=help:norl: