POD-mode: Emacs Plain Old Documentation format major mode

Thoughts

There's a good way to do this (parsing the podfile and operating on lisp lists), which isn't the way I'm going to do it. Instead, I shall be using the time-tested technique of blind macros and the less-tested technique of structural regex.

Overview

Keymap

Structural = M, markup = C (that way I can reuse mnemonic binds)

Headings: C-c M-1/2/3/4/5/6

List: C-c M-l (list)

Item: C-c M-i (item)

Begin/end: C-c M-b (block)

For: C-c M-f

Italic: C-c C-S-i (italicize region), C-c C-i (insert italics)

Bold: C-c C-S-b (bold region), C-c C-b (insert bold)

Link: C-c C-S-l (link region), C-c C-l (insert link)

Code: C-c C-S-c (code region), C-c C-c (insert code)

Escape: C-c C-e

Filename: C-c C-f

Nonbreaking space text: C-c C-S-s (region), C-c C-s (insert)

Z<>: C-c C-z

Render: C-c C-r

Render and display as HTML: C-c M-r

Installation

Stick pod-mode.el in your ~/.emacs.d or equivalent

Stick (require 'pod-mode) in your init.el or .emacs (making sure that it's in your load-path)

Variables

pod-renderer: which pod2xxx renderer you want to use (pod2html is the default; on most Perl installs, pod2html, pod2text, pod2man, and pod2latex are available)

pod-render-options: what options you want pod-renderer to be called with (default is an empty string)

Resources

Keymapping

POD overview