vim_mainline and vim_extended are discontinued
[vim_extended.git] / readme_vim_extended.htm
blob5c38abe738141d9135507de352a5dea8b5ec8ff7
1 <p>
2 <strong>--- DISCONTINUED ---</strong>
3 </p>
4 <p>
5 This is a git repository, which is meant to be an extension to the
6 official Vim from <a href="http://www.vim.org/">vim.org</a>. It
7 includes various extensions and features that didn't yet get into the
8 official version or even won't ever. Most features had been sent as
9 patches to the Vim mailing list.
10 </p>
12 <p>
13 See also the
14 <a href="http://groups.google.com/group/vim_dev/web/vim-patches">
15 Vim patches</a> site.
16 </p>
18 <p>
19 Documentation:
20 <a href="http://repo.or.cz/w/vim_extended.git?a=blob;f=README_gitrepo.txt;hb=stuff">
21 README_gitrepo.txt</a> from the <em>stuff</em> branch
22 </p>
24 <p>
25 Please note that there is no official support for this from Bram. The
26 patches will most likely work and they appear to do so for several
27 people. However, you might get unlucky and stuff breaks. At worst, you
28 could lose your data. So please be aware of this before going down
29 this road.
30 </p>
32 <p>
33 Authors of such features are encouraged to develop directly on this
34 repository and push access would gladly be granted. That way more
35 attention will be paid to their features, which will lead to more
36 testers and bug reports to get it stable. This will raise the
37 possibility to get it into the official Vim or at least helps the
38 feature to not get lost as a patch in the mailing list archives.
39 </p>
41 <p>
42 <strong>NOTE</strong>: This repository is based on
43 <a href="http://repo.or.cz/w/vim_mainline.git">vim_mainline.git</a>,
44 which was originally based on Vim's subversion repository with git-svn,
45 but now uses the official patches for updating.
46 <span style="text-decoration:line-through;">For the sake of cleanness
47 vim_mainline.git and hence vim_extended.git will definitely
48 be <strong>completely rewritten</strong> some time.</span>
49 Because Vim, including the latest runtime files, is officially
50 available via a Mercurial repository since the beginning of 2010,
51 vim_mainline.git will be discontinued in the near future.
52 The future (if any) of vim_extended in this or another form is not certain yet.
53 Please keep this
54 in mind when using this repository as base for your work.
55 </p>
57 <p>
58 Maintainer: <a href="mailto:markus.heidelberg@web.de">Markus Heidelberg</a>
59 </p>
61 <table>
62 <tr>
63 <th>Branch</th>
64 <th>Description</th>
65 </tr>
66 <tr>
67 <td><em>master</em></td>
68 <td>
69 Extended Vim<br />
70 Merges <em>vim-with-runtime</em> and most of the &quot;inofficial patches&quot; branches.<br />
71 The only modification is the "Modified by" entry for the version output.
72 </td>
73 </tr>
74 <tr>
75 <td><em>vim-with-runtime</em></td>
76 <td>
77 Official Vim with latest runtime and message files<br />
78 The <em>master</em> branch of the <a href="http://repo.or.cz/w/vim_mainline.git">vim_mainline.git</a> repository.
79 </td>
80 </tr>
81 <tr>
82 <td><em>stuff</em></td>
83 <td>
84 Scripts and documentation for using and managing this repository<br />
85 The <em>stuff</em> branch of the <a href="http://repo.or.cz/w/vim_mainline.git">vim_mainline.git</a> repository.
86 </td>
87 </tr>
88 <tr>
89 <td style="border-top:1px black solid;">inofficial patches</td>
90 <td style="border-top:1px black solid;">
91 Features, bugfixes or other improvements<br />
92 A selected checkbox <input type="checkbox" checked="checked" /> indicates that the branch is merged into <em>master</em>.<br />
93 Branches without an URL for downloading the patch are currently removed due to unresolved conflicts with mainline.<br />
94 Based on <em>vim-with-runtime</em>
95 </td>
96 </tr>
97 <tr>
98 <td>
99 <input type="checkbox" checked="checked" />
100 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim-with-runtime;h=feat/rel-line-numbers" title="Patch against official Vim"><em>feat/rel-line-numbers</em></a>
101 </td>
102 <td>
103 'relativenumber' option to display relative line numbers for use as [count]
104 </td>
105 </tr>
106 <tr>
107 <td>
108 <input type="checkbox" checked="checked" />
109 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim-with-runtime;h=feat/float-point-ext" title="Patch against official Vim"><em>feat/float-point-ext</em></a>
110 </td>
111 <td>
112 extended floating point functions
113 </td>
114 </tr>
115 <tr>
116 <td>
117 <input type="checkbox" checked="checked" />
118 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim-with-runtime;h=feat/lua" title="Patch against official Vim"><em>feat/lua</em></a>
119 </td>
120 <td>
121 interface to the programming language Lua
122 </td>
123 </tr>
124 <tr>
125 <td>
126 <input type="checkbox" />
127 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim-with-runtime;h=feat/code-check" title="Patch against official Vim"><em>feat/code-check</em></a>
128 </td>
129 <td>
130 on-the-fly code checker
131 </td>
132 </tr>
133 <tr>
134 <td>
135 <input type="checkbox" checked="checked" />
136 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim-with-runtime;h=feat/var-tabstops" title="Patch against official Vim"><em>feat/var-tabstops</em></a>
137 </td>
138 <td>
139 different widths for each tabstop
140 </td>
141 </tr>
142 <tr>
143 <td>
144 <input type="checkbox" checked="checked" />
145 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim-with-runtime;h=feat/emb-common-lisp" title="Patch against official Vim"><em>feat/emb-common-lisp</em></a>
146 </td>
147 <td>
148 interface to the programming language ECL (Embeddable Common Lisp)
149 </td>
150 </tr>
151 <tr>
152 <td>
153 <input type="checkbox" checked="checked" />
154 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim-with-runtime;h=feat/indent-wrap-lines" title="Patch against official Vim"><em>feat/indent-wrap-lines</em></a>
155 </td>
156 <td>
157 'breakindent' option to visually indent wrapped lines for improved readability
158 </td>
159 </tr>
160 <tr>
161 <td>
162 <input type="checkbox" checked="checked" />
163 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim-with-runtime;h=feat/quickfix-title" title="Patch against official Vim"><em>feat/quickfix-title</em></a>
164 </td>
165 <td>
166 the Quickfix window status line mentions the command
167 </td>
168 </tr>
169 <tr>
170 <td>
171 <input type="checkbox" checked="checked" />
172 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim-with-runtime;h=feat/persistent-undo" title="Patch against official Vim"><em>feat/persistent-undo</em></a>
173 </td>
174 <td>
175 persistence of undo trees across sessions
176 </td>
177 </tr>
178 <tr>
179 <td>
180 <input type="checkbox" />
181 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim-with-runtime;h=feat/tagfunc" title="Patch against official Vim"><em>feat/tagfunc</em></a>
182 </td>
183 <td>
184 'tagfunc' option to allow using Vim scripting for :tag and related commands
185 </td>
186 </tr>
187 <tr>
188 <td>
189 <input type="checkbox" checked="checked" />
190 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim-with-runtime;h=fix/fast-join" title="Patch against official Vim"><em>fix/fast-join</em></a>
191 </td>
192 <td>
193 faster algorithm for the :join command
194 </td>
195 </tr>
196 </table>