docs: mw.Upload.Dialog: Add another usage example in introduction
authorPrateek Saxena <prtksxna@gmail.com>
Tue, 20 Oct 2015 06:54:56 +0000 (12:24 +0530)
committerPrateek Saxena <prtksxna@gmail.com>
Tue, 20 Oct 2015 06:54:56 +0000 (12:24 +0530)
Change-Id: I8ed1470b712643b23e86a167f06d2fd1116e8627

resources/src/mediawiki/mediawiki.Upload.Dialog.js

index 03e3971..220a3fe 100644 (file)
         *
         * The dialog's closing promise can be used to get details of the upload.
         *
+        * If you want to use a different OO.ui.BookletLayout, for example the
+        * mw.ForeignStructuredUpload.BookletLayout, like in the case of of the upload
+        * interface in VisualEditor, you can pass it in the {@link #cfg-bookletClass}:
+        *
+        *     var uploadDialog = new mw.Upload.Dialog( {
+        *         bookletClass: mw.ForeignStructuredUpload.BookletLayout
+        *     } );
+        *
+        *
         * @class mw.Upload.Dialog
         * @uses mw.Upload
+        * @uses mw.Upload.BookletLayout
         * @extends OO.ui.ProcessDialog
         * @cfg {Function} [bookletClass=mw.Upload.BookletLayout] Booklet class to be
         *     used for the steps