summaryrefslogtreecommitdiff
path: root/htdocs/docs.php
blob: b0e4c252caa6c5bba10b740e7755241b90a2838e (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
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
93
94
<?php
// Vim Documentation
require_once("include/init.inc");
$page_title = "Vim documentation";
// $page_foot = "foot_docs.php";

include("header.php");
?>
<h1>Documentation</h1>
<p>
	The most useful software is sometimes rendered useless by poor or
	altogether missing documentation.  Vim refuses to succumb to death by
	underdocumentation.  With a book to extensive help files to a tips
	archive, all audiences should be pleased.
</p>

<h1>Help Files</h1>
<p>
	Vim's online documentation system, accessible via the <tt>:help</tt>
	command, is an extensive cross-referenced and hyperlinked reference.
	It's kept up-to-date with the software and can answer almost any
	question about Vim's functionality.  The
	<a href='http://vimdoc.sf.net/'>VimDoc</a> project maintains an online,
	hyperlinked copy of the documentation.
</p>
<p>
	A new on-line version of the help can be found on
	<a href='http://vimhelp.appspot.com/'>appspot</a>.
	This is maintained by Carlo Teubner.
</p>
<p>
	For translations of the help files see the
	<a href="translations.php">translation page</a>.
</p>

<h1>The Books</h1>
<p>
	Steve Oualline wrote the first book completely dedicated to Vim.
	It's written for Vim 5.7, but it is still a useful introduction to any
	modern version of Vim.
	The book is also available 
	<a href="ftp://ftp.vim.org/pub/vim/doc/book/vimbook-OPL.pdf">as a PDF</a> 
	(converted from a HTML version that is no longer available).
	<br>&nbsp;<br>
	There are four more books about Vim.
	More information on
	<a href='http://iccf-holland.org/click5.html'>this page</a>.
	If you buy a copy through here this helps us help the
	<a href='http://iccf-holland.org/index.html'>Ugandan orphans</a>.
	<br>
	And now, for something completely different: Vim books in Japanese!
	<a href="http://www.amazon.co.jp/exec/obidos/ASIN/4774120189">Vim&#23436;&#20840;&#12496;&#12452;&#12502&#12523;</a> and
	<a href="http://www.amazon.co.jp/exec/obidos/ASIN/3826615891">vim Ge-Packt</a>
	<br>&nbsp;<br>
	There is also a wiki book: <a href="http://www.swaroopch.com/notes/Vim_en:Table_of_Contents">A Byte Of Vim</a>.
	You can download it as PDF or read it online.
	And you can edit it.  Or get the on-demand printed version.

</p>

<h1>The FAQ</h1>
<p>
	A manual is great for reference, but voluminous reference materials
	aren't always the easiest way to locate answers to your questions.
	We've compiled a list of frequently asked questions, along with good
	answers.  You can find the <a
	href='http://vimdoc.sourceforge.net/vimfaq.html'>FAQ</a> at the
	VimDoc project.
</p>

<h1>Tips</h1>
<p>
	Finding an answer is even harder if you don't know that you have a
	question.  The vim.org <a href='tips/index.php'>tips archive</a> contains a seemingly
	endless supply of hints on making your vim use a more pleasant experience.  The
	tip archive is also a great way to find quick hacks to perform common
	tasks.
</p>
<p>
	You can also watch videos.  You can find them with
<a href="http://www.google.ch/search?q=site%3Awww.vimeo.com+vim+screencast+on+vimeo">Google search</a>.
</p>

<h1>Other Documentation</h1>
<p>
	There are plenty of other sources of Vim documentation.  We've got a <a
	href='web.php'>partial list</a> of them, but <a
	href='http://www.google.com/'>Google</a> is another great way to find
	obscure documentation.
</p>
<?php
$google_ads = "big";
include("footer.php");
?>