Step 1: Create an account on the Mediawiki server.

It should hopefully go without saying that you will want to become familiar with the editorial, usage, and copyright guidelines of the site. You should probably also make some contributions through the normal UI, and learn about following recent changes before contributing using mvs.

In addition for the sake of this test you should already have a user page like User:<username> with something on it, where <username> is the user name with which you established the account.

Step 2: Create a working directory

Simply use "mkdir" or the equivalent to make a new directory, and then before cd into that directory.

  mkdir wikitravel.en
  cd wikitravel.en

All of the operations below should be done from this directory.

Step 3: Login using "mvs login"

  www.wikitravel.org

Now use the host with your username and password to login.

  mvs login -d www.wikitravel.org -u <username> -p 'secret'

If "mvs" knows about your Mediawiki host it will set set the "wiki_path" to the correct default for that server. In this case it will also be able to select the language version of that Wiki for you if you specify a "language_code":

  mvs login -d www.wikitravel.org -l fr -u <username> -p 'secret'

The code must match the one which your wiki host uses for a given language, and of course the language version must exist for the given host.

If your Mediawiki install uses a nonstandard path to the wiki script you can specify it on login. The path to the wiki script is the part of the URL after the host name, and before the '?':

  mvs login \
    -d www.wikitravel.org \
    -u <username> \
    -p 'secret' \
    -w 'mw/wiki.phtml'

You can change the edit and action paths in the created .mediawiki file after successful login accordingly.

Now anything you submit to the Mediawiki server will be credited to user "<username>".

NOTE: If you have been using an earlier version of "mvs" you should probably delete the .mediawiki file in your working directory.

Step 4: Use "mvs update" to fetch one or more working files

  mvs update User:<username>.wiki User:<username>/Test_Page.wiki

This should produce the output:

  U User:<username>.wiki
  A User:<username>/Test_Page.wiki

The U (for Updated) means that User:<username> was found on the server and its contents inserted into the local files. The A (for Added) means that the User:<username>/Test_Page.wiki page does not yet exist on the server, and will be added when you run "mvs commit".

Note that both of the pages we are working with are within your User Namespace. It's probably a good idea to restrict yourself to working with such pages while you are experimenting with "mvs"

Step 5: Edit the files to make corrections and contributions

  http://en.wikipedia.org/wiki/Wikipedia:Syntax_highlighting

Of course if you don't find a highlighting file for you editor you are welcome to create one and submit it to the page above.

Step 6: Use "mvs commit" to submit your changes

  mvs commit -m 'commit message' User:<username>.wiki

Where 'commit message' is whatever you want to say about the changes you are submitting and why. You must provide a commit message or "mvs commit" will fail. You might also find that "mvs commit" fails complaining that the file has changed on the server. If this is the case you will need to use "mvs update" again to get the most recent changes.

Step 7: Update your wiki files

If for some reason there is a conflict, i.e. you and someone else have made changes which appear to be incompatible, and cannot be resolved then your file will contain a conflict message, as detailed in the documentation for "mvs update" below. You must resolve any conflicts before attempting to use "mvs commit" on the file. This is usually a very simple matter of choosing one version of the change or another. You should use your best judgement, consulting the relevant "Talk:" page to try to work out an agreement with the other contributor in cases where you just simply disagree.

Repeat

Commands

mvs login

Allows the user to login to the Mediawiki server using an existing login and password for that server. After calling "login" all "commit"s from the same working directory will be logged as from the logged-in user.

mvs update

Updates the specified file[s] with content from the Mediawiki server. If a file does not exist it is created and populated with the current online version. If there is no online version, the file either created and left blank, or just left as it is. If there is content in both the specified file and in the corresponding Wiki page, an attempt is made to merge the two, line by line. Files which are the same as the server version are ignored.

If no filenames are given on the command line, all visible files with the .wiki extension are processed.

Conflicting changes to a given line are detected on the basis of the date of the most recent update of the local file and date of the most recent change to the online Wiki page. If a line has changed in both the online page and the local file it is flagged as a conflict, as in CVS, but with a slightly different syntax:

  ********************Start of conflict 1  Insert to Primary, Insert to Secondary ************************************************************

  The line as it appears on the server

  ****************************************************************************************************

  The line as it appears locally
  ********************End of conflict 1********************************************************************************
    

"mvs update" reports the status of files which it touches to STDERR with a letter indicating the file status, and then name of the file, again like CVS. The status letters are:

commit

Commits any changes in the specified local file to the Wiki site. A check is made first to make sure that there are no changes on the server more recent than the most recent update. Nothing will be comitted if the file and server version are identical.

When running "mvs commit" you must use the "-m" flag to send a commit message to the Mediawiki server. e.g.:

  mvs commit -m 'Added Hotel Eldorado' Paris.wiki
    

preview

This command functions identically to "mvs commit", except that nothing is actually committed. Instead, the file is uploaded and the Mediawiki server sends back a formatted preview. The "-m" flag is optional. If you set the MVS_BROWSER environmental variable to the path and filename of your favorite browser, mvs will launch it with the preview page.

clean

This command removes any local version reference files relating to pages you've deleted.

  rm Paris.wiki
  mvs clean
    

File names

-h

-D

-q

-u "<username>"

-p "<password>"

-l "<language_code>"

-m "<your message>"

-s "<your message>"

--minor <yes|no|default>

-M

--watch <yes|no|keep|default>

-W

-w "<wiki path>"

-v

MVS_BROWSER

HTTP_PROXY

  export HTTP_PROXY=http://[username:password@]proxy.myorg.org:8080

Mediawiki

CVS