X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=resources%2Fsrc%2Fjquery%2Fjquery.localize.js;h=05b3891dea7e4f1da9815ce77f2abe5bab8ae525;hb=a2f369cbdf97b9f4d32dce742862e0dd181fe7e8;hp=f5932b246fd446b62c66aba0d53058b7410f7615;hpb=347bb6aef6f169dd050afe6af71f608f996b9d51;p=lhc%2Fweb%2Fwiklou.git
diff --git a/resources/src/jquery/jquery.localize.js b/resources/src/jquery/jquery.localize.js
index f5932b246f..05b3891dea 100644
--- a/resources/src/jquery/jquery.localize.js
+++ b/resources/src/jquery/jquery.localize.js
@@ -3,168 +3,168 @@
*/
( function ( $, mw ) {
-/**
- * Gets a localized message, using parameters from options if present.
- *
- * @ignore
- * @param {Object} options
- * @param {string} key
- * @return {string} Localized message
- */
-function msg( options, key ) {
- var args = options.params[ key ] || [];
- // Format: mw.msg( key [, p1, p2, ...] )
- args.unshift( options.prefix + ( options.keys[ key ] || key ) );
- return mw.msg.apply( mw, args );
-}
+ /**
+ * Gets a localized message, using parameters from options if present.
+ *
+ * @ignore
+ * @param {Object} options
+ * @param {string} key
+ * @return {string} Localized message
+ */
+ function msg( options, key ) {
+ var args = options.params[ key ] || [];
+ // Format: mw.msg( key [, p1, p2, ...] )
+ args.unshift( options.prefix + ( options.keys[ key ] || key ) );
+ return mw.msg.apply( mw, args );
+ }
-/**
- * Localizes a DOM selection by replacing
\
- * \
- * \
- *
- * Awesome
- *
- *
- *
Easy as a, b, c
- * - * Raw HTML content can be used, instead of it being escaped as text. To do this, just use the raw - * attribute on a msg element. - * - * Example: - * // Messages: { 'hello': 'Hello $1!' } - * var html = '\ - *\
- *
- * <b><i>Hello</i> world!</b> - * Hello world! - *
- * - * Message keys can also be remapped, allowing the same generic template to be used with a variety - * of messages. This is important for improving re-usability of templates. - * - * Example: - * // Messages: { 'good-afternoon': 'Good afternoon' } - * var html = 'Good afternoon
- * - * Message keys can also be prefixed globally, which is handy when writing extensions, where by - * convention all messages are prefixed with the extension's name. - * - * Example: - * // Messages: { 'teleportation-warning': 'You may not get there all in one piece.' } - * var html = 'You may not get there all in one piece.
- * - * @param {Object} options Map of options to be used while localizing - * @param {string} options.prefix String to prepend to all message keys - * @param {Object} options.keys Message key aliases, used for remapping keys to a template - * @param {Object} options.params Lists of parameters to use with certain message keys - * @return {jQuery} - * @chainable - */ -$.fn.localize = function ( options ) { - var $target = this, - attributes = [ 'title', 'alt', 'placeholder' ]; + /** + * Localizes a DOM selection by replacing\
+ * \
+ * \
+ *
+ * Awesome
+ *
+ *
+ *
Easy as a, b, c
+ * + * Raw HTML content can be used, instead of it being escaped as text. To do this, just use the raw + * attribute on a msg element. + * + * Example: + * // Messages: { 'hello': 'Hello $1!' } + * var html = '\ + *\
+ *
+ * <b><i>Hello</i> world!</b> + * Hello world! + *
+ * + * Message keys can also be remapped, allowing the same generic template to be used with a variety + * of messages. This is important for improving re-usability of templates. + * + * Example: + * // Messages: { 'good-afternoon': 'Good afternoon' } + * var html = 'Good afternoon
+ * + * Message keys can also be prefixed globally, which is handy when writing extensions, where by + * convention all messages are prefixed with the extension's name. + * + * Example: + * // Messages: { 'teleportation-warning': 'You may not get there all in one piece.' } + * var html = 'You may not get there all in one piece.
+ * + * @param {Object} options Map of options to be used while localizing + * @param {string} options.prefix String to prepend to all message keys + * @param {Object} options.keys Message key aliases, used for remapping keys to a template + * @param {Object} options.params Lists of parameters to use with certain message keys + * @return {jQuery} + * @chainable + */ + $.fn.localize = function ( options ) { + var $target = this, + attributes = [ 'title', 'alt', 'placeholder' ]; - // Extend options - options = $.extend( { - prefix: '', - keys: {}, - params: {} - }, options ); + // Extend options + options = $.extend( { + prefix: '', + keys: {}, + params: {} + }, options ); - // Elements - // Ok, so here's the story on this selector. In IE 6/7, searching for 'msg' turns up the - // 'html:msg', but searching for 'html:msg' doesn't. In later IE and other browsers, searching - // for 'html:msg' turns up the 'html:msg', but searching for 'msg' doesn't. So searching for - // both 'msg' and 'html:msg' seems to get the job done. This feels pretty icky, though. - $target.find( 'msg,html\\:msg' ).each( function () { - var $el = $( this ); - // Escape by default - if ( $el.attr( 'raw' ) ) { - $el.html( msg( options, $el.attr( 'key' ) ) ); - } else { - $el.text( msg( options, $el.attr( 'key' ) ) ); - } - // Remove wrapper - $el.replaceWith( $el.html() ); - } ); - - // Attributes - // Note: there's no way to prevent escaping of values being injected into attributes, this is - // on purpose, not a design flaw. - $.each( attributes, function ( i, attr ) { - var msgAttr = attr + '-msg'; - $target.find( '[' + msgAttr + ']' ).each( function () { + // Elements + // Ok, so here's the story on this selector. In IE 6/7, searching for 'msg' turns up the + // 'html:msg', but searching for 'html:msg' doesn't. In later IE and other browsers, searching + // for 'html:msg' turns up the 'html:msg', but searching for 'msg' doesn't. So searching for + // both 'msg' and 'html:msg' seems to get the job done. This feels pretty icky, though. + $target.find( 'msg,html\\:msg' ).each( function () { var $el = $( this ); - $el.attr( attr, msg( options, $el.attr( msgAttr ) ) ).removeAttr( msgAttr ); + // Escape by default + if ( $el.attr( 'raw' ) ) { + $el.html( msg( options, $el.attr( 'key' ) ) ); + } else { + $el.text( msg( options, $el.attr( 'key' ) ) ); + } + // Remove wrapper + $el.replaceWith( $el.html() ); } ); - } ); - // HTML, Text for elements which cannot have children e.g. OPTION - $target.find( '[data-msg-text]' ).each( function () { - var $el = $( this ); - $el.text( msg( options, $el.attr( 'data-msg-text' ) ) ); - } ); + // Attributes + // Note: there's no way to prevent escaping of values being injected into attributes, this is + // on purpose, not a design flaw. + $.each( attributes, function ( i, attr ) { + var msgAttr = attr + '-msg'; + $target.find( '[' + msgAttr + ']' ).each( function () { + var $el = $( this ); + $el.attr( attr, msg( options, $el.attr( msgAttr ) ) ).removeAttr( msgAttr ); + } ); + } ); - $target.find( '[data-msg-html]' ).each( function () { - var $el = $( this ); - $el.html( msg( options, $el.attr( 'data-msg-html' ) ) ); - } ); + // HTML, Text for elements which cannot have children e.g. OPTION + $target.find( '[data-msg-text]' ).each( function () { + var $el = $( this ); + $el.text( msg( options, $el.attr( 'data-msg-text' ) ) ); + } ); + + $target.find( '[data-msg-html]' ).each( function () { + var $el = $( this ); + $el.html( msg( options, $el.attr( 'data-msg-html' ) ) ); + } ); - return $target; -}; + return $target; + }; -// Let IE know about the msg tag before it's used... -document.createElement( 'msg' ); + // Let IE know about the msg tag before it's used... + document.createElement( 'msg' ); -/** - * @class jQuery - * @mixins jQuery.plugin.localize - */ + /** + * @class jQuery + * @mixins jQuery.plugin.localize + */ }( jQuery, mediaWiki ) );