Mediawiki.el

2012-06-12T15:37:28Z

207.171.191.60: Noted the API enablement requirement

{{Package
|name=mediawiki.el
|description=Mediawiki interface and markup mode
|author= Jerry et al
|maintainer=Mark A. Hershberger
|source=https://code.launchpad.net/~hexmode/mediawiki-el/trunk
|in_emacs=no
|Development status=active
|website=https://code.launchpad.net/~hexmode/mediawiki-el
}}

'''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.

==Setup==

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

=== Site requirements ===

The MediaWiki site that you wish to edit must have its API enabled:

<pre>
$wgEnableAPI=true;
</pre>

==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.

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

<syntaxhighlight lang="lisp">
(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")
</syntaxhighlight>

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

==Usage==
; {{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

==Customizations==
=== Word Wrap ===

Mediawiki sites are generally [[Emacs_Terminology#Fill |unfilled]]: do not add hard line breaks within a paragraph. There are various ways to wrap lines [[Emacs_Terminology#Screen Lines |visually]] while you edit. For example in Emacs 24 you may want to enable [[Visual Line]] mode with a [[mode hook]]:

<syntaxhighlight lang="lisp">
(setq mediawiki-mode-hook (lambda ()
(visual-line-mode 1)))
</syntaxhighlight>

=== Edit or Create a page in a web browser ===

Right now '''Mediawiki.el''' fails silently whenever the site asks for number challenge
(spam protection). The following snippet allows you to edit/create a
page in a web browser

<syntaxhighlight lang="lisp">
(defun yyr-mediawiki-browser-edit/create-page (page &optional site)
"Edit a page in browser, asks for page name (sitename also if needed)"
(interactive "sPage name (words): ")
(let* ((site (mediawiki-prompt-for-site))
(url (mediawiki-site-extract site 1))
(index "index.php?title=")
(et "&action=edit"))
(funcall 'browse-url
(message "%s%s%s%s"
url index (mediawiki-translate-pagename page) et))))
</syntaxhighlight>

Call {{Function| yyr-mediawiki-browser-edit/create-page}}

=== key binding to open current editing file in web browser? ===

bind {{Function|mediawiki-browse}} to some key chord. The following
uses {{Keys|C-c o}}

<syntaxhighlight lang="lisp">

(define-key mediawiki-mode-map (kbd "C-c o") 'mediawiki-browse)

</syntaxhighlight>

==External Links==
*[http://www.emacswiki.org/emacs/MediaWikiMode EmacsWiki:MediaWikiMode]
*[https://launchpad.net/mediawiki-el Project Page]

[[Category:Third Party Package]]
[[Category:Markup languages]]

WikEmacs - User contributions [en]

Mediawiki.el