aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
blob: c406e2e225a5b1c63a4a1f3543878cb89e8c7592 (plain)
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
vim-uuid-anchor
###############

Installation with vundle
========================

Just put ``Bundle 'git://git.devys.org/vim-uuid-anchor'`` in your
*~/.vim/vimrc*.

Manual Installation
===================

1. Clone the git repository::

       git clone git://git.devys.org/vim-uuid-anchor
       cd vim-uuid-anchor

3. Copy the file ``ftplugin/uuid_anchor.vim`` to your ``~/.vim/ftplugin``
   directory

Usage
=====

Table of content to real content example:

1. Place yourself at the line of the item you want be jumpable::

    1. item 1
    2. item 2 <-- You want to add a further description but keeping this list
                  simple. Place your cursor here.
    3. item 3

2. Place yourself in insert mode at the end of line, add a space and call the
   uuid function, with default vim configuration, press ``A ``, then
   ``,,uuid`` (assuming your leader is ',')::

    1. item 1
    2. item 2 DCE564FB
    3. item 3

3. At the other place in the text file, at the place of the description in our
   example, you can paste the last generated uuid by pressing ``"up``::

    DCE564FB:
        Description with lot of text lines of the item 2.
        Another line of description.
        Last line of description.

4. Later, when you want to jump from the item list to the description, or jump
   back, simply place your cursor on the uuid and press ``*``.

5. Be pleased by your new plugin and possibility.