Difference between revisions of "WikEmacs:Guidelines"

From WikEmacs
Jump to navigation Jump to search
(→‎Templates: add examples)
Line 10: Line 10:
  
 
There are templates defined for referencing ''variables'', ''function'', ''command'', ''keys'', ''manual'' etc.  Use them for uniform experience.  See [http://wikemacs.org/wiki/index.php?title=Special%3AAllPages&from=&to=&namespace=10 Templates].
 
There are templates defined for referencing ''variables'', ''function'', ''command'', ''keys'', ''manual'' etc.  Use them for uniform experience.  See [http://wikemacs.org/wiki/index.php?title=Special%3AAllPages&from=&to=&namespace=10 Templates].
 +
 +
Some examples:
 +
 +
{| border="1" cellpadding="5" cellspacing="0" width="75%"
 +
|-
 +
!What it looks like
 +
!What you type
 +
|-
 +
| {{Command|apropos}} || <pre>{{Command|apropos}}</pre>
 +
|-
 +
| {{Function|search-forward}} || <pre>{{Function|search-forward}}</pre>
 +
|-
 +
| {{Keys|C-x C-c}} || <pre>{{Keys|C-x C-c}}</pre>
 +
|-
 +
| {{Manual|emacs|dired|Dired}} || <pre>{{Manual|emacs|dired|Dired}}</pre>
 +
|-
  
 
== Categories ==
 
== Categories ==

Revision as of 10:59, 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 only towards the current and future versions of Emacs (currently 23 and 24) for maintainability's sake. Mentions of older Emacs versions should be as few as possible.
  • Articles should not copy Emacs's or extension's official documentation - they should refer to it instead. An overview, some nice pointers, tips and links.
  • Comments and questions should go to an article's discussion page. Always sign your comments with the ~~~~ special syntax after them, otherwise the discussion will be hard to follow.

Templates

There are templates defined for referencing variables, function, command, keys, manual etc. Use them for uniform experience. See Templates.

Some examples:

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.

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}}