Difference between revisions of "Www-mediawiki-client"

From FreekiWiki
Jump to navigation Jump to search
(describe basic usage of mvs)
(add url to debian package info)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
i'm not so fond of using my web browser as an editor, so i looked for tools to
+
I'm not so fond of using my web browser as an editor, so I looked for tools to download wiki pages and edit them with my preferred editor, [http://www.vim.org vim]. I grabbed [http://search.cpan.org/~markj/WWW-Mediawiki-Client/ WWW::Mediawiki::Client], and built a debian package out of it. and now, years later, through no work of my own, it's part of debian etch: http://packages.debian.org/libwww-mediawiki-client-perl
download wiki pages and edit them with my preferred editor, [http://vim.org vim].
 
  
i grabbed [http://search.cpan.org/~markj/WWW-Mediawiki-Client/ WWW::Mediawiki::Client], and built a debian package out of it.
+
==Installing==
  
 +
apt-get install libwww-mediawiki-client-perl
  
Installing
+
== Usage ==
 
 
you can apt-get it by putting in your /etc/apt/sources.list:
 
 
 
deb http://sempai.fglan/~vagrant/debian unstable/
 
 
 
and then running:
 
 
 
apt-get update
 
 
 
apt-get install libwww-mediawiki-client-perl
 
 
 
from the package description:
 
 
 
WWW::Mediawiki::Client provides a very simple cvs-like interface for
 
Mediawiki driven WikiWiki websites, such as
 
http://www.wikitravel.org|Wikitravel or
 
http://www.wikipedia.org|Wikipedia.
 
.
 
the mvs command (formerly known as wix), mimics the two most basic
 
cvs commands: update and commit with similarly named methods.  Each
 
of these has a shorter alias, as in cvs.
 
 
 
  
 
Basic Usage
 
Basic Usage
 +
mkdir ~/some_wiki_dir
 +
cd ~/some_wiki_dir
  
mkdir ~/some_wiki_dir
+
Log in:
 
+
mvs login -u USERNAME -p PASSWORD -d wiki.freegeek.org -w index.php
cd ~/some_wiki_dir
 
 
 
log in:
 
 
 
mvs login -u USERNAME -p PASSWORD -d wiki.freegeek.org -w index.php
 
  
download a page (don't forget the .wiki part!):
+
Download a page (don't forget the .wiki part!):
 +
mvs up User\:USERNAME.wiki
  
mvs up User\:USERNAME.wiki
+
If you get ? User\:USERNAME.wiki, then you must create the initial page with a
 +
web browser first and then try again.
  
then, edit User\:USERNAME.wiki with your favorite editor.
+
Then, edit User\:USERNAME.wiki with your favorite editor.
  
to commit:
+
To commit:
 +
mvs com -m 'some commit message about what i changed' User\:USERNAME.wiki
  
mvs com -m 'some commit message about what i changed' User\:USERNAME.wiki
+
Alternately, you can do a preview:
 +
mvs preview -m 'some commit message about what i changed' User\:USERNAME.wiki
  
alternately, you can do a preview:
+
And this will generate a preview.html file that you can view with your web-browser. If you like what you see, don't forget to do a "mvs com"
  
mvs preview -m 'some commit message about what i changed' User\:USERNAME.wiki
 
  
and this will generate a preview.html file that you can view with your
+
[[Category:Help]]
web-browser.
 

Latest revision as of 01:13, 30 October 2007

I'm not so fond of using my web browser as an editor, so I looked for tools to download wiki pages and edit them with my preferred editor, vim. I grabbed WWW::Mediawiki::Client, and built a debian package out of it. and now, years later, through no work of my own, it's part of debian etch: http://packages.debian.org/libwww-mediawiki-client-perl

Installing

apt-get install libwww-mediawiki-client-perl

Usage

Basic Usage

mkdir ~/some_wiki_dir
cd ~/some_wiki_dir

Log in:

mvs login -u USERNAME -p PASSWORD -d wiki.freegeek.org -w index.php

Download a page (don't forget the .wiki part!):

mvs up User\:USERNAME.wiki

If you get ? User\:USERNAME.wiki, then you must create the initial page with a web browser first and then try again.

Then, edit User\:USERNAME.wiki with your favorite editor.

To commit:

mvs com -m 'some commit message about what i changed' User\:USERNAME.wiki

Alternately, you can do a preview:

mvs preview -m 'some commit message about what i changed' User\:USERNAME.wiki

And this will generate a preview.html file that you can view with your web-browser. If you like what you see, don't forget to do a "mvs com"