WikEmacs - User contributions [en]

User:Suplis09

2012-10-11T00:18:13Z

Jstein: SPAM

WikEmacs:Community portal

2012-10-11T00:17:25Z

Jstein: /* Google group */

Welcome to the community portal. This is the place to find out what is happening on WikEmacs. Learn what tasks need to be done and what groups there are to join, and share news about recent events or current activities taking place on WikEmacs.

WikEmacs was just started and we need more '''[[:Category:WikEmacs Contributor|WikEmacs Contributor]]s'''. You can help the following way.

* Priority tasks
** Migrate content from [http://www.emacswiki.org EmacsWiki]. Please adopt the following approach -''I found this on EmacsWiki which was helpful. But it took me a lot of time to find it. Now that I have found it, I will put it in WikEmacs so that others can benefit from it.''

* Intermediate tasks
** Provide tutorials or content for the [[:Category:Popular Package|Popular Packages]] or [[:Category:Native Package|Native Packages]].
** Add more content to [[Special:ShortPages]]
** Document or add more [[:Category:Third Party Package|Third Party Package]]s

* Other tasks
** Copy edit [[Special:RecentChanges]] or be a moral police
** Add more members to various [[Special:Categories]]
** Categorize one of these pages [[Special:UncategorizedPages]]

== Google group ==
[https://groups.google.com/forum/?fromgroups#!forum/wikemacs WikEmacs on Google Group] for more general questions regarding the wiki.
why not a mailinglist? Google claims i should create an account :(

WikEmacs:General disclaimer

2012-10-11T00:03:36Z

Jstein: Created page with "Here should be contact and webmaster details"

Here should be contact and webmaster details

AUCTeX

2012-10-10T21:51:08Z

Jstein: /* Helpful keybindings */

{{Package
|name=AUCTeX
|description=LaTeX editing
|author=David Kastrup
|maintainer=David Kastrup
|source= http://www.gnu.org/software/auctex/
}}

'''AUCTeX''' is an extensible package for writing and formatting TeX files in GNU Emacs and XEmacs. It supports many different TEX macro packages, including AMS-TEX, LaTeX, Texinfo, ConTEXt, and docTeX (dtx files).
AUCTeX includes [[preview-latex]] which makes LaTeX a tightly integrated component of your editing workflow by visualizing selected source chunks (such as single formulas or graphics) directly as images in the source buffer.

== Basic setup ==

<source lang="lisp">
(add-to-list 'load-path "~/.emacs.d/auctex")
(load "auctex.el" nil t t)
(load "preview-latex.el" nil t t)
</source>

=== Emacs 24 and ELPA ===
If you install AUCTeX via ELPA in Emacs 24 the basic setup listed above is not necessary. AUCTeX just works out of the box (at least on Linux).

== Helpful keybindings ==

C-c C-e insert environment

== Common Customization ==

=== Switch all fonts to monospace ===
AUCTeX's default fontification uses several different text sizes. If this behavior is not desired, it may be turned off by the following:
<source lang="lisp">
(setq font-latex-fontify-script nil)
(setq font-latex-fontify-sectioning 'color)
; modify Beamer as well
(custom-set-faces
'(font-latex-slide-title-face ((t (:inherit font-lock-type-face)))))
(font-latex-update-sectioning-faces)
</source>
which should be loaded by a hook.
=== Use pdflatex ===

<source lang="lisp">
(setq TeX-PDF-mode t)
</source>

=== Configure view program ===

<source lang="lisp">
(setq TeX-view-program-selection
'((output-dvi "DVI Viewer")
(output-pdf "PDF Viewer")
(output-html "HTML Viewer")))
;; this example is good for OS X only
(setq TeX-view-program-list
'(("DVI Viewer" "open %o")
("PDF Viewer" "open %o")
("HTML Viewer" "open %o")))
</source>

== See Also ==

== Project Pages ==
* [http://www.gnu.org/software/auctex/ Official Site]
* [http://www.gnu.org/software/auctex/manual/auctex.index.html Official Manual]

== Tutorial Pages ==

[[Category:Popular Package]][[Category:Document authoring]][[Category:LaTeX]]

File:Csv-mode.png

2012-10-02T08:33:27Z

Jstein: csv-mode

csv-mode

Talk:Org

2012-10-02T07:31:37Z

Jstein:

The devil, as always, is in the details. From Bozhidar Batsov’s [http://batsov.com/articles/2012/03/20/die-emacswiki/ original post]:

<blockquote>
Action Plan for The Maintainers:

Drop the current format of the wiki - use something standard like MediaWiki instead of OddMuse. Drop all the articles about Emacs extensions. Drop all the extensions hosted there. Assemble a team of moderators. Accept only articles about general Emacs usage and Emacs Lisp programming.</blockquote>

Give the above general action plan, I would think that we do not want to spend time and effort replicating documentation, tips-n-tricks, etc. from established projects that have these things. I added some basic links about the Org-Mode community, and don't really think we should go much further.

[[User:SkydiveMike|SkydiveMike]] 13:43, 24 March 2012 (EET)

Indeed. org-mode is actively developed outside Emacs and has an extremely good documentation.

[[User:Bozhidar|Bozhidar]] 15:39, 24 March 2012 (EET)

should we apply http://wikemacs.org/wiki/Template:Infobox_major-mode? --[[User:Jstein|Jstein]] 10:31, 2 October 2012 (EEST)

Starter Kits

2012-10-02T07:11:41Z

Jstein:

Starter kits contain useful Emacs defaults. There are lots of [[cheat pages]], that help to get an overview of the most important commands.

= External Links =

* [https://github.com/bbatsov/emacs-prelude Emacs Prelude]
* [https://github.com/technomancy/emacs-starter-kit Emacs Starter Kit]
* [https://github.com/dimitri/emacs-kicker Emacs Kicker]

[[Category:Beginner]][[Category:Install Or Upgrade]]

Installing Emacs on GNU/Linux

2012-09-29T12:11:45Z

Jstein: /* SusE */

Check if your distribution already provides an Emacs version of interest to you.

If you are interested in daily builds or latest binaries, try building from [https://github.com/emacsmirror/emacs source] or try one of the following unofficial repositories based on your distribution.

= Debian =

== Emacs 23 ==

<source lang="bash">
$ sudo apt-get install emacs
</source>

== Emacs 24 ==
See [http://emacs.naquadah.org/ emacs-snapshot APT repo]. The page contains installation instructions. High quality, highly recommended builds! After adding the repo according to the instructions linked to above, install with the following command:
<source lang="bash">
$ sudo apt-get install emacs-snapshot
</source>

= Ubuntu =

== Emacs 23 ==

<source lang="bash">
$ sudo apt-get install emacs
</source>

== Emacs 24 ==
<source lang="bash">
$ sudo apt-add-repository ppa:cassou/emacs
$ sudo apt-get install emacs24
</source>

= Gentoo =
See [http://www.gentoo.org/proj/en/lisp/emacs/emacs.xml Emacs on Gentoo page].

= Arch Linux =

== Emacs 23 ==

<source lang="bash">
$ sudo pacman -S emacs
</source>

== Emacs 24 ==

See [http://aur.archlinux.org/packages.php?ID=33337 emacs-bzr] package from [http://aur.archlinux.org/index.php AUR]

= Slackware =
Compile and Install using [http://github.com/cycojesus/slackbuilds/tree/master/e/emacs emacs.SlackBuild (unofficial)].

= Fedora =

== Emacs 23 ==
Available up to Fedora 16
<source lang="bash">
$ sudo yum install emacs
</source>

== Emacs 24 ==
Available from Fedora 17+
<source lang="bash">
$ sudo yum install emacs
</source>

= SUsE =

== Emacs 23 ==

Available in 12.1 and 12.2. Before that? not sure.

<source lang="bash">
$ sudo zypper install emacs
</source>

== Emacs 24 ==

Not available till 12.2, but available from Factory repo. Add factory repo and then,

<source lang="bash">
$ sudo zypper install emacs
</source>

= Mandriva =
No pre-built packages.

[[Category:GNU/Linux]][[Category:Beginner]][[Category:Install Or Upgrade]]

Package.el

2012-09-04T16:01:33Z

Jstein: /* How to add additional repository */

{{Package
|name=package.el
|description=Package Manager
|author=Tom Tromey
|maintainer=[[FSF]]
|source=http://repo.or.cz/w/emacs.git/blob_plain/HEAD:/lisp/emacs-lisp/package.el
|in_emacs=24
|Development status=active
}}

package.el is the built-in package manager in Emacs 24.

== Install package.el on Emacs 23 ==
<tt>package.el</tt> is bundled with Emacs 24, but it’s not bound to Emacs 24. Before it became part of Emacs it was an external package, known as package.el that was tied to repository called ELPA ('''E'''macs '''L'''isp '''P'''ackage '''A'''rchive). So even if you’re an Emacs 23 user you can copy the latest version of <tt>package.el</tt> from [http://repo.or.cz/w/emacs.git/blob_plain/1a0a666f941c99882093d7bd08ced15033bc3f0c:/lisp/emacs-lisp/package.el here] and enjoy it.

== Configuration ==
Put the following snippet of code near the beginning of your Emacs config, since you’ll definitely want packages installed via <tt>package.el</tt> to be initalized ''before'' you start tweaking them.
<source lang="lisp">
(require 'package)
(package-initialize)
</source>

== Select Packages from the List ==
[[File:M-x package-list-packages.png|400px|thumb|right|M-x package-list-packages]]
<tt>package.el</tt> connects to a list of package repositories, retrieves the list of the packages there, presents it to you in a interactive fashion and lets you install the packages you like (of course you can also remove the ones you don’t like). <tt>package.el</tt> understands the dependencies between packages and if one package requires others to run they will be installed automatically (which is really neat).

The magic starts with the command {{Command|package-list-packages}}. At this point you should see something in the lines of this.

You can navigate the list of packages, mark the ones you want to install with the “i” key or the ones you want removed with the “d” key and when you’re done you can press the “x” key to execute the scheduled actions.

Initially <tt>package.el</tt> didn’t provide the option to update a package, but that should be fixed in recent Emacs builds. According to this [http://lists.gnu.org/archive/html/emacs-devel/2011-09/msg00371.html thread] you can even update all of the installed packages by using the “U” key in the packages list view (I guess that a small “u” would update only one package). Unfortunately my build is lacking those capabilities so I cannot comment of their usability.

== How to add additional repository ==
The list of available packages is short because the official Emacs 24 package repository has strict licensing (and source code) requirements to include a package there. Luckily there are a number of community-maintained <tt>package.el</tt> repos around with much more relaxed requirements. Probably the most popular of them is [http://marmalade-repo.org/ Marmalade], created by [http://nex-3.com/ Nathan Weizenbaum] of Sass and Haml fame. You can include it in your <tt>package-archives</tt> list like this:

<source lang="lisp">
(add-to-list 'package-archives '("marmalade" . "http://marmalade-repo.org/packages/"))
</source>

Marmalade provides a web based UI for package upload and search (both quite buggy unfortunately) and the ability to share the maintenance of a package between several people, who’ll be able to upload new version of the package. There’s also a Emacs Lisp Marmalade tool, that allows you to submit packages directly from Emacs.

== How to use it with a custom build ==
Using the <tt>package.el</tt> UI is ok if you’re a casual Emacs user, but what if you have a custom Emacs configuration, stored under version control, that you’d like to instantly deploy on any OS/machine (like Emacs Prelude). Here in play comes <tt>package.el</tt>’s programmer interface. In [https://github.com/bbatsov/emacs-prelude Emacs Prelude] I use the following code to install a list of required packages automatically on Emacs startup (if necessary):

<source lang="lisp">
;; Comment out if you've already loaded this package...
(require 'cl)

(defvar my-packages
'(ack-and-a-half auctex clojure-mode coffee-mode deft expand-region
gist groovy-mode haml-mode haskell-mode inf-ruby
magit magithub markdown-mode paredit projectile python
sass-mode rainbow-mode scss-mode solarized-theme
volatile-highlights yaml-mode yari zenburn-theme)
"A list of packages to ensure are installed at launch.")

(defun my-packages-installed-p ()
(loop for p in prelude-packages
when (not (package-installed-p p)) do (return nil)
finally (return t)))

(unless (my-packages-installed-p)
;; check for new packages (package versions)
(package-refresh-contents)
;; install the missing packages
(dolist (p prelude-packages)
(when (not (package-installed-p p))
(package-install p))))
</source>

This code check if all of the packages in the list are installed and if any of them are not installed if refreshes the local package database (in the case a required package for recently added to the remote repo) and installs them.

== How to publish it to Marmalade ==
To be able to publish a package to Marmalade (or another repo) it should comform a standardized structure. A single-file package might look like this:

<source lang="lisp">
;;; sass-mode.el --- Sass major mode

;; Copyright 2007-2010 Nathan Weizenbaum

;; Author: Nathan Weizenbaum <nex342@gmail.com>
;; URL: http://github.com/nex3/sass-mode
;; Version: 3.0.20
;; Package-Requires: ((haml-mode "3.0.20"))

;; Code goes here

;;; sass-mode.el ends here
</source>

A multi-file package should have an additional file named
`<name>-pkg.el` that should look like this:

<source lang="lisp">
(define-package "sass-mode" "3.0.20"
"Sass major mode"
'((haml-mode "3.0.20")))

</source>

== package.el Repositories ==

* [[ELPA]]
* [[MELPA]]
* [[Marmalade]]

== External links ==

* [http://batsov.com/articles/2012/02/19/package-management-in-emacs-the-good-the-bad-and-the-ugly/ Package Management in Emacs]

[[Category:Package Manager]][[Category:Built-in Package]]

Package.el

2012-09-04T15:59:42Z

Jstein: /* Select Packages from the List */

{{Package
|name=package.el
|description=Package Manager
|author=Tom Tromey
|maintainer=[[FSF]]
|source=http://repo.or.cz/w/emacs.git/blob_plain/HEAD:/lisp/emacs-lisp/package.el
|in_emacs=24
|Development status=active
}}

package.el is the built-in package manager in Emacs 24.

== Install package.el on Emacs 23 ==
<tt>package.el</tt> is bundled with Emacs 24, but it’s not bound to Emacs 24. Before it became part of Emacs it was an external package, known as package.el that was tied to repository called ELPA ('''E'''macs '''L'''isp '''P'''ackage '''A'''rchive). So even if you’re an Emacs 23 user you can copy the latest version of <tt>package.el</tt> from [http://repo.or.cz/w/emacs.git/blob_plain/1a0a666f941c99882093d7bd08ced15033bc3f0c:/lisp/emacs-lisp/package.el here] and enjoy it.

== Configuration ==
Put the following snippet of code near the beginning of your Emacs config, since you’ll definitely want packages installed via <tt>package.el</tt> to be initalized ''before'' you start tweaking them.
<source lang="lisp">
(require 'package)
(package-initialize)
</source>

== Select Packages from the List ==
[[File:M-x package-list-packages.png|400px|thumb|right|M-x package-list-packages]]
<tt>package.el</tt> connects to a list of package repositories, retrieves the list of the packages there, presents it to you in a interactive fashion and lets you install the packages you like (of course you can also remove the ones you don’t like). <tt>package.el</tt> understands the dependencies between packages and if one package requires others to run they will be installed automatically (which is really neat).

The magic starts with the command {{Command|package-list-packages}}. At this point you should see something in the lines of this.

You can navigate the list of packages, mark the ones you want to install with the “i” key or the ones you want removed with the “d” key and when you’re done you can press the “x” key to execute the scheduled actions.

Initially <tt>package.el</tt> didn’t provide the option to update a package, but that should be fixed in recent Emacs builds. According to this [http://lists.gnu.org/archive/html/emacs-devel/2011-09/msg00371.html thread] you can even update all of the installed packages by using the “U” key in the packages list view (I guess that a small “u” would update only one package). Unfortunately my build is lacking those capabilities so I cannot comment of their usability.

== How to add additional repository ==
You’d probably notice that your list of available packages is not particularly long. That’s because the official Emacs 24 package repository has a strict licensing (and source code) requirements to include a package there. Luckily there are a number of community-maintained <tt>package.el</tt> repos around with much more relaxed requirements. Probably the most popular of them is [http://marmalade-repo.org/ Marmalade], created by [http://nex-3.com/ Nathan Weizenbaum] of Sass and Haml fame. You can include it in your <tt>package-archives</tt> list like this:

<source lang="lisp">
(add-to-list 'package-archives '("marmalade" . "http://marmalade-repo.org/packages/"))
</source>

Marmalade provides a web based UI for package upload and search (both quite buggy unfortunately) and the ability to share the maintenance of a package between several people, who’ll be able to upload new version of the package. There’s also a Emacs Lisp Marmalade tool, that allows you to submit packages directly from Emacs.

== How to use it with a custom build ==
Using the <tt>package.el</tt> UI is ok if you’re a casual Emacs user, but what if you have a custom Emacs configuration, stored under version control, that you’d like to instantly deploy on any OS/machine (like Emacs Prelude). Here in play comes <tt>package.el</tt>’s programmer interface. In [https://github.com/bbatsov/emacs-prelude Emacs Prelude] I use the following code to install a list of required packages automatically on Emacs startup (if necessary):

<source lang="lisp">
;; Comment out if you've already loaded this package...
(require 'cl)

(defvar my-packages
'(ack-and-a-half auctex clojure-mode coffee-mode deft expand-region
gist groovy-mode haml-mode haskell-mode inf-ruby
magit magithub markdown-mode paredit projectile python
sass-mode rainbow-mode scss-mode solarized-theme
volatile-highlights yaml-mode yari zenburn-theme)
"A list of packages to ensure are installed at launch.")

(defun my-packages-installed-p ()
(loop for p in prelude-packages
when (not (package-installed-p p)) do (return nil)
finally (return t)))

(unless (my-packages-installed-p)
;; check for new packages (package versions)
(package-refresh-contents)
;; install the missing packages
(dolist (p prelude-packages)
(when (not (package-installed-p p))
(package-install p))))
</source>

This code check if all of the packages in the list are installed and if any of them are not installed if refreshes the local package database (in the case a required package for recently added to the remote repo) and installs them.

== How to publish it to Marmalade ==
To be able to publish a package to Marmalade (or another repo) it should comform a standardized structure. A single-file package might look like this:

<source lang="lisp">
;;; sass-mode.el --- Sass major mode

;; Copyright 2007-2010 Nathan Weizenbaum

;; Author: Nathan Weizenbaum <nex342@gmail.com>
;; URL: http://github.com/nex3/sass-mode
;; Version: 3.0.20
;; Package-Requires: ((haml-mode "3.0.20"))

;; Code goes here

;;; sass-mode.el ends here
</source>

A multi-file package should have an additional file named
`<name>-pkg.el` that should look like this:

<source lang="lisp">
(define-package "sass-mode" "3.0.20"
"Sass major mode"
'((haml-mode "3.0.20")))

</source>

== package.el Repositories ==

* [[ELPA]]
* [[MELPA]]
* [[Marmalade]]

== External links ==

* [http://batsov.com/articles/2012/02/19/package-management-in-emacs-the-good-the-bad-and-the-ugly/ Package Management in Emacs]

[[Category:Package Manager]][[Category:Built-in Package]]

Package.el

2012-09-04T15:56:20Z

Jstein: /* How it works */

{{Package
|name=package.el
|description=Package Manager
|author=Tom Tromey
|maintainer=[[FSF]]
|source=http://repo.or.cz/w/emacs.git/blob_plain/HEAD:/lisp/emacs-lisp/package.el
|in_emacs=24
|Development status=active
}}

package.el is the built-in package manager in Emacs 24.

== Install package.el on Emacs 23 ==
<tt>package.el</tt> is bundled with Emacs 24, but it’s not bound to Emacs 24. Before it became part of Emacs it was an external package, known as package.el that was tied to repository called ELPA ('''E'''macs '''L'''isp '''P'''ackage '''A'''rchive). So even if you’re an Emacs 23 user you can copy the latest version of <tt>package.el</tt> from [http://repo.or.cz/w/emacs.git/blob_plain/1a0a666f941c99882093d7bd08ced15033bc3f0c:/lisp/emacs-lisp/package.el here] and enjoy it.

== Configuration ==
Put the following snippet of code near the beginning of your Emacs config, since you’ll definitely want packages installed via <tt>package.el</tt> to be initalized ''before'' you start tweaking them.
<source lang="lisp">
(require 'package)
(package-initialize)
</source>

== Select Packages from the List ==
[[File:M-x package-list-packages.png]]
What <tt>package.el</tt> basically does is that it connects to a list of package repositories, retrieves the list of the packages there, presents it to you in a interactive fashion and lets you install the packages you like (of course you can also remove the ones you don’t like). <tt>package.el</tt> understands the dependencies between packages and if one package requires others to run they will be installed automatically (which is really neat).

The magic starts with the command {{Command|package-list-packages}}. At this point you should see something in the lines of this.

You can navigate the list of packages, mark the ones you want to install with the “i” key or the ones you want removed with the “d” key and when you’re done you can press the “x” key to execute the scheduled actions.

Initially <tt>package.el</tt> didn’t provide the option to update a package, but that should be fixed in recent Emacs builds. According to this [http://lists.gnu.org/archive/html/emacs-devel/2011-09/msg00371.html thread] you can even update all of the installed packages by using the “U” key in the packages list view (I guess that a small “u” would update only one package). Unfortunately my build is lacking those capabilities so I cannot comment of their usability.

== How to add additional repository ==
You’d probably notice that your list of available packages is not particularly long. That’s because the official Emacs 24 package repository has a strict licensing (and source code) requirements to include a package there. Luckily there are a number of community-maintained <tt>package.el</tt> repos around with much more relaxed requirements. Probably the most popular of them is [http://marmalade-repo.org/ Marmalade], created by [http://nex-3.com/ Nathan Weizenbaum] of Sass and Haml fame. You can include it in your <tt>package-archives</tt> list like this:

<source lang="lisp">
(add-to-list 'package-archives '("marmalade" . "http://marmalade-repo.org/packages/"))
</source>

Marmalade provides a web based UI for package upload and search (both quite buggy unfortunately) and the ability to share the maintenance of a package between several people, who’ll be able to upload new version of the package. There’s also a Emacs Lisp Marmalade tool, that allows you to submit packages directly from Emacs.

== How to use it with a custom build ==
Using the <tt>package.el</tt> UI is ok if you’re a casual Emacs user, but what if you have a custom Emacs configuration, stored under version control, that you’d like to instantly deploy on any OS/machine (like Emacs Prelude). Here in play comes <tt>package.el</tt>’s programmer interface. In [https://github.com/bbatsov/emacs-prelude Emacs Prelude] I use the following code to install a list of required packages automatically on Emacs startup (if necessary):

<source lang="lisp">
;; Comment out if you've already loaded this package...
(require 'cl)

(defvar my-packages
'(ack-and-a-half auctex clojure-mode coffee-mode deft expand-region
gist groovy-mode haml-mode haskell-mode inf-ruby
magit magithub markdown-mode paredit projectile python
sass-mode rainbow-mode scss-mode solarized-theme
volatile-highlights yaml-mode yari zenburn-theme)
"A list of packages to ensure are installed at launch.")

(defun my-packages-installed-p ()
(loop for p in prelude-packages
when (not (package-installed-p p)) do (return nil)
finally (return t)))

(unless (my-packages-installed-p)
;; check for new packages (package versions)
(package-refresh-contents)
;; install the missing packages
(dolist (p prelude-packages)
(when (not (package-installed-p p))
(package-install p))))
</source>

This code check if all of the packages in the list are installed and if any of them are not installed if refreshes the local package database (in the case a required package for recently added to the remote repo) and installs them.

== How to publish it to Marmalade ==
To be able to publish a package to Marmalade (or another repo) it should comform a standardized structure. A single-file package might look like this:

<source lang="lisp">
;;; sass-mode.el --- Sass major mode

;; Copyright 2007-2010 Nathan Weizenbaum

;; Author: Nathan Weizenbaum <nex342@gmail.com>
;; URL: http://github.com/nex3/sass-mode
;; Version: 3.0.20
;; Package-Requires: ((haml-mode "3.0.20"))

;; Code goes here

;;; sass-mode.el ends here
</source>

A multi-file package should have an additional file named
`<name>-pkg.el` that should look like this:

<source lang="lisp">
(define-package "sass-mode" "3.0.20"
"Sass major mode"
'((haml-mode "3.0.20")))

</source>

== package.el Repositories ==

* [[ELPA]]
* [[MELPA]]
* [[Marmalade]]

== External links ==

* [http://batsov.com/articles/2012/02/19/package-management-in-emacs-the-good-the-bad-and-the-ugly/ Package Management in Emacs]

[[Category:Package Manager]][[Category:Built-in Package]]

File:M-x package-list-packages.png

2012-09-04T15:54:56Z

Jstein: M-x_package-list-packages

M-x_package-list-packages

Package.el

2012-09-04T15:49:03Z

Jstein: /* Install package.el on Emacs 23 */

{{Package
|name=package.el
|description=Package Manager
|author=Tom Tromey
|maintainer=[[FSF]]
|source=http://repo.or.cz/w/emacs.git/blob_plain/HEAD:/lisp/emacs-lisp/package.el
|in_emacs=24
|Development status=active
}}

package.el is the built-in package manager in Emacs 24.

== Install package.el on Emacs 23 ==
<tt>package.el</tt> is bundled with Emacs 24, but it’s not bound to Emacs 24. Before it became part of Emacs it was an external package, known as package.el that was tied to repository called ELPA ('''E'''macs '''L'''isp '''P'''ackage '''A'''rchive). So even if you’re an Emacs 23 user you can copy the latest version of <tt>package.el</tt> from [http://repo.or.cz/w/emacs.git/blob_plain/1a0a666f941c99882093d7bd08ced15033bc3f0c:/lisp/emacs-lisp/package.el here] and enjoy it.

== Configuration ==
Put the following snippet of code near the beginning of your Emacs config, since you’ll definitely want packages installed via <tt>package.el</tt> to be initalized ''before'' you start tweaking them.
<source lang="lisp">
(require 'package)
(package-initialize)
</source>

== How it works ==
What <tt>package.el</tt> basically does is that it connects to a list of package repositories, retrieves the list of the packages there, presents it to you in a interactive fashion and lets you install the packages you like (of course you can also remove the ones you don’t like). <tt>package.el</tt> understands the dependencies between packages and if one package requires others to run they will be installed automatically (which is really neat).

The magic starts with the command {{Command|package-list-packages}}. At this point you should see something in the lines of this.

You can navigate the list of packages, mark the ones you want to install with the “i” key or the ones you want removed with the “d” key and when you’re done you can press the “x” key to execute the scheduled actions.

Initially <tt>package.el</tt> didn’t provide the option to update a package, but that should be fixed in recent Emacs builds. According to this [http://lists.gnu.org/archive/html/emacs-devel/2011-09/msg00371.html thread] you can even update all of the installed packages by using the “U” key in the packages list view (I guess that a small “u” would update only one package). Unfortunately my build is lacking those capabilities so I cannot comment of their usability.

== How to add additional repository ==
You’d probably notice that your list of available packages is not particularly long. That’s because the official Emacs 24 package repository has a strict licensing (and source code) requirements to include a package there. Luckily there are a number of community-maintained <tt>package.el</tt> repos around with much more relaxed requirements. Probably the most popular of them is [http://marmalade-repo.org/ Marmalade], created by [http://nex-3.com/ Nathan Weizenbaum] of Sass and Haml fame. You can include it in your <tt>package-archives</tt> list like this:

<source lang="lisp">
(add-to-list 'package-archives '("marmalade" . "http://marmalade-repo.org/packages/"))
</source>

Marmalade provides a web based UI for package upload and search (both quite buggy unfortunately) and the ability to share the maintenance of a package between several people, who’ll be able to upload new version of the package. There’s also a Emacs Lisp Marmalade tool, that allows you to submit packages directly from Emacs.

== How to use it with a custom build ==
Using the <tt>package.el</tt> UI is ok if you’re a casual Emacs user, but what if you have a custom Emacs configuration, stored under version control, that you’d like to instantly deploy on any OS/machine (like Emacs Prelude). Here in play comes <tt>package.el</tt>’s programmer interface. In [https://github.com/bbatsov/emacs-prelude Emacs Prelude] I use the following code to install a list of required packages automatically on Emacs startup (if necessary):

<source lang="lisp">
;; Comment out if you've already loaded this package...
(require 'cl)

(defvar my-packages
'(ack-and-a-half auctex clojure-mode coffee-mode deft expand-region
gist groovy-mode haml-mode haskell-mode inf-ruby
magit magithub markdown-mode paredit projectile python
sass-mode rainbow-mode scss-mode solarized-theme
volatile-highlights yaml-mode yari zenburn-theme)
"A list of packages to ensure are installed at launch.")

(defun my-packages-installed-p ()
(loop for p in prelude-packages
when (not (package-installed-p p)) do (return nil)
finally (return t)))

(unless (my-packages-installed-p)
;; check for new packages (package versions)
(package-refresh-contents)
;; install the missing packages
(dolist (p prelude-packages)
(when (not (package-installed-p p))
(package-install p))))
</source>

This code check if all of the packages in the list are installed and if any of them are not installed if refreshes the local package database (in the case a required package for recently added to the remote repo) and installs them.

== How to publish it to Marmalade ==
To be able to publish a package to Marmalade (or another repo) it should comform a standardized structure. A single-file package might look like this:

<source lang="lisp">
;;; sass-mode.el --- Sass major mode

;; Copyright 2007-2010 Nathan Weizenbaum

;; Author: Nathan Weizenbaum <nex342@gmail.com>
;; URL: http://github.com/nex3/sass-mode
;; Version: 3.0.20
;; Package-Requires: ((haml-mode "3.0.20"))

;; Code goes here

;;; sass-mode.el ends here
</source>

A multi-file package should have an additional file named
`<name>-pkg.el` that should look like this:

<source lang="lisp">
(define-package "sass-mode" "3.0.20"
"Sass major mode"
'((haml-mode "3.0.20")))

</source>

== package.el Repositories ==

* [[ELPA]]
* [[MELPA]]
* [[Marmalade]]

== External links ==

* [http://batsov.com/articles/2012/02/19/package-management-in-emacs-the-good-the-bad-and-the-ugly/ Package Management in Emacs]

[[Category:Package Manager]][[Category:Built-in Package]]

Org

2012-09-04T15:41:51Z

Jstein:

{{Package
|name=Org,Org-Mode
|description=GTD and document authoring package/markup language
|maintainer=Bastien
|source=http://orgmode.org/w/org-mode.git
|in_emacs=yes (likely be out of date)
|Development status=active
|website=http://orgmode.org
}}

'''Org''' is an Emacs mode for keeping notes, maintaining TODO lists,
project planning, outlining, and authoring with a fast and effective
plain-text system. Org Mode is simple enough to start using right
away, but provides tons of advanced features to support a wide variety
of tasks and workflows.

Org-Mode is distributed with Emacs (since Emacs 22.2). This project is
under active development and new releases are often available.

=== Features ===

* Simple plain text markup for hierarchical documents.
* Built-in table editor: easily format tables and work with spreadsheets in plain text.
* Extensible hyperlinking: create cross-references, link to external resources, and more.
* Capture system: create templates to quickly capture and file notes and tasks.
* Sequences of TODO-style keywords for task progress tracking.
* Tags, priorities and properties to categorize, sort, filter, and search.
* Custom project views using Org's Agenda.
* Convenient date/time handling for timestamps, deadlines, and scheduling.
* Clock support to track time spent on projects.
* Export from plain-text to a variety of formats (HTML, LaTeX, DocBook, etc).
* Embedded source blocks: edit code blocks in-line with the appropriate mode. Execute code blocks to generate content. Org can even be used for [http://en.wikipedia.org/wiki/Literate_programming literate programming].
* Mobile support providing a subset of Org capabilities on iOS and Android devices.

== External Links ==
The Org-Mode project maintains excellent documentation and has an active community.

* [http://orgmode.org/ Org Project]
* [http://orgmode.org/org-mode-download.html Downloads]
* [http://orgmode.org/org-mode-documentation.html Documentation]
* [http://orgmode.org/w/org-mode.git Source Repository (git)]
* [http://orgmode.org/worg/ Worg, the Org Community!]
* [http://doc.norang.ca/org-mode.html Organize your life in plain text!]

[[Category:Org]][[Category:Document authoring]][[Category:Markup languages]][[Category:Built-in Package]][[Category:Popular Package]] [[Category:GTD]]
[[Category:Desktop Management]][[Category:Organizer]]