twiki

Homepage: https://github.com/christopherjwhite/emacs-twiki-mode

Author: Christopher J. White

Updated:

Summary

Mode for editing Twiki wiki files for emacs

Commentary

This package is a major mode for editing TWiki pages
(http://twiki.org).  Twiki formatted pages are reformatted on
import into a twiki buffer to enhance readibility and friendlier
editing.  After editing, the pages are "exported" back to the twiki
format.

The key benefits to twiki mode:

  * Keyboard shortcuts for common operations 
  * Auto-numbering of headings, numbered lists
  * Better bullet list management
  * orgtbl-minor mode for table editing
  * table numbering
  * font-lock support for syntax highlighting

Typical usage:

  1. In Web Browser, click edit in Twiki on the page to edit

  2. Select all and copy to clipboard
  
  3. In emacs, twiki-import-for-edit - assuming you are not already
     in a buffer in twiki-mode, this will:
        * create a temp file
        * create buffer visiting that file,
        * set the major mode to twiki-mode
        * render the buffer for "editing", making bullet/lists more readable

  4. Edit as necessary

  5. Export to clipboard using C-c e (twiki-export-to-clipboard)

  6. Back in Web Browser, Select All, and Paste from clipboard
     (replacing old text)
  
  7. Optionally save the file elsewhere

Interesting twiki-mode keys:
   C-c h      Make current line a header line (asks for level, or prefix arg)
   C-c 1-6    Make a Header 1-6 line
   C-c C-h    Renumber all headers using 1.4.3 notation
   C-c C-r    Renumber all headers and tables
   C-c C-t    Renumber all tables
   C-c i      Import clipboard
   C-c e      Export to clipboard, rendering bullets/lists back to 
              twiki format
Bullet lists:
   Tab        Indent bullet list
   S-Tab      Unindent bullet list

Headings:
   Tab        Hide/show direct subtree
   S-Tab      Hide/show all subtrees

Server:
   C-c t p    Upload to the server for a preview
   C-c t s    Save as a new revision on the server
   C-c t u    Update the local copy from the latest on the server
   C-c t t    Return the status of the current document
   C-c t d    Diff the current buffer against the server version
   
When saving the buffer to a file, the format is saved as
twiki-format (the buffer is rendered for export, then saved).

Dependencies