Difference between revisions of "How to read this wiki"

From WikEmacs
Jump to: navigation, search
(Page detailing conventions and notations used in the wkik)
 
(section for links to the manual)
Line 27: Line 27:
 
|-
 
|-
 
|}
 
|}
 +
 +
 +
== Links to official manual sections ==
 +
 +
This wiki does not aim at reproducing official GNU documentation. Instead, it links to it using this notation: {{Manual|emacs|Major-Modes|Major Modes}}. You can of course click on the link to view the relevant manual section (in this case, the "Major Modes" section of the Emacs manual). But since Emacs is self-documented, you can also directly see the documentation within Emacs, by typing:
 +
: '''M-: (info "(emacs) Major Modes") RET'''
  
 
[[Category:Beginner]]
 
[[Category:Beginner]]

Revision as of 14:12, 28 March 2012

A few conventions and notations are used throughout this wiki. Most of them are very similar to those used in the Emacs Manual

Key bindings

The notation [C-M-a], denotes a key binding. Here, C- represents the <Control> key (which is labelled <Ctrl> on most keyboards), M- represents the <Meta> key (which is labelled <Alt> on most keyboards), and a simply represents the a key. Thus, to produce this key combination, you should press simultaneously the <Ctrl>, <Alt>, and a keys on your keyboard.

You can form sequences of key bindings. For example [C-x C-c] denotes the [C-x] key combination (i.e. <ctrl>+x) followed by the [C-c] key combination (i.e. <ctrl>+c).


Below is a list of some keys you might encounter on this wiki:

notation corresponding key
C- <Ctrl>
M- <Meta> or <Alt>
S- <Shift>
left <left arrow>


Links to official manual sections

This wiki does not aim at reproducing official GNU documentation. Instead, it links to it using this notation: Major Modes (`(info "(emacs) Major Modes")'). You can of course click on the link to view the relevant manual section (in this case, the "Major Modes" section of the Emacs manual). But since Emacs is self-documented, you can also directly see the documentation within Emacs, by typing:

M-: (info "(emacs) Major Modes") RET