Vim Tips Wiki:Script comment guidelines

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
Script comments

In short

• The Script namespace is a place to discuss the scripts on vim.org.
• Example: script#1234 at vim.org has a link to Script:1234 which is a page in the Script namespace on this wiki.
• Pages here must not attempt to duplicate or replace the documentation on vim.org.
• Use the pages here for constructive comments, bug reports, or to discuss enhancements.
• No email addresses please: comments should be added to the wiki.
• An author may like to link to their Vim Tips User page or to their vim.org profile.

Explanation

The Vim Scripts repository at vim.org holds many scripts (aka plugins) that are useful for Vim users. To prevent spam, it is not possible to add comments or bug reports at vim.org. Instead (since February 2010), each script at vim.org has a link to a page in the Script namespace on this wiki, for example, script#1234 at vim.org has a link to Script:1234 which is a page in the Script namespace on this wiki.

A page like Script:1234 should contain only constructive comments, or bug reports, or suggested enhancements, relevant to script 1234. Links to similar scripts may be included.

Any other material may be deleted:

• A detailed description should be at the vim.org page, not here.
• Documentation and installation notes should be at the vim.org page, not here.
• Unhelpful comments should be removed (criticism is good, but it must contain some coherent explanation).

Each script should be described and documented at vim.org: duplicating that documentation here would just lead to confusion (does a user need to study both pages? which page is current?). It may be helpful to start the page here with a brief description of the script (one or two short paragraphs), but do not duplicate several paragraphs from vim.org.

Script namespace

A namespace is a collection of pages with a common purpose. Examples:

• Each normal article is in the main namespace with no prefix before the article title.
• Each user page is in the User namespace and has prefix "User:".
• Each page commenting on a script is in the Script namespace and has prefix "Script:".

To list all pages in the Script namespace:

• Special:Allpages/Script:

To search all pages in the Script namespace:

• Open Special:Search.
• Click the "Script" box so it includes a check mark.
• Remove the check mark next to "(Main)" if you do not want to search the main namespace.
• Enter the required text in the "Search for" box and press Enter.

By default, searching finds text only in the main namespace (Vim tips). If wanted, a user can change Special:Preferences so that searches include any wanted namespaces.