## abstract

the commonist is a simple upload clients for wikimedia commons and a number of other mediawiki sites. it is written in java and BeanShell.

this software is in beta state, so don't complain if it's broken ;)

## contact

the dot gray at gmx dot net (write in english or german)

## license

the commonist is released under the GPL.

## requirements

JDK 1.5.0 or newer | http://java.sun.com/javase/

## download

$(project)-$(version).zip (sources included)

see changes.txt for changes in version $(version).

## usage

1. click this link to start the commonist if you have webstart installed. the webstart files of the commonist are signed with a snake oil certificate, so an ugly warning will pop up.
2. alternatively, you can download `$(project)-$(version).zip` and unpack it. this will create a new directory `$(project)-$(version)`. cd into this directory and start the commonist with `bin/commonist` (on linux or mac os x), or `$ bin\commonist.bat` (on windows).
   note: on windows, you may have to click away a requester at program startup with `continue`.

## customization

### license templates

this works with the webstart version and the zipfile version.

1. copy `etc/licenses.txt` to `$HOME/.commonist/licenses.txt`.
2. change `$HOME/.commonist/licenses.txt` as you like.
3. if `$HOME/.commonist/licenses.txt` exists, it overrides settings in `etc/licenses.txt`.

### gallery templates

this works with the webstart version and the zipfile version.

1. the gallery is built from template files. the templates contain wiki markup, lines starting with a `#` are beanshell code toi be executed, `$()` encloses beanshell code to be printed.
2. `etc/gallery_commons.bpp` and `etc/image_commons.bpp` are used for commons, `etc/gallery_default.bpp` and `etc/image_default.bpp` for other wikis.
3. copy one or more of these files to `$HOME/.commonist/`
4. change them as you like.

### adding an UI-language

this works with the zipfile version, but not with the webstart version.

1. copy `etc/messages_en.properties` to `$HOME/.commonist/messages_xxx.properties`, xxx is the user language printed out on startup.
2. translate `$HOME/.commonist/messages_xxx.properties`

### adding a wiki

this works with the webstart version and the zipfile version.

1. unpack `lib/mwapi.jar` from the unpacked binary zip into a new directory
2. look for `commons.family` and `commons.site` in this directory
3. create a directory `$HOME/.commonist/family`
4. copy `commons.family` to `$HOME/.commonist/family/NAME.family`
5. copy `commons.site` to `$HOME/.commonist/family/NAME.site`
6. adapt these two files.

### running code on startup

this works with the webstart version and the zipfile version.

you can create a file `$HOME/.commonist/startup.bsh` which is executed on startup. this can be used for automatic login, to provide passwords for htaccess-protected servers and to allow untrusted SSL-certificates. have a look at `etc/startup.bsh` for examples.

## supported sites

commons | - | c | http://commons.wikimedia.org
meta | - | m | http://meta.wikimedia.org
mediawiki | - | mw | http://www.mediawiki.org
wikipedia | arabic | w:ar | http://ar.wikipedia.org
wikipedia | catalan | w:ca | http://ca.wikipedia.org
wikipedia | danish | w:da | http://da.wikipedia.org
wikipedia | german | w:de | http://de.wikipedia.org
wikipedia | english | w:en | http://en.wikipedia.org
wikipedia | esperanto | w:eo | http://eo.wikipedia.org
wikipedia | spanish | w:es | http://es.wikipedia.org
wikipedia | estonian | w:et | http://et.wikipedia.org
wikipedia | finnish | w:fi | http://fi.wikipedia.org
wikipedia | french | w:fr | http://fr.wikipedia.org
wikipedia | hebrew | w:he | http://he.wikipedia.org
wikipedia | croatian | w:hr | http://hr.wikipedia.org
wikipedia | interlingua | w:ia | http://ia.wikipedia.org
wikipedia | italian | w:it | http://it.wikipedia.org
wikipedia | japanese | w:ja | http://ja.wikipedia.org
wikipedia | dutch | w:nl | http://nl.wikipedia.org
wikipedia | norwegian | w:no | http://no.wikipedia.org
wikipedia | polish | w:pl | http://pl.wikipedia.org
wikipedia | portuguese | w:pt | http://pt.wikipedia.org
wikipedia | romanian | w:ro | http://ro.wikipedia.org
wikipedia | slovenian | w:sl | http://sl.wikipedia.org
wikipedia | swedish | w:sv | http://sv.wikipedia.org
wikipedia | chinese | w:zh | http://zh.wikipedia.org
wikisource | english | s:en | http://en.wikisource.org
wikisource | german | s:de | http://de.wikisource.org
wikisource | french | s:fr | http://fr.wikisource.org
wikisource | japanese | s:ja | http://ja.wikisource.org
wikisource | dutch | s:nl | http://nl.wikisource.org
wikisource | italian | s:it | http://it.wikisource.org
wikisource | swedish | s:sv | http://sv.wikisource.org
wikisource | polish | s:pl | http://pl.wikisource.org
wikisource | portuguese | s:pt | http://pt.wikisource.org
wikisource | spanish | s:es | http://es.wikisource.org
wikibooks | german | b:de | http://de.wikibooks.org
wikibooks | english | b:en | http://en.wikibooks.org
wikibooks | french | b:fr | http://fr.wikibooks.org
wikibooks | japanese | b:ja | http://ja.wikibooks.org
wikibooks | dutch | b:nl | http://nl.wikibooks.org
wikibooks | italian | b:it | http://it.wikibooks.org
wikibooks | swedish | b:sv | http://sv.wikibooks.org
wikibooks | polish | s:pl | http://pl.wikibooks.org
wikibooks | portuguese | b:pt | http://pt.wikibooks.org
wikibooks | spanish | b:es | http://es.wikibooks.org
wiktionary | german | wikt:de | http://de.wiktionary.org
wiktionary | english | wikt:en | http://en.wiktionary.org
wiktionary | french | wikt:fr | http://fr.wiktionary.org
wiktionary | japanese | wikt:ja | http://ja.wiktionary.org
wiktionary | dutch | wikt:nl | http://nl.wiktionary.org
wiktionary | italian | wikt:it | http://it.wiktionary.org
wiktionary | swedish | wikt:sv | http://sv.wiktionary.org
wiktionary | polish | s:pl | http://pl.wiktionary.org
wiktionary | portuguese | wikt:pt | http://pt.wiktionary.org
wiktionary | spanish | wikt:es | http://es.wiktionary.org
wikiquote | german | q:de | http://de.wikiquote.org
wikiquote | english | q:en | http://en.wikiquote.org
wikiquote | japanese | q:ja | http://ja.wikiquote.org
wikiquote | dutch | q:nl | http://nl.wikiquote.org
wikiquote | italian | q:it | http://it.wikiquote.org
wikiquote | swedish | q:sv | http://sv.wikiquote.org
wikiquote | polish | s:pl | http://pl.wikiquote.org
wikiquote | portuguese | q:pt | http://pt.wikiquote.org
wikiquote | spanish | q:es | http://es.wikiquote.org
wikinews | german | n:de | http://de.wikinews.org
wikinews | english | n:en | http://en.wikinews.org
wikinews | japanese | n:ja | http://ja.wikinews.org
wikinews | dutch | n:nl | http://nl.wikinews.org
wikinews | italian | n:it | http://it.wikinews.org
wikinews | swedish | n:sv | http://sv.wikinews.org
wikinews | polish | s:pl | http://pl.wikinews.org
wikinews | portuguese | n:pt | http://pt.wikinews.org
wikinews | spanish | n:es | http://es.wikinews.org
wikiversity | german | v:de | http://de.wikiversity.org
wikiversity | english | v:en | http://en.wikiversity.org
kamelopedia | - | kamelo | http://kamelopedia.mormo.org
uncyclopedia | - | unc | http://uncyclopedia.org