WikEmacs - User contributions [en]

Template talk:CommandKeys

2014-03-25T11:46:02Z

Alex: Created page with "Would it be worth expanding this to take alternative keybindings - looking at the Keyboard Macros page it seems that should use the CommandKeys template but specify the altern..."

Would it be worth expanding this to take alternative keybindings - looking at the Keyboard Macros page it seems that should use the CommandKeys template but specify the alternatives? [[User:Alex|Alex]] ([[User talk:Alex|talk]]) 07:46, 25 March 2014 (EDT)

Emacs server

2013-01-23T11:38:13Z

Alex: /* Adding To OS Starup */

Emacs includes an optional client-server architecture.

== Starting the Server ==

=== With <code>server-start</code> ===
To start a server in an existing Emacs session, run {{Command|server-start}}. A server started in this manner will close when the last visible Emacs frame closes. If you want Emacs to automatically run a server on startup, add the following to your configuration file.

<syntaxhighlight lang="lisp">
(server-start)
</syntaxhighlight>

=== With <tt>--daemon</tt> ===
Emacs 23 and higher provide the <tt>--daemon</tt> command-line argument, which will cause Emacs to immediately start a server and fork into the background. A server started in this manner is fully daemonized and will remain running even with no visible Emacs frames and after its parent terminal has closed (for example, after an SSH session has disconnected).

Note that, if using <tt>--daemon</tt>, your configuration file will be run while Emacs is still in a terminal. This may affect your theming if you usually use graphical Emacs.

{{Note}}This option is not supported on [[Windows]].

== Using Clients ==

Once the server is started you may use the <code>emacsclient</code> command outside of Emacs to send a file to Emacs for editing, e.g. <code>emacsclient ~/.emacs.d/init.el</code> to modify your init file. On a GNU/Linux system it might be a good idea to set your <tt>EDITOR</tt> environment variable to <tt>emacsclient</tt> or <tt>emacsclient -t</tt>. Using <tt>emacsclient</tt> without any arguments will cause the calling process to simply pause and wait for the Emacs server to report that it's done editing. Using <tt>emacsclient -t</tt> will cause the calling process to put up a text-mode frame in the same terminal.

If the server was started using <tt>--daemon</tt>, you should run <tt>emacsclient -t</tt> or <tt>emacsclient -nc</tt> to create a visible frame to interact with.
== Finishing Up ==

Once you have finished with a buffer that was opened via <tt>emacsclient</tt> you should use the {{CommandKeys|C-x #|server-edit}} to properly close the loop. Killing the buffer normally will not send the signal to <tt>emacsclient</tt> that Emacs has finished with the file.

If you're in an Emacs session that was started using <tt>--daemon</tt>, {{Keys|C-x C-c}} will only close the frame that it was invoked in. It will also signal to the client that owns the frame that its editing job is done, so <tt>emacsclient -c</tt> or <tt>emacsclient -t</tt> as <tt>EDITOR</tt> will behave much like a full <tt>emacs</tt> or <tt>emacs -nw</tt>.

To entirely close a server started with <tt>--daemon</tt>, run {{Command|save-buffers-kill-emacs}} in a frame.
= Adding To OS Startup =
== Debian/Ubuntu ==
== Arch ==
== Gentoo ==
== In OS X ==
[[Category: Server]]

Edit with Emacs

2012-12-17T10:47:02Z

Alex: /* How It Works */

Noted on [[Emacs as a web browser's external editor]].

'''Edit with Emacs''' is extension for the Google Chrome web browser, that lets you edit text areas on a web page with Emacs.

== How It Works ==
* install '''Edit with Emacs''' on your chrome
* download [[edit-server.el]] to your computer (bundled with extension)
* add following line to .emacs
<source lang="lisp">
(add-to-list 'load-path "/path/to/edit-server.el/")
(require 'edit-server)
(edit-server-start)
</source>
* It's recommended to run your emacs as a server as "emacs --daemon" although the edit-server will happily run in a long-running emacs just as well.
* your will find a button at the bottom of textarea when you browse the webpage
* when you press the button a emacs frame will show up, with text already in the textarea
* when you have done, press c-c c-c as "edit-server-done" to update your change to the textarea
* '''Warning''' When you edit textarea, it is likely your change your major mode to [[mediawiki-mode]] or other [[major mode]], this will likely bound the c-c c-c to other commmand, then you should use m-x "edit-server-done" - this should be fixed in the latest v1.11
* [[edit-server.el]] is also available in MELPA

== Mechanism ==

Chrome extension [https://chrome.google.com/webstore/detail/ljobjlafonikaiipfkggjbhkghgicgoh Edit with Emacs] uses its own '''Edit Server''' rather than Emacsclient because Chrome's security policy does not allow extensions to spawn new processes. The extension allows the user to edit text in Emacs and send the results to the browser textarea with {{CommandKeys|C-x #|edit-server-done}}.

[[Category:Third Party Package]]
[[Category:Ubiquitous Emacs]]
[[Category:Browser Support]]

Edit-server.el

2012-05-24T15:36:58Z

Alex: Fixed author tag

{{Package
|name=edit-server.el
|description=Provide an edit server for Chrom(ium) browser extensions
|author=Alex Bennée and Riccardo Murri
|maintainer=Alex Bennée
|source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el
}}

This package provides an Edit Server for Chrom(ium) browsers to send
edit requests to. It's part of the [[Edit with Emacs]] Chromium
extension but will work with other extensions that use the same
protocol.

[[Category:Browser Support]]
[[Category:Ubiquitous Emacs]]
[[Category:Third Party Package]]

Edit with Emacs

2012-05-24T15:34:12Z

Alex: /* How It Works */

Noted on [[Emacs as a web browser's external editor]].

'''Edit with Emacs''' is extension for the Google Chrome web browser, that lets you edit text areas on a web page with Emacs.

== How It Works ==
* install '''Edit with Emacs''' on your chrome
* download [[edit-server.el]] to your computer (bundled with extension)
* add following line to .emacs
<source lang="lisp">
(add-to-list 'load-path "/where/your/edit-server.el/is")
(require 'edit-server)
(edit-server-start)
</source>
* It's recommended to run your emacs as a server as "emacs --daemon" although the edit-server will happily run in a long-running emacs just as well.
* your will find a button at the bottom of textarea when you browse the webpage
* when you press the button a emacs frame will show up, with text already in the textarea
* when you have done, press c-c c-c as "edit-server-done" to update your change to the textarea
* '''Warning''' When you edit textarea, it is likely your change your major mode to [[mediawiki-mode]] or other [[major mode]], this will likely bound the c-c c-c to other commmand, then you should use m-x "edit-server-done" - this should be fixed in the latest v1.11

== Mechanism ==

Chrome extension [https://chrome.google.com/webstore/detail/ljobjlafonikaiipfkggjbhkghgicgoh Edit with Emacs] uses its own '''Edit Server''' rather than Emacsclient because Chrome's security policy does not allow extensions to spawn new processes. The extension allows the user to edit text in Emacs and send the results to the browser textarea with {{CommandKeys|C-x #|edit-server-done}}.

[[Category:Third Party Package]]
[[Category:Ubiquitous Emacs]]
[[Category:Browser Support]]

Template:Package

2012-04-16T16:33:14Z

Alex:

<includeonly>
{{Infobox
| title = {{{name|package name}}}
| label1 = Description
| data1 = {{{description|simple one line description}}}
| label2 = Author
| data2 = {{{author|name of author}}}
| label3 = Maintainer
| data3 = {{{maintainer|name of maintainer}}}
| label4 = Source
| data4 = {{{source|'''no link provided'''}}}
| {{#if: {{{in_emacs|}}}||NULL}}label5 = Part of Emacs
| {{#if: {{{in_emacs|}}}||NULL}}data5 = {{#switch: {{{in_emacs}}}
| 23 = Since Emacs 23
| 24 = Since Emacs 24
| {{{in_emacs}}}
}}
}}
| {{#if: {{{in_elpa|}}}||NULL}}label6 = Available in GNU ELPA
| {{#if: {{{in_elpa|}}}||NULL}}data6 = {{#if: {{{in_elpa|}}}|{{{in_elpa}}}}}
}}</includeonly><noinclude>

== Usage ==

This template is used for adding a Emacs Packages to the wiki and formating a nice bit of boiler plate and auto-categorisation. Parameters include:

* name - Name of package
* description - One line description
* author - Author Name
* maintainer - The maintainer
* source - Where the source code lives
* (optional) in_emacs - When the package was included in emacs
* (optional) in_elpa - Whether or not the package is available for installation via [[ELPA]]

{{Package
|name=edit-server.el
|description=Provide an edit server for Chrom(ium) browser extensions
|author=Alex Bennée
|maintainer=Alex Bennée
|source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el
|in_emacs=No
|category=
}}

By using this template to declare a package you automatically include the page in the [[:Category:Emacs Package|Emacs Package category]]

The sample box shown here is defined using:
<pre>
{{Package
|name=edit-server.el
|description=Provide an edit server for Chrom(ium) browser extensions
|author=Alex Bennée
|maintainer=Alex Bennée
|in_emacs=No
|source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el
}}
</pre>




[[Category:Templates]]
[[Category:Package]]

</noinclude>

Template:Package

2012-04-16T16:31:54Z

Alex:

<includeonly>
{{Infobox
| title = {{{name|package name}}}
| label1 = Description
| data1 = {{{description|simple one line description}}}
| label2 = Author
| data2 = {{{author|name of author}}}
| label3 = Maintainer
| data3 = {{{maintainer|name of maintainer}}}
| label4 = Source
| data4 = {{{source|'''no link provided'''}}}
| {{#if: {{{in_emacs|}}}||NULL}}label5 = Part of Emacs
| data5 = {{#switch: {{{in_emacs}}}
| 23 = Since Emacs 23
| 24 = Since Emacs 24
| {{{in_emacs}}}
}}
}}
| {{#if: {{{in_elpa|}}}||NULL}}label6 = Available in GNU ELPA
| {{#if: {{{in_elpa|}}}||NULL}}data6 = {{#if: {{{in_elpa|}}}|{{{in_elpa}}}}}
}}</includeonly><noinclude>

== Usage ==

This template is used for adding a Emacs Packages to the wiki and formating a nice bit of boiler plate and auto-categorisation. Parameters include:

* name - Name of package
* description - One line description
* author - Author Name
* maintainer - The maintainer
* source - Where the source code lives
* (optional) in_emacs - When the package was included in emacs
* (optional) in_elpa - Whether or not the package is available for installation via [[ELPA]]

{{Package
|name=edit-server.el
|description=Provide an edit server for Chrom(ium) browser extensions
|author=Alex Bennée
|maintainer=Alex Bennée
|source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el
|in_emacs=No
|category=
}}

By using this template to declare a package you automatically include the page in the [[:Category:Emacs Package|Emacs Package category]]

The sample box shown here is defined using:
<pre>
{{Package
|name=edit-server.el
|description=Provide an edit server for Chrom(ium) browser extensions
|author=Alex Bennée
|maintainer=Alex Bennée
|in_emacs=No
|source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el
}}
</pre>




[[Category:Templates]]
[[Category:Package]]

</noinclude>

Template:!

2012-04-16T16:27:27Z

Alex:

|<noinclude>This is a hack to workaround the issue of building templates in parser functions</noinclude>

Template:!

2012-04-16T16:27:00Z

Alex: Created page with "|<noinclude>Hack</noinclude>"

|<noinclude>Hack</noinclude>

Template:Package

2012-04-16T16:26:10Z

Alex:

<includeonly>
{{Infobox
| title = {{{name|package name}}}
| label1 = Description
| data1 = {{{description|simple one line description}}}
| label2 = Author
| data2 = {{{author|name of author}}}
| label3 = Maintainer
| data3 = {{{maintainer|name of maintainer}}}
| label4 = Source
| data4 = {{{source|'''no link provided'''}}}
{{#if: {{{in_emacs|}}} |
{{!}} label5 = Part of Emacs
{{!}} data5 = {{#switch: {{{in_emacs}}}
| 23 = Since Emacs 23
| 24 = Since Emacs 24
| {{{in_emacs}}}
}}
}}
| {{#if: {{{in_elpa|}}}||NULL}}label5 = Available in GNU ELPA
| {{#if: {{{in_elpa|}}}||NULL}}data5 = {{#if: {{{in_elpa|}}}|{{{in_elpa}}}}}
}}</includeonly><noinclude>

== Usage ==

This template is used for adding a Emacs Packages to the wiki and formating a nice bit of boiler plate and auto-categorisation. Parameters include:

* name - Name of package
* description - One line description
* author - Author Name
* maintainer - The maintainer
* source - Where the source code lives
* (optional) in_emacs - When the package was included in emacs
* (optional) in_elpa - Whether or not the package is available for installation via [[ELPA]]

{{Package
|name=edit-server.el
|description=Provide an edit server for Chrom(ium) browser extensions
|author=Alex Bennée
|maintainer=Alex Bennée
|source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el
|in_emacs=No
|category=
}}

By using this template to declare a package you automatically include the page in the [[:Category:Emacs Package|Emacs Package category]]

The sample box shown here is defined using:
<pre>
{{Package
|name=edit-server.el
|description=Provide an edit server for Chrom(ium) browser extensions
|author=Alex Bennée
|maintainer=Alex Bennée
|in_emacs=No
|source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el
}}
</pre>




[[Category:Templates]]
[[Category:Package]]

</noinclude>

Template:Package

2012-04-16T16:21:21Z

Alex: Tried to make version display a little smarter

<includeonly>
{{Infobox
| title = {{{name|package name}}}
| label1 = Description
| data1 = {{{description|simple one line description}}}
| label2 = Author
| data2 = {{{author|name of author}}}
| label3 = Maintainer
| data3 = {{{maintainer|name of maintainer}}}
| label4 = Source
| data4 = {{{source|'''no link provided'''}}}
{{#if: {{{in_emacs|}}}|
{{!}} label5 = Part of Emacs
{{!}} data5 = {{#switch: {{{in_emacs}}}
| 23 = Since Emacs 23
| 24 = Since Emacs 22
| {{{in_emacs}}}
}}
}}
| {{#if: {{{in_elpa|}}}||NULL}}label5 = Available in GNU ELPA
| {{#if: {{{in_elpa|}}}||NULL}}data5 = {{#if: {{{in_elpa|}}}|{{{in_elpa}}}}}
}}</includeonly><noinclude>

== Usage ==

This template is used for adding a Emacs Packages to the wiki and formating a nice bit of boiler plate and auto-categorisation. Parameters include:

* name - Name of package
* description - One line description
* author - Author Name
* maintainer - The maintainer
* source - Where the source code lives
* (optional) in_emacs - When the package was included in emacs
* (optional) in_elpa - Whether or not the package is available for installation via [[ELPA]]

{{Package
|name=edit-server.el
|description=Provide an edit server for Chrom(ium) browser extensions
|author=Alex Bennée
|maintainer=Alex Bennée
|source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el
|in_emacs=No
|category=
}}

By using this template to declare a package you automatically include the page in the [[:Category:Emacs Package|Emacs Package category]]

The sample box shown here is defined using:
<pre>
{{Package
|name=edit-server.el
|description=Provide an edit server for Chrom(ium) browser extensions
|author=Alex Bennée
|maintainer=Alex Bennée
|in_emacs=No
|source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el
}}
</pre>




[[Category:Templates]]
[[Category:Package]]

</noinclude>

Package.el

2012-04-16T16:07:53Z

Alex:

{{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 23. Before it became part of Emacs it was an external package, known as ELPA (I guess that stood for Emacs Lisp Package Manager or something similar). 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 once 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]]

Eproject.el

2012-04-04T14:18:49Z

Alex: use source tags

{{Package
|name=eproject.el
|description=Yet another project management frame-work
|maintainer=Jonathan Rockway
|source=https://github.com/jrockway/eproject
}}

'''Note: there is another package also called eproject'''

The eproject package allows you to define project definitions in Emacs which then will get automatically associated when you open files.

== Configuration ==

<source lang="lisp">
(require 'eproject)
(require 'eproject-compile)

(define-project-type debian-package
(generic)
(look-for "debian")
:common-compiles ("dpkg-buildpackage -rfakeroot"))

(define-project-type android-package
(generic)
(look-for "AndroidManifest.xml")
:common-compiles ("ant compile"))

(define-project-type rockbox
(generic-git)
(look-for "../rockbox.git/rbutil")
:common-compiles ("make" "make install" "make fullzip"))

(define-project-type chrome-extension
(generic)
(look-for "manifest.json"))
</source>

Now when a file is opened that is in the tree for one of these definitions you will find it both in {{minor-mode|eproject}} and a buffer local variable {{Variable|eproject-root}} defined.

[[Category:Third Party Package]]

Eproject.el

2012-04-04T14:17:09Z

Alex: Initial entry

{{Package
|name=eproject.el
|description=Yet another project management frame-work
|maintainer=Jonathan Rockway
|source=https://github.com/jrockway/eproject
}}

'''Note: there is another package also called eproject'''

The eproject package allows you to define project definitions in Emacs which then will get automatically associated when you open files.

== Configuration ==

<pre>
(require 'eproject)
(require 'eproject-compile)

(define-project-type debian-package
(generic)
(look-for "debian")
:common-compiles ("dpkg-buildpackage -rfakeroot"))

(define-project-type android-package
(generic)
(look-for "AndroidManifest.xml")
:common-compiles ("ant compile"))

(define-project-type rockbox
(generic-git)
(look-for "../rockbox.git/rbutil")
:common-compiles ("make" "make install" "make fullzip"))

(define-project-type chrome-extension
(generic)
(look-for "manifest.json"))
</pre>

Now when a file is opened that is in the tree for one of these definitions you will find it both in {{minor-mode|eproject}} and a buffer local variable {{Variable|eproject-root}} defined.

[[Category:Third Party Package]]

User:Alex

2012-04-04T14:08:08Z

Alex: /* Page Creations */

My name is Alex Bennee and I'm the maintainer of [[Edit with Emacs]]

== Page Creations ==

* [[Edit with Emacs]]
* [[edit-server.el]]
* [[eproject.el]]

Org

2012-03-29T09:21:02Z

Alex:

{{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 but 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 varie-ty 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:Organizer]][[Category:Document authoring]][[Category:Markup languages]]

Mediawiki.el

2012-03-29T09:10:54Z

Alex: Add package template

{{Package
|name=mediawiki.el
|description=Mediawiki interface and markup mode
|maintainer=Mark A. Hershberger
|source=https://code.launchpad.net/~hexmode/mediawiki-el/trunk
}}

'''Mediawiki.el''' is a package to help add content to any mediawiki
site including ''WikEmacs''. It comes with a [[Major Mode]] to support editing
Mediawiki markup.

= Basic setup =

Install '''mediawiki.el''' from [[el-get]] or [[ELPA]].

= Customization =

; {{Command|load-library RET mediawiki RET}}
: Load the library

; {{CustomizeVariable|mediawiki-site-alist}}
: Configure as follows and save your settings
:: '''Site Name''': WikEmacs
:: '''URL''': ''http://wikemacs.org/w/''
:: '''Username''': ''InCognito''
:: '''Password''': ''s!cr!t''
:: '''First Page''': ''Main Page''
: You can provide "Username" and "Password" in your [[.authinfo]] file. home directory.

= Make submissions =
; {{Command|mediawiki-site}}
: Choose a site (say "WikEmacs") for the current session.

; {{CommandKeys|C-c C-o|mediawiki-open}}
: Open a page. To edit the main page, type "Main Page". Make your edits.

; {{CommandKeys|C-x C-s|mediawiki-save}}
: Submit your modifications.

; {{CommandKeys|C-c|mediawiki-save-and-bury}}
: Submit modifications and bury the buffer.

= Helpful Keybindings =

; {{CommandKeys|C-return|mediawiki-open-page-at-point}}
: Follow or browse to a WikiLink.

; {{CommandKeys|M-g|mediawiki-reload}}
: Reload a page

[[Category:Wikemacs]]
[[Category:Markup Modes]]
[[Category:Wikemacs Contributor]]

= Project Page =
* [https://launchpad.net/mediawiki-el Mediawiki.el page on Launchpad]

[[Category:Wikemacs Contributor]]
[[Category:Markup Modes]]

Template:Package

2012-03-29T09:07:57Z

Alex:

<noinclude>
== What the template looks like ==
</noinclude>

{{Infobox
| title = {{{name|package name}}}
| label1 = Description
| data1 = {{{description|simple one line description}}}
| label2 = Maintainer
| data2 = {{{maintainer|name of maintainer}}}
| label3 = Source Code
| data3 = {{{source|'''no link provided'''}}}
| {{#if: {{{in_emacs|}}}||NULL}}label4 = Part of Emacs since
| {{#if: {{{in_emacs|}}}||NULL}}data4 = {{#if: {{{in_emacs|}}}|{{in_emacs}}}}}
}}

<includeonly>
[[Category:Emacs Package]]
</includeonly>
<noinclude>


== Usage ==

This template is used for adding a Emacs Packages to the wiki and formating a nice bit of boiler plate and auto-categorisation. Parameters include:

* name - Name of package
* description - One line description
* maintainer - The maintainer
* source - Where the source code lives
* (optional) in_emacs - When the package was included in emacs

For example:

<pre>
{{Package
|name=edit-server.el
|description=Provide an edit server for Chrom(ium) browser extensions
|maintainer=Alex Bennée
|source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el
}}
</pre>

By using this template to declare a package you automatically include the page in the [[:Category:Emacs Package|Emacs Package category]]

Template:Package

2012-03-29T09:05:34Z

Alex: Fixed title

Template:Package

2012-03-29T09:01:13Z

Alex: Add source code and in_emacs links

<noinclude>
== What the template looks like ==
</noinclude>

{{Infobox
| name = {{{name|package name}}}
| label1 = Description
| data1 = {{{description|simple one line description}}}
| label2 = Maintainer
| data2 = {{{maintainer|name of maintainer}}}
| label3 = Source Code
| data3 = {{{source|'''no link provided'''}}}
| {{#if: {{{in_emacs|}}}||NULL}}label4 = Part of Emacs since
| {{#if: {{{in_emacs|}}}||NULL}}data4 = {{#if: {{{in_emacs|}}}|{{in_emacs}}}}}
}}

<includeonly>
[[Category:Emacs Package]]
</includeonly>
<noinclude>


== Usage ==

This template is used for adding a Emacs Packages to the wiki and formating a nice bit of boiler plate and auto-categorisation. Parameters include:

* name - Name of package
* description - One line description
* maintainer - The maintainer
* source - Where the source code lives
* (optional) in_emacs - When the package was included in emacs

For example:

<pre>
{{Package
|name=edit-server.el
|description=Provide an edit server for Chrom(ium) browser extensions
|maintainer=Alex Bennée
|source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el
}}
</pre>

Edit with Emacs

2012-03-29T08:58:21Z

Alex: Break edit-server.el into a proper Emacs Package

'''Edit with Emacs''' is extension to chrome, that you can edit testarea on your webpage with Emacs.

== How It Works ==
* install '''Edit with Emacs''' on your chrome
* download [[edit-server.el]] to your computer (bundled with extension)
* add following line to .emacs
<source lang="lisp">
(add-to-list 'load-path "/where/your/edit-server.el/is")
(require 'edit-server)
(edit-server-start)
</source>
* run your emacs as a server as "emacs --daemon"
* your will find a button at the bottom of textarea when you browse the webpage
* when you press the button a emacs frame will show up, with text already in the textarea
* when you have done, press c-c c-c as "edit-server-done" to update your change to the textarea
* '''Warning''' When you edit textarea, it is likely your change your major mode to [[mediawiki-mode]] or other [[major mode]], this will likely bound the c-c c-c to other commmand, then you should use m-x "edit-server-done"

== Mechanism ==

Chrome extension [https://chrome.google.com/webstore/detail/ljobjlafonikaiipfkggjbhkghgicgoh Edit with Emacs] uses its own '''Edit Server''' rather than Emacsclient because Chrome's security policy does not allow extensions to spawn new processes. The extension allows the user to edit text in Emacs and send the results to the browser textarea with {{CommandKeys|C-x #|edit-server-done}}.

Noted on [[Emacs as a browser's external editor]].

Edit-server.el

2012-03-29T08:55:17Z

Alex: Created page with "{{Package |name=edit-server.el |description=Provide an edit server for Chrom(ium) browser extensions |maintainer=Alex Bennée |source=https://github.com/stsquad/emacs_chrome/b..."

{{Package
|name=edit-server.el
|description=Provide an edit server for Chrom(ium) browser extensions
|maintainer=Alex Bennée
|source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el
}}

This package provides an Edit Server for Chrom(ium) browsers to send edit requests to. It's part of the [[Edit with Emacs]] Chromium extension but will work with other extensions that use the same protocol.

Edit with Emacs

2012-03-29T08:53:22Z

Alex: Not an emacs package, edit-server.el is.

'''Edit with Emacs''' is extension to chrome, that you can edit testarea on your webpage with Emacs.

== How It Works ==
* install '''Edit with Emacs''' on your chrome
* download edit-server.el to your computer
* add following line to .emacs
<source lang="lisp">
(add-to-list 'load-path "/where/your/edit-server.el/is")
(require 'edit-server)
(edit-server-start)
</source>
* run your emacs as a server as "emacs --daemon"
* your will find a button at the bottom of textarea when you browse the webpage
* when you press the button a emacs frame will show up, with text already in the textarea
* when you have done, press c-c c-c as "edit-server-done" to update your change to the textarea
* '''Warning''' When you edit textarea, it is likely your change your major mode to [[mediawiki-mode]] or other [[major mode]], this will likely bound the c-c c-c to other commmand, then you should use m-x "edit-server-done"

== Mechanism ==

Chrome extension [https://chrome.google.com/webstore/detail/ljobjlafonikaiipfkggjbhkghgicgoh Edit with Emacs] uses its own '''Edit Server''' rather than Emacsclient because Chrome's security policy does not allow extensions to spawn new processes. The extension allows the user to edit text in Emacs and send the results to the browser textarea with {{CommandKeys|C-x #|edit-server-done}}.

Noted on [[Emacs as a browser's external editor]].

User:Alex

2012-03-29T08:52:58Z

Alex:

My name is Alex Bennee and I'm the maintainer of [[Edit with Emacs]]

== Page Creations ==

* [[Edit with Emacs]]
* [[edit-server.el]]

Template:Package

2012-03-28T17:24:16Z

Alex:

<noinclude>
== What the template looks like ==
</noinclude>

{{Infobox
| title = '''Emacs Package''': {{{name|package name}}}
| label1 = description
| data1 = {{{description|simple one line description}}}
| label2 = maintainer
| data2 = {{{maintainer|name of maintainer}}}
}}

<includeonly>
[[Category:Emacs Package]]
</includeonly>
<noinclude>

== Usage ==

This template is used for adding a Emacs Packages to the wiki and formating a nice bit of boiler plate and auto-categorisation. Parameters include:

* name - Name of package
* description - One line description
* maintainer - The maintainer
* (optional) in_emacs - When the package was included in emacs
* source - Where the source code lives

For example: ! Not an Emacs extension, a browser extension !

<pre>
{{Package
|name=Edit with Emacs
|description=Edit text areas via Chrom(ium) browsers
|maintainer=Alex Bennée
|source=https://github.com/stsquad/emacs_chrome
}}
</pre>

Template:Package

2012-03-28T17:22:59Z

Alex: rm banner, just use infobox

<noinclude>
== What the template looks like ==
</noinclude>

{{Infobox
| title = '''Emacs Package''': {{{name|package name}}}
| label1 = description
| data1 = {{{description|simple one line description}}}
| label2 = maintainer
| data2 = {{{maintainer|name of maintainer}}}
}}

<includeonly>
[[Category:Emacs Package]]
</includeonly>
<noinclude>

== Usage ==

This template is used for adding a Emacs Packages to the wiki and formating a nice bit of boiler plate and auto-categorisation. Parameters include:

* name - Name of package
* description - One line description
* maintainer - The maintainer
* source - Where the source code lives

For example: ! Not an Emacs extension, a browser extension !

<pre>
{{Package
|name=Edit with Emacs
|description=Edit text areas via Chrom(ium) browsers
|maintainer=Alex Bennée |source=https://github.com/stsquad/emacs_chrome
}}
</pre>

TRAMP

2012-03-28T17:19:33Z

Alex: Add infobox

{{Package
|name=TRAMP
|description=Edit files on remote systems
|in_emacs=since forever?
}}

Emacs' TRAMP feature (Transparent Remote file Access, Multiple Protocol) is an extremely powerful tool for editing files that exist on remote systems, or require access using a different user account from your main Emacs session, or both.

Some of the things that TRAMP can do include:

* Editing files on a remote development server over SSH (e.g. <tt>/ssh:remote-user@remote.box:/path/to/my/file</tt>)
* Editing files on your local machine as root via sudo (e.g. <tt>/sudo::/etc/some/config/file</tt>)
* Editing files on a remote server as root via sudo over an SSH connection from another remote machine that exists within a DMZ (requires some configuration, see below)

TRAMP is included with Emacs and described in the manual.

== Multiple hops ==

To set up multiple hop connections you will need to do a little bit of configuration.

As an example, let's assume that you want to edit a file located at <tt>/etc/httpd/conf/httpd.conf</tt> as root on a remote server at dev.example.com. You have a regular user account <tt>chris</tt> on the development sever, but you need to use sudo to gain root access before editing the file.

Put the following into your configuration files:

<source lang="lisp">
;; Guard to ensure that TRAMP is available
(if (locate-library "tramp")
(eval-after-load "tramp"

;; The actual TRAMP configuration
'(add-to-list 'tramp-default-proxies-alist
'("\\`dev\\.example\\.com\\'"
"\\`chris\\'"
"/ssh:%h:"))))
</source>

After this is evaluated, Emacs knows that the hostname dev.example.com must be accessed over SSH by a user called chris.

If you now try to find <tt>/sudo:dev.example.com:/etc/httpd/conf/httpd.conf</tt> Emacs will automatically create the SSH connection first, prompting you for your password if necessary. Then it will prompt you for your sudo password. Once this is all done you will be able to modify the buffer as necessary. Saving the buffer will do what you expect: it will update the file on the remote server.

It is also possible to configure partial domains, for instance in case you need an SSH connection before modifying anything on <tt>*.example.com</tt>.

Hops can be chained, making this feature extremely powerful.

== A note for Windows users ==

TRAMP uses programs that are usually included with GNU/Linux systems under the hood. These are not usually available on a Windows system.

The <tt>plink</tt> method built into TRAMP can be used as a mostly drop-in replacement for SSH connections. It uses <tt>plink.exe</tt> from the [http://www.chiark.greenend.org.uk/~sgtatham/putty/ PuTTY suite of tools], which must be installed separately.

[[Category:Remote Edit]]

Template:Function

2012-03-28T13:52:52Z

Alex: Add to category of Emacs Wiki Templates

'''''‘{{{1}}}’ (C-h f {{{1}}} RET)'''''<noinclude>
[[Category:Emacs Wiki Templates]]
</noinclude>

User:Alex

2012-03-28T11:28:04Z

Alex:

My name is Alex Bennee and I'm the maintainer of [[Edit with Emacs]]

User talk:Bozhidar

2012-03-28T11:27:51Z

Alex: Ask question about Infobox's

Bozhidar if you are removing content (and not modifying or improving it) then I will assume that you want a WikEmacs as your personal page and not as a community website.

I will stop contributing if you '''delete''' the content that I add.

Please reinstate my CEDET entry.

-- Anonymous

Hi, there. I meant no disrespect. I removed the entry because I was about to place in an article about CEDET itself. Sorry about that. Rest assured - everyone's contributions are most welcome. The entry is reinstated, but CEDET is a huge topic with little official documentation that probably deserves a section of it's own in the wiki. Alex's article might serve as a basis for such an article I assume.

[[User:Bozhidar|Bozhidar]] 17:29, 26 March 2012 (EEST)

----

Any chance you could import the mediawiki Infobox templates? It would also be useful to have access to the parserfunctions extension.

[[User:Alex|Alex]] 14:27, 28 March 2012 (EEST)

Template:Package

2012-03-28T11:25:01Z

Alex: Initial attempt at a template

<noinclude>
== What the template looks like ==
</noinclude>

{| style="padding:5px; border:1px solid #ffcc00; text-align:center; background:#FFFDDF; width:100%; margin-bottom:.2em;"
| '''Package:''' This describes an Emacs Package.
|}

{{Infobox
| title = {{#if: {{{name|}}} | {{{name}}} |'''package name''' }}
| {{#if: {{{description|}}}||NULL}}label1 = description
| {{#if: {{{description|}}}||NULL}}data1 = {{{description}}}
}}

<includeonly>
[[Category:Emacs Package]]
</includeonly>
<noinclude>

== Usage ==

This template is used for adding a Emacs Packages to the wiki and formating a nice bit of boiler plate and auto-categorisation. Parameters include:

* name - Name of package
* description - One line description
* maintainer - The maintainer
* source - Where the source code lives

For example:

<pre>
{{Package
|name=Edit with Emacs
|description=Edit text areas via Chrom(ium) browsers
|maintainer=Alex Bennée |source=https://github.com/stsquad/emacs_chrome
}}
</pre>

Edit with Emacs

2012-03-28T11:18:19Z

Alex: Initial entry - experimenting with templates

{{Package
|name=Edit with Emacs
|description=Edit text areas via Chrom(ium) browsers
|maintainer=Alex Bennée
|source=https://github.com/stsquad/emacs_chrome
}}

User:Alex

2012-03-28T11:14:19Z

Alex: Inital page

My name is Alex and I'm the maintainer of [[Edit with Emacs]]