Difference between revisions of "Mediawiki.el"

From WikEmacs
Jump to navigation Jump to search
(extended the customization section a bit)
Line 44: Line 44:
 
'''mediawiki-site-alist''' variable.
 
'''mediawiki-site-alist''' variable.
  
= Make submissions =
+
= Basic Usage =
 +
== Make submissions ==
 
; {{Command|mediawiki-site}}
 
; {{Command|mediawiki-site}}
 
: Choose a site (say "WikEmacs") for the current session.  
 
: Choose a site (say "WikEmacs") for the current session.  
Line 64: Line 65:
 
; {{CommandKeys|M-g|mediawiki-reload}}
 
; {{CommandKeys|M-g|mediawiki-reload}}
 
: Reload a page
 
: Reload a page
 +
 +
= Customizations =
 +
Mediawiki sites are generally [[Fill | unfilled ]].
 +
[[Newline character]] are not used for breaking paragraphs. Emacs
 +
does supports [[word wrap]] but from [Emacs 24].
 +
 +
== Emacs 24 ==
 +
You may want to turn on word wrapping.
 +
 +
<syntaxhighlight lang="lisp">
 +
(setq mediawiki-mode-hook (lambda ()
 +
                            (visual-line-mode 1)))
 +
</syntaxhighlight>
 +
  
  

Revision as of 15:15, 30 March 2012

mediawiki.el
Description Mediawiki interface and markup mode
Author name of author
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

M-x load-library RET mediawiki RET
Load the library
M-x customize-variable RET 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.

Alternatively you can add this snippet of Emacs Lisp code to your .emacs:

(require 'mediawiki)

(setq mediawiki-site-alist '(("Wikipedia" "http://en.wikipedia.org/w" "" "" "Main Page")
                             ("WikEmacs" "http://wikemacs.org/w/" "" "" "Main Page")))

;; Emacs users care more for WikEmacs than Wikipedia :-)
(setq mediawiki-site-default "WikEmacs")

You can naturally add more MediaWiki sites to the mediawiki-site-alist variable.

Basic Usage

Make submissions

M-x mediawiki-site
Choose a site (say "WikEmacs") for the current session.
[C-c C-o] (or M-x mediawiki-open)
Open a page. To edit the main page, type "Main Page". Make your edits.
[C-x C-s] (or M-x mediawiki-save)
Submit your modifications.
[C-c] (or M-x mediawiki-save-and-bury)
Submit modifications and bury the buffer.

Helpful Keybindings

[C-return] (or M-x mediawiki-open-page-at-point)
Follow or browse to a WikiLink.
[M-g] (or M-x mediawiki-reload)
Reload a page

Customizations

Mediawiki sites are generally unfilled . Newline character are not used for breaking paragraphs. Emacs does supports word wrap but from [Emacs 24].

Emacs 24

You may want to turn on word wrapping.

(setq mediawiki-mode-hook (lambda ()
                            (visual-line-mode 1)))

Project Page