Difference between revisions of "WikEmacs:Guidelines"

From WikEmacs
Jump to: navigation, search
(General: revise guidelines, borrowing from About page)
m (Templates: example of {{Manual}} with different 2nd and 3rd args)
Line 25: Line 25:
| {{Keys|C-x C-c}} || <pre>{{Keys|C-x C-c}}</pre>
| {{Keys|C-x C-c}} || <pre>{{Keys|C-x C-c}}</pre>
| {{Manual|emacs|Dired|Dired}} || <pre>{{Manual|emacs|Dired|Dired}}</pre>
| {{Manual|emacs|Major-Modes|Major Modes}} || <pre>{{Manual|emacs|Major-Modes|Major Modes}}</pre>

Revision as of 17:18, 27 March 2012

Start with http://meta.wikimedia.org/wiki/Help:Wikitext_examples if you are new to MediaWiki markup.


  • 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!


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
[C-x C-c]
{{Keys|C-x C-c}}
Major Modes (`(info "(emacs) Major Modes")')
{{Manual|emacs|Major-Modes|Major Modes}}


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.