Difference between revisions of "WikEmacs:Guidelines"
Jump to navigation
Jump to search
(→Templates: fix dired link) |
(→General: revise guidelines, borrowing from About page) |
||
| Line 3: | Line 3: | ||
== General == | == General == | ||
| − | * Articles should be geared | + | * Articles should be geared toward the current and development versions of Emacs, 23 and 24 at time of writing. References to older Emacs releases should generally be avoided. |
| − | * Articles should not | + | * Articles should not reproduce documentation already available from another source. Many packages and extensions are well-documented on their own project sites; and Emacs itself includes extensive documentation. Link to official documentation where possible. |
| − | * Comments and questions | + | * Comments and questions belong on the Discussion pages, not in articles themselves. Always sign your comments using <nowiki>~~~~</nowiki>. This expands to your username (if logged in) and adds a timestamp. Unsigned comments make the discussion hard to follow. |
| + | * Extensions and packages will '''not''' be hosted here. If you are looking for a place to host your extension try [https://github.com GitHub] or one of the other many hosting / source control platforms out there! | ||
== Templates == | == Templates == | ||
Revision as of 15:43, 27 March 2012
Start with http://meta.wikimedia.org/wiki/Help:Wikitext_examples if you are new to MediaWiki markup.
General
- Articles should be geared toward the current and development versions of Emacs, 23 and 24 at time of writing. References to older Emacs releases should generally be avoided.
- Articles should not reproduce documentation already available from another source. Many packages and extensions are well-documented on their own project sites; and Emacs itself includes extensive documentation. Link to official documentation where possible.
- Comments and questions belong on the Discussion pages, not in articles themselves. Always sign your comments using ~~~~. This expands to your username (if logged in) and adds a timestamp. Unsigned comments make the discussion hard to follow.
- Extensions and packages will not be hosted here. If you are looking for a place to host your extension try GitHub or one of the other many hosting / source control platforms out there!
Templates
There are templates defined for referencing variables, function, command, keys, manual etc. Use them for uniform experience. See Templates.
Some examples:
| What it looks like | What you type |
|---|---|
| M-x apropos | {{Command|apropos}}
|
| search-forward | {{Function|search-forward}}
|
| [C-x C-c] | {{Keys|C-x C-c}}
|
| Dired (`(info "(emacs) Dired")') | {{Manual|emacs|Dired|Dired}}
|
Categories
There are special categories defined for Operating system, Emacs releases, Programming languages etc. Use these when possible or introduce new ones as required. See Special:Categories.