WikEmacs - User contributions [en]

Tutorial

2012-05-04T17:07:14Z

Drothlis: Added link to my "How to learn Emacs" guide.

== Tutorial for using Emacs ==

The absolute mandatory way to begin learning Emacs to is to use the built-in tutorial.

* You can {{Keys|C-h t}}, meaning hold the Control key and press 'h' at same time, then release them and press 't', which will launch the tutorial.

[http://david.rothlis.net/emacs/howtolearn.html How to learn Emacs] is a guide that teaches Emacs using the built-in help and the elisp source code.

== Tutorial for Emacs Lisp ==

Emacs as [[lisp]] machine, most of its function is implement by [[Emacs lisp]], and you customize Emacs with [[elisp]]. Learning elisp, at least understand its syntax, can be very useful. there is a official tutorial for elisp.

* you can (c-h i m Emacs Lisp Intro <enter>) to begin the tutorial.

[[Category:Tutorial]]

Key Bindings

2012-05-04T16:57:00Z

Drothlis: "Super" is the Command ⌘ key on OS X

In Emacs, almost any keystroke, optionally combined with one or more modifier keys, or any sequence of such keystrokes, can be "bound" to any [[command]].

== Modifier keys naming convention ==

{| class="wikitable"
|-
! Modifier key
! Abbr.
! Remarks
! Example
! Action
|-
| Alt
| A
| Relatively seldom used in Emacs, because Meta is often "logically" mapped to the "physical" <tt>Alt</tt> key.
| A-x
| Type "x" while holding down the (non-Meta) Alt key
|-
| Control
| C
|
| C-x C-f
| While holding down Ctrl, type first "x" then "f". (This runs the command <tt>find-file</tt>).
|-
| Hyper
| h
| Often not mapped to any key (by default).
| h-x
| Type "x" while holding down hyper
|-
| Meta
| M
| Often mapped to <tt>Alt</tt> on your keyboard
| M-x find-file RET
| Either:
* type "x" while holding down Meta, or
* type "Esc" then "x"
(M-x activates the [[minibuffer]])

Then type "find-file" in the minibuffer, then Return.
|-
| Shift
| S
|
| S-x
| Type "x" while holding down Shift
|-
| Super
| s
| Os OS X this is the Command ⌘ key.
On other systems often not mapped to any key by default, or to <tt>Window</tt> or <tt>Menu</tt> if present
| s-x
| Type "x" while holding down super
|-
|}

By convention, when multiple modifiers are specified, they go in alphabetical order: {{Keys|C-M-x}} not {{Keys|M-C-x}}.

== Printable cheat sheet for popular modes ==
Emacs ships with cheat sheets of common and useful key bindings.
The {{File|pdf}} files are located in the {{Directory|refcards}} subdirectory of {{Variable|data-directory}}.

== Change key bindings ==
You can add, remove and change key bindings for any command.

; {{Command|global-set-key}} or {{Command|local-set-key}}
: Hit the key sequence you want to bind
: Type the command to bind to that key sequence
: Invoke {{Keys|C-x ESC ESC|repeat-complex-command}}. The output you see is the full lisp command which does the binding. You can copy this to your {{EmacsConfigFile}}.

== External Links ==

* [http://www.masteringemacs.org/articles/2011/02/08/mastering-key-bindings-emacs/ Mastering Keybindings in Emacs]

[[Category:Customization]]
[[Category:Key Concepts]]

WikEmacs:Guidelines

2012-05-04T16:54:13Z

Drothlis: Fix table formatting

'''How can we maintain and improve quality of this Wiki?'''
* Stick to Emacs-24 and Emacs-23.
* Keep things short and sweet. Mark things that should stand out in '''bold'''.
* Use [http://en.wikipedia.org/wiki/Active_voice Active voice]
* Give tips. Document things that are difficult to find or share your wisdom.
* Don't reproduce existing documentation. Instead link to them.
* It's OK to write long tutorial Pages. Use '''Tutorial:Tutorial Namespace''' for it. Assign categories for easily finding the tutorial.
* If you are a regular blogger, consider donating your articles to this Wiki.
* For discussions, use the '''Discussion page''' instead of posting to the article pages. Sign your comments using <nowiki>~~~~</nowiki>.
* We cannot host code extensions and elisp packages here. Use [https://github.com GitHub] or similar code hosting site.
* {{Note}} this is not a QA site. Emacs questions are better answered at [http://stackoverflow.com/questions/tagged/emacs Stackoverflow site]. However, if you have an answer to a good question or problem, add in the appropriate page.
* '''Code snippets''' are most welcome. But comment about what precisely the snippet does. Document any limitations as well.

== Mediawiki Help ==
* [http://meta.wikimedia.org/wiki/Help:Wikitext_examples Help with Mediawiki markup]

== Creating new pages ==
To create a new page, do this:
# Visit [http://wikemacs.org/w/index.php?title=Template:NewPage&action=edit Template:NewPage] and copy the text area to clipboard. Feel free to modify the template.
# Goto [[WikEmacs:Scratch Buffer]]
# Add this <nowiki>[[Test Page]]</nowiki> and save the scratch buffer.
# Click on the new Wiki link to create a blank page and paste the contents of clipboard there.
# Save the newly created page.
# Now you have a basic template which you can expand upon. Add content to the new page as you please.

== Templates ==
There are templates defined for referencing ''variables'', ''function'', ''command'', ''keys'', ''manual'' etc. Use them for uniformity. See [[:Category:Templates]]. Each template page should describe how to use that template. A few common examples:

{| border="1" cellpadding="5" cellspacing="0" width="75%"
|-
!What it looks like
!What you type
|-
| <h2>Headline text</h2>
| <pre>== Headline text ==</pre>
|-
| {{Manual|emacs|Major-Modes|Major Modes}}
| <pre>{{Manual|emacs|Major-Modes|Major Modes}}</pre>
|-
| {{CommandKeys|C-x C-f|find-file}}
| <pre>{{CommandKeys|C-x C-f|find-file}}</pre>
|-
| {{Keys|C-x C-c}}
| <pre>{{Keys|C-x C-c}}</pre>
|-
| {{Keys|C-x f|set-fill-column}}
| <pre>{{Keys|C-x f|set-fill-column}}</pre>
|-
| {{Command|find-file}}
| <pre>{{Command|find-file}}</pre>
|-
| {{CustomizeVariable|c-default-style}}
| <pre>{{CustomizeVariable|c-default-style}}</pre>
|-
| {{Snippet|(global-set-key (kbd "C-c c") 'org-capture)}}
| <pre>{{Snippet|(global-set-key (kbd "C-c c") 'org-capture)}}</pre>
|}

== Categories ==

Special categories, such as ''Operating system'', ''Emacs releases'', ''Programming languages'', should be used to introduce new categories. See [[Special:Categories]].

[[Category:WikEmacs Contributor]]