Difference between revisions of "How to read this wiki"

From WikEmacs
Jump to: navigation, search
(Page detailing conventions and notations used in the wkik)
 
m (Key bindings and commands)
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
A few conventions and notations are used throughout this wiki. Most of them are very similar to those used in the Emacs Manual
 
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 ==
+
== Key bindings and commands ==
  
The notation {{Keys|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.
+
The notation {{Keys|C-M-a}}, denotes a key binding. Here, '''<tt>C-</tt>''' represents the ''<Control>'' key (which is labelled ''<Ctrl>'' on most keyboards), '''<tt>M-</tt>''' represents the ''<Meta>'' key (which is labelled ''<Alt>'' on most keyboards), and '''<tt>a</tt>''' 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 {{Keys|C-x C-c}} denotes the {{Keys|C-x}} key combination (i.e. ''<ctrl>''+''x'') followed by the {{Keys|C-c}} key combination (i.e. ''<ctrl>''+''c'').
 
You can form sequences of key bindings. For example {{Keys|C-x C-c}} denotes the {{Keys|C-x}} key combination (i.e. ''<ctrl>''+''x'') followed by the {{Keys|C-c}} key combination (i.e. ''<ctrl>''+''c'').
Line 10: Line 10:
 
Below is a list of some keys you might encounter on this wiki:
 
Below is a list of some keys you might encounter on this wiki:
  
{| cellpadding="5"
+
{|
 
! notation
 
! notation
 
! corresponding key
 
! corresponding key
 
|-
 
|-
| '''C-'''
+
| '''<tt>C-</tt>'''
 
| <Ctrl>
 
| <Ctrl>
 
|-
 
|-
| '''M-'''
+
| '''<tt>M-</tt>'''
 
| <Meta> or <Alt>
 
| <Meta> or <Alt>
 
|-
 
|-
| '''S-'''
+
| '''<tt>S-</tt>'''
 
| <Shift>
 
| <Shift>
 
|-
 
|-
| '''left'''  
+
| '''<tt>left</tt>'''  
| <left arrow>
+
| <left arrow> (similar notations are used for all arrow keys)
 
|-
 
|-
 +
| '''<tt>RET</tt>'''
 +
| <return>
 
|}
 
|}
 +
 +
 +
Sometimes, the command bound to a key sequence is listed next to it in this way: {{CommandKeys|C-x C-f|find-file}}.
 +
 +
This means that instead of typing the {{Keys|C-x C-f}} key binding, you could achieve the same effect by typing:
 +
: '''<tt>M-x find-file RET</tt>'''
 +
 +
== 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:
 +
: '''<tt>M-: (info "(emacs) Major Modes") RET</tt>'''
  
 
[[Category:Beginner]]
 
[[Category:Beginner]]

Latest revision as of 13:54, 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 and commands[edit]

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> (similar notations are used for all arrow keys)
RET <return>


Sometimes, the command bound to a key sequence is listed next to it in this way: [C-x C-f] (or M-x find-file).

This means that instead of typing the [C-x C-f] key binding, you could achieve the same effect by typing:

M-x find-file RET

Links to official manual sections[edit]

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