aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 95a0c6bda453a6be67f61b904280e5394b9aac31 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# LrMediaWiki [![Build Status](https://travis-ci.org/robinkrahl/LrMediaWiki.svg?branch=master)](https://travis-ci.org/robinkrahl/LrMediaWiki)

**LrMediaWiki** is a plugin for Adobe Photoshop Lightroom that allows users
to upload images to Wikimedia Commons or any other MediaWiki installation
directly from Lightroom.

## Usage information

Usage information can be found on the page [Commons:LrMediaWiki][comlrmw] on
Wikimedia Commons.

## Developer information

LrMediaWiki is developed in Lua using the [Lightroom SDK][lrsdk].  It is
released under the MIT/X11 license.  LrMediaWiki should work with all
Lightroom 5 and 6 installations both on Windows and on Mac OS.

### Code structure

The plugin code is located in the `mediawiki.lrdevplugin` directory.
`Info.lua` defines the plugin metadata to be read by Lightroom.
`MediaWikiExportServiceProvider.lua` defines the user interfaces and passes
all necessary information to `MediaWikiInterface.lua`.  This file evaluates
the user input and prepares the file description and the file itself for the
MediaWiki upload.  The upload is done in `MediaWikiApi.lua`.
`MediaWikiUtils.lua` provides common utility functions, and
`MediaWikiMetadataProvider.lua` defines the custom metadata containing e. g.
the file description and additional categories and templates.

[comlrmw]: https://commons.wikimedia.org/wiki/Commons:LrMediaWiki
[lrsdk]: http://www.adobe.com/devnet/photoshoplightroom.html