• Stars
    star
    132
  • Rank 274,205 (Top 6 %)
  • Language
    Vim Script
  • Created about 14 years ago
  • Updated over 11 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Help folks to align text, eqns, declarations, tables, etc
This is a mirror of http://www.vim.org/scripts/script.php?script_id=294

                                                    [ALIGN/ALIGNMAPS NEEDS VIM 7.0 AS OF V29/34]

Align and AlignMaps lets you align statements on their equal signs, make comment boxes, align comments, align declarations, etc.

Note: this plugin is not a left&right margin justification tool!  See vimscript#177, vimscript#2324, or vimscript#3728 for that.
Note: if you have vim 7.1 or later, your vimball should unpack just fine without having to update it.

There are two basic commands provided by this package:

        AlignCtrl options sep1 sep2 sep3 ...
        [range]Align sep1 sep2 sep3 ...

The "sep#" are regular expressions which describe separators that delineate fields; Align will line up the separators. The range may be any Vim range, _including_ visual-blocks.  Align works on lines of the form:
(ws==whitespace, sep==separator, field==text)

    ws-field-ws-sep-ws-field-ws-sep-ws-field-...
    ws-field-ws-sep-ws-field-ws-sep-ws-field-...

Note that white-space (ws) surrounding separators is ignored.

The Align package includes:

  Align : the basic alignment command
  AlignCtrl : provides options for the next call to :Align
  AlignMaps : many three or four key maps which support aligning C/C++ style declarations, ()?..:.., expressions, C/C++ comments, numbers, C preprocessor definitions, tables based on tabs or spaces, and more.

In addition, AutoAlign (vimscript#884) uses the Align function to align =s as you type.

Align handles alignment on multiple separators, not just the first one, and the separators may be the same across the line or different.  With AlignCtrl one may specify that separators are cyclic (re-used sequentially) or equivalent (all separators are simultaneously active).

There are several options to help with deciding what to do with initial white space.   By default Align re-uses the first line's initial white space, but one may use AlignCtrl to retain or remove each line's initial white space.

The <Align.vim> and <AlignMaps.vim> files are plugins and require vim 6.1 or higher.


EXAMPLES:

:5,10Align =
    Align on '=' signs

:'<,'>Align = + - \* /
    Align on any of the five separator characters shown.
    Note that visual block mode was used to fire off Align.

:AlignCtrl =lp1P1I
    which means:
    = all separators are equivalent
    l fields will be left-justified
    p1 pad one space before each separator
    P1 pad one space after each separator
    I  preserve and apply the first line's leading white space to all
       Align'd lines

:help align
    Gives help for Align


ALIGNMENT CONTROL

Alignment control allows for left or right justification or centering of fields, cyclic (sequentially active) or equivalent (simultaneously active) regular expressions to specify field separators, initial white space control, optional visual-block use (ie. apply Alignment only within a block), user-specified white-space padding about separators, and multiple separators.

MANY ALIGNMENT MAPS

AlignMaps.vim provides a number of maps which make using this package easy.  They typically either apply to the range 'a,. (from mark a to current line) or use the visual-selection (V, v, or ctrl-v selected):

	\t=  : align assignments (don't count logic, like == or !=)
	\t,  : align on commas
	\t|  : align on vertical bars (|)
	\tsp : align on whitespace
	\tt  : align LaTeX tabular tables

AlignMaps also provides some internally complex maps for aligning C declarations, Ansi C function arguments, html tables, LaTeX tabulars, and trailing comments:

	\acom : align comments
	\adec : align C declarations (one variable per line)
	\afnc : align ansi-style C function input arguments
	\Htd  : align html tables
	
To see some examples of this, check out

    http://www.drchip.org/astronaut/vim/align.html#Examples

(the proportional fonts used by most browsers in showing you this page preclude showing the examples here). The help for Align and AlignCtrl also contains many examples.
(for those of you who prefer not to have the maps that AlignMaps.vim provides, simply remove the AlignMapsPlugin.vim from .vim/plugin and AlignMaps.vim from .vim/autoload - that's why AlignMaps is separate from Align)

ALIGNMENT ON VISUAL BLOCKS AND g,v-LIKE CONTROL

Sometimes one wants to align only a subset of text in a range, based on patterns or column extents.  Align supports both types of restrictions!
    
    Visual-block selection may be used to restrict Align to operate only
    within that visual block.
    
    AlignCtrl supports "g" and "v" patterns that restrict Align to

    operate on lines which match (or don't match, respectively) those
    patterns.

NEW STUFF:

There's a number of new AlignCtrl options:
    
    - allows one to skip a separator (treat it as part of a field)
    + repeat the last lrc justification (ex. lr+ == lrrrrrr... )
    : treat the rest of the line as a field; acts as a modifier
      to the last lrc. 
    < left-justify the separator
    > right-justify the separator
    | center the separator

These are, except for the ":", cyclic parameters.  In other words, >< is equivalent to ><><><><... .  Thus separators can be of differing lengths (ex.  -\+ as a separator pattern can match -, --, ---, etc and the separators will be left/right/center justified as you wish).

To get automatic, as-you-type, aligning of = in the C, vimL, and other languages, check out vimscript#884 for several ftplugins (which use Align).


Alternative Aligners:
    Gergely Kontra's vimscript#176

Thank you for rating Align!

---------------------------------------
DISCUSSION and COMMENTS:
---------------------------------------

Please use email for bugs.  Enjoy!

(alpha/beta version available at http://mysite.verizon.net/astronaut/vim/index.html#ALIGN)

More Repositories

1

taglist.vim

Source code browser (supports C/C++, java, perl, python, tcl, sql, php, etc)
Vim Script
650
star
2

dbext.vim

Provides database access to many dbms (Oracle, Sybase, Microsoft, MySQL, DBI,..)
Vim Script
417
star
3

YankRing.vim

Maintains a history of previous yanks, changes and deletes
Vim Script
405
star
4

a.vim

Alternate Files quickly (.c --> .h etc)
Vim Script
302
star
5

DrawIt

Ascii drawing plugin: lines, ellipses, arrows, fills, and more!
Vim Script
293
star
6

ReplaceWithRegister

Replace text with the contents of a register.
Vim Script
291
star
7

Conque-GDB

GDB command line interface and terminal emulator in (G)Vim.
Python
275
star
8

AutoComplPop

Automatically opens popup menu for completions
Vim Script
263
star
9

FuzzyFinder

buffer/file/command/tag/etc explorer with fuzzy matching
Vim Script
258
star
10

Conque-Shell

Run interactive commands inside a Vim buffer
Vim Script
248
star
11

vim-auto-save

Automatically save changes to disk
Vim Script
225
star
12

vimwiki

Personal Wiki for Vim
Vim Script
195
star
13

ZoomWin

Zoom in/out of windows (toggle between one window and multi-window)
Vim Script
182
star
14

VimClojure

A filetype, syntax and indent plugin for Clojure
Vim Script
179
star
15

paredit.vim

Paredit Mode: Structured Editing of Lisp S-expressions
Vim Script
177
star
16

DoxygenToolkit.vim

Simplify Doxygen documentation in C, C++, Python.
Vim Script
162
star
17

c.vim

C/C++ IDE -- Write and run programs. Insert statements, idioms, comments etc.
Vim Script
152
star
18

mru.vim

Plugin to manage Most Recently Used (MRU) files
Vim Script
149
star
19

matchit.zip

extended % matching for HTML, LaTeX, and many other languages
Vim Script
148
star
20

argtextobj.vim

Text-object like motion for arguments
Vim Script
138
star
21

UltiSnips

The ultimate snippet solution for python enabled Vim.
Python
129
star
22

Vim-R-plugin

Plugin to work with R
Vim Script
126
star
23

slimv.vim

SLIME-like Lisp and Clojure REPL inside Vim with Profiling, Hyperspec, Paredit
Common Lisp
119
star
24

bufexplorer.zip

Buffer Explorer / Browser
Vim Script
111
star
25

TaskList.vim

Eclipse like task list
Vim Script
107
star
26

VimIM

Vim Input Method -- Vim 中文输入法
Vim Script
103
star
27

VOoM

Vim Outliner of Markers -- two-pane outliner and related utilities
Python
98
star
28

SQLUtilities

SQL utilities - Formatting, generate - columns lists, procedures for databases
Vim Script
91
star
29

bash-support.vim

BASH IDE -- Write and run BASH-scripts using menus and hotkeys.
Vim Script
90
star
30

netrw.vim

Network oriented reading, writing, and browsing (keywords: netrw ftp scp)
Vim Script
90
star
31

OmniCppComplete

C/C++ omni-completion with ctags database
Vim Script
89
star
32

LanguageTool

Grammar checker for English, French, German (etc.) in Vim
Vim Script
88
star
33

Pydiction

Tab-complete your Python code
Python
87
star
34

TwitVim

Twitter client for Vim
Vim Script
86
star
35

xoria256.vim

Finely tuned soft gamma, 256 colors, dark background, gvim == vim
Vim Script
84
star
36

indentpython.vim

An alternative indentation script for python
Vim Script
82
star
37

utl.vim

Univeral Text Linking - Execute URLs, footnotes, open emails, organize ideas
Vim Script
80
star
38

fcitx.vim

keep and restore fcitx state when leaving/re-entering insert mode
Vim Script
79
star
39

peaksea

Refined color, contains both gui and cterm256 for dark and light background
Vim Script
77
star
40

SyntaxRange

Define a different filetype syntax on regions of a buffer.
Vim Script
76
star
41

L9

Vim-script library
Vim Script
75
star
42

AnsiEsc.vim

ansi escape sequences concealed, but highlighted as specified (conceal)
Vim Script
72
star
43

LargeFile

Edit large files quickly (keywords: large huge speed)
Vim Script
72
star
44

JavaScript-Indent

Javascript indenter (HTML indent is included)
Vim Script
69
star
45

tComment

An extensible & universal comment plugin that also handles embedded filetypes
Vim Script
68
star
46

The-NERD-tree

A tree explorer plugin for navigating the filesystem
Vim Script
66
star
47

nginx.vim

initial version
Vim Script
65
star
48

camelcasemotion

Motion through CamelCaseWords and underscore_notation.
Vim Script
64
star
49

ShowMarks

Visually shows the location of marks.
Vim Script
64
star
50

closetag.vim

Functions and mappings to close open HTML/XML tags
Vim Script
64
star
51

BufOnly.vim

Delete all the buffers except the current/named buffer
Vim Script
63
star
52

bufkill.vim

Unload/delete/wipe a buffer, keep its window(s), display last accessed buffer(s)
Vim Script
62
star
53

vcscommand.vim

CVS/SVN/SVK/git/hg/bzr integration plugin
Vim Script
61
star
54

Auto-Pairs

Insert or delete brackets, parens, quotes in pair.
Vim Script
61
star
55

AutoClose

Inserts matching bracket, paren, brace or quote
Vim Script
61
star
56

Gundo

Visualize your undo tree.
Python
60
star
57

grep.vim

Grep search tools integration with Vim
Vim Script
56
star
58

javacomplete

Omni Completion for JAVA
Vim Script
56
star
59

SearchComplete

Tab completion of words inside of a search ('/')
Vim Script
55
star
60

VisIncr

Produce increasing/decreasing columns of numbers, dates, or daynames
Vim Script
55
star
61

EasyGrep

Fast and Easy Find and Replace Across Multiple Files
Vim Script
53
star
62

pep8

Check your python source files with PEP8
Vim Script
52
star
63

wombat256.vim

Wombat for 256 color xterms
Vim Script
48
star
64

sessionman.vim

Vim session manager
Vim Script
47
star
65

cscope.vim

create cscope database and connect to existing proper database automatically.
Vim Script
47
star
66

restore_view.vim

A plugin for automatically restoring file's cursor position and folding
Vim Script
46
star
67

Mark--Karkat

Highlight several words in different colors simultaneously. (#1238 continued)
Vim Script
46
star
68

loremipsum

A dummy text generator
Vim Script
45
star
69

ScrollColors

Colorsheme Scroller, Chooser, and Browser
Vim Script
45
star
70

gtags.vim

Integrates GNU GLOBAL source code tag system with VIM.
Vim Script
42
star
71

perl-support.vim

Perl IDE -- Write and run Perl-scripts using menus and hotkeys.
Vim Script
42
star
72

google.vim

Indent file for Google C++ Coding Style
Vim Script
41
star
73

winmanager

A windows style IDE for Vim 6.0
Vim Script
41
star
74

gitignore

Set 'wildignore' from ./.gitignore
Vim Script
40
star
75

sudo.vim

Allows one to edit a file with prevledges from an unprivledged session.
Vim Script
40
star
76

HTML-AutoCloseTag

Automatically closes HTML tags once you finish typing them.
Vim Script
39
star
77

greplace.vim

Replace a pattern across multiple files interactively
Vim Script
38
star
78

CSApprox

Make gvim-only colorschemes work transparently in terminal vim
Vim Script
38
star
79

phpfolding.vim

Automatic folding of PHP functions, classes,.. (also folds related PhpDoc)
Vim Script
38
star
80

SyntaxComplete

OMNI Completion based on the current syntax highlights
Vim Script
37
star
81

vis

Extended Visual Mode Commands, Substitutes, and Searches
Vim Script
36
star
82

snipMate

TextMate-style snippets for Vim
Vim Script
36
star
83

workflowish

ToDo manager plugin inspired by workflowy.com
Vim Script
34
star
84

VimRepress

Plugin for managing wordpress blog from Vim.
Vim Script
34
star
85

Lucius

Dark and light color scheme (GUI and 256 color terminal)
Vim Script
34
star
86

SQLComplete.vim

SQLComplete is a SQL code completion system using the omnifunc framework
Vim Script
34
star
87

Wombat

Dark gray color scheme sharing some similarities with Desert
Vim Script
33
star
88

DirDiff.vim

A plugin to diff and merge two directories recursively.
Vim Script
33
star
89

AutoTag

Updates entries in a tags file automatically when saving
Vim Script
33
star
90

TagHighlight

Extra highlighting of typedefs, enumerations etc (based on ctags)
Vim Script
32
star
91

Gist.vim

vimscript for gist
Vim Script
32
star
92

jsbeautify

a javascript source code formatter
Vim Script
32
star
93

The-NERD-Commenter

A plugin that allows for easy commenting of code for many filetypes.
Vim Script
32
star
94

marvim

Macro Persistent Storage and Shareable Repository for VIM
Vim Script
32
star
95

Python-mode-klen

python mode
Python
31
star
96

scratch.vim

Plugin to create and use a scratch Vim buffer
Vim Script
31
star
97

Emmet.vim

vim plugins for HTML and CSS hi-speed coding.
Vim Script
29
star
98

IndexedSearch

shows 'Nth match out of M' at every search (index of match+total # matches)
Vim Script
29
star
99

errormarker.vim

Highlights and sets error markers for lines with compile errors
Vim Script
29
star
100

TeTrIs.vim

A tetris game in pure vim
Vim Script
29
star