sponsor Vim development Vim logo Vim Book Ad

vim-mediawiki-editor : Edit MediaWiki right from Vim!

 script karma  Rating 18/8, Downloaded by 624  Comments, bugs, improvements  Vim wiki

created by
A Quach
 
script type
utility
 
description
== Better description at https://github.com/aquach/vim-mediawiki-editor ==

# vim-mediawiki-editor

Edit MediaWiki articles from the comfort of Vim, your favorite text editor!

## Installation

vim-mediawiki-editor requires Vim compiled with python support and the [python `mwclient` library](https://github.com/mwclient/mwclient).

You likely have Python support, but you can check with `vim --version | grep +python`. MacVim comes with Python support.

If you get an error, try `pip install mwclient` to get the library.

Once you have these, use your favorite Vim plugin manager to install `aquach/vim-mediawiki-editor`, or copy `plugin` and `doc` into your `.vim` folder.

I recommend pairing this plugin with [mediawiki.vim](https://github.com/chikamichi/mediawiki.vim) for syntax highlighting and with [goyo.vim](https://github.com/junegunn/goyo.vim) for WriteRoom-esque editing.

## Usage

vim-mediawiki-editor offers these commands:

#### :MWRead <article-name>

Loads the given article into the current buffer.

```
:MWRead Radish
```

#### :MWWrite [article-name]

Writes the buffer back to the site. If you don't specify an article name, it defaults to the article you currently have open with `:MWRead`. After prompting you for the edit summary and major/minor edit, it will publish your work back to the site.

#### :MWDiff [article-name]

Diffs the current buffer against the hosted version of the article specified on the site. If you don't specify an article name, it defaults to the article you currently have open with `:MWRead`.

#### :MWBrowse [article-name]

Views the article specified in your configured browser. If you don't specify an article name, it defaults to the article you currently have open with `:MWRead`.

## Configuration

If you don't specify these settings, vim-mediawiki-editor will prompt you when you first run a vim-mediawiki-editor command.

#### g:mediawiki_editor_url

The URL of the site you're editing. For the English wikipedia, that'd be `en.wikipedia.org`.

#### g:mediawiki_editor_username

Your account username.

#### g:mediawiki_editor_password

Your account password. I recommend putting the URL and username in your `.vimrc` and letting Vim ask for your password.

## Contributing

This plugin is currently quite simple. Contributions, suggestions, and feedback are all welcomed!
 
install details
 

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
vim-mediawiki-editor-1.0.tgz 1.0 2015-04-02 7.0 A Quach Initial upload
ip used for rating: 18.224.73.125

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.
   
Vim at Github