From c3b3e088a7167745a1029e1002ff650cc0233954 Mon Sep 17 00:00:00 2001 From: Neil Kandalgaonkar Date: Wed, 14 Dec 2011 01:26:28 +0000 Subject: [PATCH] add bug reports to feedback --- languages/messages/MessagesEn.php | 20 +++-- maintenance/language/messages.inc | 19 +++-- resources/Resources.php | 5 ++ resources/mediawiki/mediawiki.feedback.js | 91 +++++++++++++++++------ 4 files changed, 98 insertions(+), 37 deletions(-) diff --git a/languages/messages/MessagesEn.php b/languages/messages/MessagesEn.php index 058bf71528..85df932e38 100644 --- a/languages/messages/MessagesEn.php +++ b/languages/messages/MessagesEn.php @@ -4630,14 +4630,18 @@ This site is experiencing technical difficulties.', 'newuserlog-byemail' => 'password sent by e-mail', # Feedback -'feedback-note' => 'Your feedback will be posted publicly to the page "[$2 $1]", along with your user name, browser version and operating system.', +'feedback-note' => 'This form publicly posts a simple comment or suggestion to the page "[$2 $1]", along with your user name, browser version and operating system.', +'feedback-bugnote' => 'Or, you can [$1 post a technical bug report] instead.', 'feedback-subject' => 'Subject:', 'feedback-message' => 'Message:', -'feedback-cancel' => 'Cancel', -'feedback-submit' => 'Submit Feedback', -'feedback-adding' => 'Adding feedback to page...', -'feedback-error1' => 'Error: Unrecognized result from API', -'feedback-error2' => 'Error: Edit failed', -'feedback-error3' => 'Error: No response from API', - +'feedback-cancel' => 'Cancel', +'feedback-submit' => 'Submit Feedback', +'feedback-adding' => 'Adding feedback to page...', +'feedback-error1' => 'Error: Unrecognized result from API', +'feedback-error2' => 'Error: Edit failed', +'feedback-error3' => 'Error: No response from API', +'feedback-thanks' => 'Thanks! Your feedback has been posted to the page "[$2 $1]".', +'feedback-close' => 'Done', +'feedback-bugcheck' => 'Great! Just check that it is not already one of the [$1 known bugs].', +'feedback-bugnew' => 'I checked. Report a new bug', ); diff --git a/maintenance/language/messages.inc b/maintenance/language/messages.inc index ef96c38563..c1a26c64d0 100644 --- a/maintenance/language/messages.inc +++ b/maintenance/language/messages.inc @@ -3500,14 +3500,19 @@ $wgMessageStructure = array( ), 'feedback' => array( 'feedback-note', + 'feedback-bugnote', 'feedback-subject', - 'feedback-message', - 'feedback-cancel', - 'feedback-submit', - 'feedback-adding', - 'feedback-error1', - 'feedback-error2', - 'feedback-error3', + 'feedback-message', + 'feedback-cancel', + 'feedback-submit', + 'feedback-adding', + 'feedback-error1', + 'feedback-error2', + 'feedback-error3', + 'feedback-thanks', + 'feedback-close', + 'feedback-bugcheck', + 'feedback-bugnew', ), ); diff --git a/resources/Resources.php b/resources/Resources.php index 197df98d07..73a8613fb7 100644 --- a/resources/Resources.php +++ b/resources/Resources.php @@ -539,6 +539,7 @@ return array( ), 'messages' => array( 'feedback-note', + 'feedback-bugnote', 'feedback-subject', 'feedback-message', 'feedback-cancel', @@ -547,6 +548,10 @@ return array( 'feedback-error1', 'feedback-error2', 'feedback-error3', + 'feedback-thanks', + 'feedback-close', + 'feedback-bugcheck', + 'feedback-bugnew', ), ), 'mediawiki.htmlform' => array( diff --git a/resources/mediawiki/mediawiki.feedback.js b/resources/mediawiki/mediawiki.feedback.js index 041cd915e0..258a8917d9 100644 --- a/resources/mediawiki/mediawiki.feedback.js +++ b/resources/mediawiki/mediawiki.feedback.js @@ -19,9 +19,9 @@ * * Not compatible with LiquidThreads. * - * How to use it: + * Minimal example in how to use it: * - * var feedback = new mw.Feedback( api, myFeedbackPageTitle ); + * var feedback = new mw.Feedback(); * $( '#myButton' ).click( function() { feedback.launch(); } ); * * You can also launch the feedback form with a prefilled subject and body. @@ -35,6 +35,8 @@ * api: {mw.Api} if omitted, will just create a standard API * title: {mw.Title} the title of the page where you collect feedback. Defaults to "Feedback". * dialogTitleMessageKey: {String} message key for the title of the dialog box + * bugsLink: {mw.Uri|String} url where bugs can be posted + * bugsListLink: {mw.Uri|String} url where bugs can be listed */ mw.Feedback = function( options ) { @@ -54,9 +56,15 @@ options.dialogTitleMessageKey = 'feedback-submit'; } - this.api = options.api; - this.feedbackTitle = options.title; - this.dialogTitleMessageKey = options.dialogTitleMessageKey; + if ( options.bugsLink === undefined ) { + options.bugsLink = '//bugzilla.wikimedia.org/enter_bug.cgi'; + } + + if ( options.bugsListLink === undefined ) { + options.bugsListLink = '//bugzilla.wikimedia.org/query.cgi'; + } + + $.extend( this, options ); this.setup(); }; @@ -64,19 +72,25 @@ setup: function() { var _this = this; - // Set up buttons for dialog box. We have to do it the hard way since the json keys are localized - _this.buttons = {}; - _this.buttons[ mw.msg( 'feedback-cancel' ) ] = function() { _this.cancel(); }; - _this.buttons[ mw.msg( 'feedback-submit' ) ] = function() { _this.submit(); }; - - var $feedbackPageLink = $j( '' ).attr( { 'href': _this.feedbackTitle.getUrl(), 'target': '_blank' } ); + + var $feedbackPageLink = $( '' ) + .attr( { 'href': _this.title.getUrl(), 'target': '_blank' } ) + .css( { 'white-space': 'nowrap' } ); + + var $bugNoteLink = $( '' ).attr( { 'href': '#', } ).click( function() { _this.displayBugs(); } ); + + var $bugsListLink = $( '' ).attr( { 'href': _this.bugsListLink, 'target': '_blank' } ); + this.$dialog = $( '
' ).append( - $( '
' ).append( - $( '
' ).append( - $( '' ).msg( 'feedback-note', - _this.feedbackTitle.getNameText(), - $feedbackPageLink ) + $( '
' ).append( + $( '' ).append( + $( '

' ).msg( + 'feedback-note', + _this.title.getNameText(), + $feedbackPageLink.clone() + ), + $( '

' ).msg( 'feedback-bugnote', $bugNoteLink ) ), $( '
' ).append( mw.msg( 'feedback-subject' ), @@ -89,16 +103,26 @@ $( '' ) ) ), + $( '
' ).append( + $( '

' ).msg( 'feedback-bugcheck', $bugsListLink ) + ), $( '

' ).append( mw.msg( 'feedback-adding' ), $( '
' ), $( '' ) ), + $( '
' ).msg( + 'feedback-thanks', _this.title.getNameText(), $feedbackPageLink.clone() + ), $( '
' ).append( $( '
' ) - ) - ).dialog({ + ); + + // undo some damage from dialog css + this.$dialog.find( 'a' ).css( { 'color': '#0645ad' } ); + + this.$dialog.dialog({ width: 500, autoOpen: false, title: mw.msg( this.dialogTitleMessageKey ), @@ -108,7 +132,7 @@ this.subjectInput = this.$dialog.find( 'input.feedback-subject' ).get(0); this.messageInput = this.$dialog.find( 'textarea.feedback-message' ).get(0); - this.displayForm(); + }, display: function( s ) { @@ -121,6 +145,23 @@ this.display( 'submitting' ); }, + displayBugs: function() { + var _this = this; + this.display( 'bugs' ); + var bugsButtons = {}; + bugsButtons[ mw.msg( 'feedback-bugnew' ) ] = function() { window.open( _this.bugsLink, '_blank' ); }; + bugsButtons[ mw.msg( 'feedback-cancel' ) ] = function() { _this.cancel(); }; + this.$dialog.dialog( { buttons: bugsButtons } ); + }, + + displayThanks: function() { + var _this = this; + this.display( 'thanks' ); + var closeButton = {}; + closeButton[ mw.msg( 'feedback-close' ) ] = function() { _this.$dialog.dialog( 'close' ); }; + this.$dialog.dialog( { buttons: closeButton } ); + }, + /** * Display the feedback form * @param {Object} optional prefilled contents for the feedback form. Object with properties: @@ -128,11 +169,17 @@ * message: {String} */ displayForm: function( contents ) { + var _this = this; this.subjectInput.value = (contents && contents.subject) ? contents.subject : ''; this.messageInput.value = (contents && contents.message) ? contents.message : ''; this.display( 'form' ); - this.$dialog.dialog( { buttons: this.buttons } ); // put the buttons back + + // Set up buttons for dialog box. We have to do it the hard way since the json keys are localized + var formButtons = {}; + formButtons[ mw.msg( 'feedback-submit' ) ] = function() { _this.submit(); }; + formButtons[ mw.msg( 'feedback-cancel' ) ] = function() { _this.cancel(); }; + this.$dialog.dialog( { buttons: formButtons } ); // put the buttons back }, displayError: function( message ) { @@ -161,7 +208,7 @@ var ok = function( result ) { if ( result.edit !== undefined ) { if ( result.edit.result === 'Success' ) { - _this.$dialog.dialog( 'close' ); // edit complete, close dialog box + _this.displayThanks(); } else { _this.displayError( 'feedback-error1' ); // unknown API result } @@ -174,7 +221,7 @@ displayError( 'feedback-error3' ); // ajax request failed }; - this.api.newSection( this.feedbackTitle, subject, message, ok, err ); + this.api.newSection( this.title, subject, message, ok, err ); }, // close submit button function -- 2.20.1