WikEmacs:Guidelines
Revision as of 21:18, 27 March 2012 by Francesco (talk | contribs) (→Templates: example of {{Manual}} with different 2nd and 3rd args)
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}}
|
| Major Modes (`(info "(emacs) Major Modes")') | {{Manual|emacs|Major-Modes|Major Modes}}
|
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.