| Index: trunk/extensions/UploadWizard/UploadWizardJsModule/README |
| — | — | @@ -1,66 +0,0 @@ |
| 2 | | -What this is |
| 3 | | -============ |
| 4 | | - |
| 5 | | -It's the first stab at a more usable multimedia uploader, particularly for Wikimedia Commons. |
| 6 | | - |
| 7 | | -Main features: |
| 8 | | - - Multiple simultaneous file uploads |
| 9 | | - - Batch assertion of license ("all these files were CC-BY-SA") |
| 10 | | - - "Incomplete" uploads, where the data can be uploaded and metadata edited without really adding the file to the collection. |
| 11 | | - - (Eventually) Gee-whiz technology like HTML5 drag & drop from the desktop |
| 12 | | - |
| 13 | | -http://usability.wikimedia.org/wiki/Multimedia:NewUpload |
| 14 | | - |
| 15 | | - |
| 16 | | -General disclaimer |
| 17 | | -=================== |
| 18 | | - |
| 19 | | -For the moment, (March 2010) UploadWizard is all alpha quality code. |
| 20 | | -It often does not conform to the MediaWiki coding standards. This will have to be fixed before it gets merged into trunk. |
| 21 | | - |
| 22 | | -It uses MwEmbed because it was found to be very difficult to separate it from the framework. |
| 23 | | -Furthermore, it is somewhat redundant with the AddMedia module. AddMedia has a lot of useful code but |
| 24 | | -not factored in the way that would be most convenient for this module. Michael Dale (mdale) and myself (NeilK) |
| 25 | | -are attempting to refactor things and meet in the middle. |
| 26 | | - |
| 27 | | -Presently (March 2010) we are sprinting to get a hacky interface up to conduct a usability test on our |
| 28 | | -basic ideas about updating media uploads for commons. Nothing here is expected to stay here permanently. |
| 29 | | - |
| 30 | | -Stay tuned, or, talk to NeilK about this, if anything here bothers you. |
| 31 | | - |
| 32 | | - |
| 33 | | -How to use it |
| 34 | | -============= |
| 35 | | - |
| 36 | | -This is *very* complicated at present. Obviously we want to make this simpler in the future. |
| 37 | | - |
| 38 | | -Currently mdale tests with the live Commons site by loading in code from a JS2-enabled prototype. |
| 39 | | -This is accomplished with a gadget on Commons (or other additions to the skin). |
| 40 | | - |
| 41 | | -Here's how you might do such a thing: |
| 42 | | - |
| 43 | | -- Set up an instance of MediaWiki from trunk; or, if feeling brave[1], use a real site like Commons itself. |
| 44 | | -- Set up an instance of MediaWiki from js-work branch, which your browser can access. |
| 45 | | -- On this trunk-based Mediawiki, install a gadget which is invoked on all pages to load some code from the JS2-enabled site. Since |
| 46 | | - this is all accomplished in your browser, you could use a local hostname. (See below). |
| 47 | | -- Point your browser to the upload page on the trunk-based mediawiki, with a special parameter: Special:Upload?uploadWizard=1 . |
| 48 | | - |
| 49 | | - |
| 50 | | -[1] Currently I (NeilK) use a local MediaWiki, since we are uploading stuff *without* the normal checks |
| 51 | | - that the Commons people have carefully added. |
| 52 | | - |
| 53 | | -[2] The gadget might look like this: |
| 54 | | - |
| 55 | | -// Once mwEmbed is "on" we can use mw.setConfig calls: |
| 56 | | -if( typeof mwAddMediaConfig == 'undefined'){ |
| 57 | | -mwAddMediaConfig = {}; |
| 58 | | -} |
| 59 | | -mwAddMediaConfig['enabled_providers'] = [ 'wiki_commons', 'upload' ] |
| 60 | | - |
| 61 | | -importScriptURI('http://js2-work.yoursite.local/js/mwEmbed/remotes/mediaWiki.js?&uselang=en&debug=true' ); |
| 62 | | - |
| 63 | | - |
| 64 | | - |
| 65 | | - |