Technology
 

Vim Tips Wiki:Quick reference

From Vim Tips Wiki

Vim Tip Guidelines
Quick reference
General guidelines
Titles and renaming a tip
Comments
Categories
Discussion page
Merging similar tips
Deleting a tip
Templates
Formatting code blocks
Entities and other magic

[edit] Editing

  • Practice in the sandbox (try something then click "Show preview").
  • Use our todo list to find a page to improve.
  • Click "Edit this page".
  • Work on the text in the edit box, or copy and edit in Vim.
  • Explain your edit in the "Summary" box (e.g. "typo" or "added example").
  • Click "Show preview" to check for mistakes.
  • Click "Save" (if you have an account, check you are logged on first).

[edit] Formatting

  • ''italics'' displays as italics.
  • '''bold''' displays as bold.
  • "Type <tt>:bd</tt> to ..." displays as "Type :bd to ...".
  • ==Main heading== (not "Main Heading").
  • ===This is a subheading===
  • Put : at start of a line to indent that line.
  • Put * at start of a line for a bullet point (like this list).
  • Put # at start of a line for a numbered point.

Use <pre>...</pre> around code blocks, with two-space indents for Vim script.

Use <CR> (not <cr> and not &lt;CR&gt;).

[edit] Style guide

Vim's name has changed over the years. The current documentation uses "Vim" (however, we say "gvim" because the alternatives are too ugly).

A paragraph should be one long line, with a single blank line between paragraphs. Sentences are separated by a single space.

Headings user lower case except for the first word and proper names. Omit redundant spaces (==See also== not == See Also ==). No blank line following a heading.

We say "Put the following in your [[vimrc]]" to link to the vimrc page.

[edit] Links

External links to other web sites should only be used where the site is likely to be maintained with a significant amount of useful Vim information. No links to personal blogs (except on a user page).

List of example links: 

*[[VimTip1|Searching]]
*[[The super star]]
*{{help|*}}
*{{script|id=1234}} maintains a history of yanks and deletes
*{{script|id=1234|text=YankRing}}
*http://www.vim.org/scripts/
*[http://www.vim.org/scripts/ Vim scripts site]

This is how the list appears:

Using the {{help}} template can be tricky. It's probably best just to use plain text (for example, :help >>) in problem cases and let someone else worry about the details later.

Retrieved from "http://vim.wikia.com/wiki/Vim_Tips_Wiki:Quick_reference"