Skip to content
This repository was archived by the owner on Mar 9, 2020. It is now read-only.

Commit a4c7673

Browse files
dsansondsanson
committed
copying cleaned up comments to README
1 parent 540ccb7 commit a4c7673

File tree

1 file changed

+75
-49
lines changed

1 file changed

+75
-49
lines changed

‎README.markdown

Lines changed: 75 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -18,70 +18,96 @@ Here is some text.[^1]
1818
[^1]: Here is a note.
1919
~~~
2020

21-
No other changes have been made. Original instructions below.
21+
No other changes have been made.
2222

2323
* * * * *
2424
~~~
25-
Inspired by Emmanuel Touzery tip:
26-
" http://vim.sourceforge.net/tip_view.php?tip_id=332
27-
" and discussion below (thanks to Luc for pluginization hints)
28-
" I added functions and turned it into vim script.
29-
30-
31-
" Commands:
32-
" <Leader>f (in insert mode) - inserts footnotemark, opens at bottom window where
33-
" footnotemark is also inserted and you are ready to type in your
34-
" footnotetext.
35-
" <Leader>r (in insert mode) - closes footnote window and returns to the text in
36-
" proper place.
25+
" Maintainer: David Sanson <[email protected]>
26+
" Description: Extended Markdown Footnotes in Vim
27+
" Version: 0.1
28+
" URL: https://github.com/vim-pandoc/vim-markdownfootnotes
29+
"
30+
" I've taken the original and modified the output to fit the widely
31+
" supported extended markdown format for footnotes.[^note]
32+
"
33+
" [^note]: Like this.
3734
"
38-
" You can change them by placing in your vimrc:
39-
" imap your_map <Plug>AddVimFootnote
40-
" imap your_map <Plug>ReturnFromFootnote
35+
" The original script either puts notes at the end, or before your
36+
" email sig line (i.e., if there is a line that consists of two dashes,
37+
" it puts the notes before that line). This version just puts them at
38+
" the end.
4139
"
40+
" Based On:
41+
" VimFootnotes
42+
" Author: Mikolaj Machowski <[email protected]>
43+
" Version: 0.6
44+
" Description: Footnotes in Vim
45+
" Installation: See below
46+
" Last Change: pon wrz 30 09:00 2002 C
47+
" URL: http://www.vim.org/scripts/script.php?script_id=431
48+
" Help Part:
49+
" Inspired by Emmanuel Touzery tip:
50+
" http://vim.sourceforge.net/tip_view.php?tip_id=332
51+
" and discussion below (thanks to Luc for pluginization hints)
52+
" I added functions and turned it into vim script.
4253
"
43-
" Footnotes are placed at the end of the file but above signature delimiter
44-
" (is one exists).
54+
" Installation: Drop it to your plugin directory but you can declare your
55+
" favorite types of footnotes in your ftplugins.
4556
"
4657
" Settings:
47-
" g:vimfootnotetype - possible values:
58+
"
59+
" By default, footnote ids are arabic numerals. You can change this by
60+
" setting b:vimfootnotetype,
61+
"
4862
" arabic (default) - [1] [2] [3] ...
4963
" alpha - [a] [b] ... [z] [aa] [bb] ... [zz] [a] ...
5064
" Alpha - as above but uppercase [A] ...
65+
" roman - [i] [ii] [iii] displayed properly up to 89
66+
" Roman - as above but uppercase [I] ...
5167
" star - [*] [**] [***] ...
5268
"
53-
" Additional commands:
54-
" FootnoteNumber:
55-
" You can change current footnote number (one obligatory argument)
56-
" :FootnoteNumber 5
57-
" FootnoteNumberRestore:
58-
" You can restore old footnote number
59-
" :FootnoteNumberRestore
60-
" FootnoteUndo:
61-
" Decrease footnote counter by 1
62-
" :FootnoteUndo
63-
" FootnoteMeta:
64-
" Change type of the footnotes and restart counter (1, a, A, *)
65-
" :FootnoteMeta
66-
" If your previous footnote type was alpha, Alpha or star new type will
67-
" be arabic.
69+
" Commands:
70+
"
71+
" Those mappings correspond to two commands that you can use in your own
72+
" mappings:
73+
"
74+
" AddVimFootnote
75+
" ~ inserts footnotemark at cursor location, inserts footnotemark on new
76+
" line at end of file, opens a split window all ready for you to enter in
77+
" the footnote.
78+
79+
" ReturnFromFootnote
80+
" ~ closes the split window and returns to the text in proper place.
81+
"
82+
" These are mapped to <Leader>f and <Leader>r respectively.
83+
"
84+
" FootnoteNumber
85+
" ~ Change the current footnote number (one obligatory argument)
86+
" :FootnoteNumber 5
87+
"
88+
" FootnoteNumberRestore
89+
" ~ Restore old footnote number
90+
91+
" FootnoteUndo
92+
" ~ Decrease footnote counter by 1
93+
"
94+
" FootnoteMeta
95+
" ~ Change type of the footnotes and restart counter (1, a, A, i, I, *)
96+
" :FootnoteMeta
97+
" If your previous footnote type was alpha, Alpha, roman, Roman or star
98+
" new type will be arabic.
6899
" If your previous footnote type was arabic new type will be alpha.
69-
" :FootnoteMeta name_of_the_type
100+
" :FootnoteMeta name_of_the_type
70101
" Change footnote type to name_of_the_type. If name_of_the_type is the
71102
" same as your current footnote type nothing would be changed.
72-
" FootnoteRestore:
73-
" Restore previous footnote type and counter. Unfortunately there is no easy
74-
" way to sort footnotes at the end of file without handmade :!sort on marked
75-
" lines (it doesn't work for 'star' type).
76-
" :FootnoteRestore
77-
"
78-
" For easier work with this commands I would suggest place this lines in your
79-
" vimrc (they offer very nice competion of Vim commands):
80-
" set laststatus=2
81-
" set wildmode=longest,list
82-
" set wildmenu
83-
"
84-
" And/or map :FootnoteComs for something you like.
103+
" You can change your default type of footnote before inserting first
104+
" footnote.
105+
"
106+
" FootnoteRestore
107+
" ~ Restore previous footnote type and counter. Unfortunately there is no easy
108+
" way to sort footnotes at the end of file without handmade :!sort on marked
109+
" lines (it doesn't work for 'star' type).
110+
" :FootnoteRestore
85111
"
86112
"""""""""""""""""""""""""""""""""""""""""""""""""""
87-
~~~
113+

0 commit comments

Comments
 (0)