DokuWiki

It's better when it's simple

User Tools

Site Tools


Sidebar

Translations of this page?:

Learn about DokuWiki

Advanced Use

Corporate Use

Our Community


Follow us on Facebook, Twitter and other social networks.

devel:jqueryfaq

jQuery FAQ for Plugin Developers

Since the October 2011 release of DokuWiki, codenamed “Angua”, our homegrown set of JavaScript utility functions was replaced with the well known jQuery library. This FAQ tries to cover all questions plugin and template authors might have relating to their use of JavaScript.

We encourage plugin and template authors to look into these issues ASAP, because the compatibility layers currently in use will soon go away.

Why did you switch to jQuery?

jQuery is a well known, widely used and tested library. It is well documented and makes JavaScript development much easier. Supporting jQuery was an often requested feature by 3rd party plugin and template developers. Using jQuery should lower entry barriers for new DokuWiki developers creating new, modern user interfaces.

What jQuery version is supported?

“Angua” will ship with jQuery 1.6.4, future DokuWiki releases will ship with newer jQuery releases. We're going to focus on stability rather than bleeding edge on future library upgrades, so it might not always be the most recent jQuery version. We also include jQuery UI 1.8.16 with “Angua” with all components included.

You can query the available versions with jQuery().jquery and jQuery().ui.version.

Will my old plugins continue to work?

If your plugin or template doesn't use any JavaScript, then it obviously isn't affected by the change at all.

Note: The compatibility wrappers / layer for deprecated JavaScript functions (since Autumn 2011 “Angua” release) have been removed with the Spring 2013 “Weatherwax” release. If your plugin uses deprecated JavaScript, you need to update it (see below).

How do I know if I need to adjust my plugin?

Freshly installed “Angua” and “Adora Belle” releases trigger warning messages about deprecated JavaScript calls (by compatibility layer) that you can inspect in the Firebug error console or the Chrome inspector. Most of the warnings will give you a hint how to replace the deprecated code with jQuery functions:

Deprecation Warnings in Chrome

(“Weatherwax” and “Binky” do not support the compatibility layer any more, but you can reactivate it - no hints here because this might be misunderstood as “how to still use old plugins”; if you want to fix old plugins you should have the knowledge to find your way)

What are the most commonly used JS features that are now deprecated?

Here are the most commonly used, deprecated bits from our old library and some simple examples how to replace them with jQuery features.

$('...')

as a shortcut to document.getElementById('…') - use jQuery's selectors instead, namely jQuery('#…').

  • Note that $() is not (and never was) the jQuery shortcut, jQuery is only available in it's long form of jQuery().
/* Old code */
var obj = $('some__id');
// obj now is a DOM object
 
/* New code */
var $obj = jQuery('#some__id');
// $obj is a jQuery object - if you really need the DOM object use [0] like this:
var obj = $obj[0];

getElementsByClass()

use jQuery's selectors instead

/* Old code */
var htmlelements = getElementsByClass( 'class', document, 'tag');
// htmlelements now is an array of DOM elements
for( var n in htmlelements ) {
  dosomething( htmlelements[n] );
}
 
/* New code */
jQuery('tag.class').each(function(){dosomething(this);});
 
/* Or, this new code */
var jqueryelements = jQuery('tag.class');
// jqueryelements is a jquery thing : an array plus some other stuff.
jqueryelements.each(function(){dosomething(this);});
/* or, if you prefer (I don't know wich one is better) */
for ( var n = 0; n < jqueryelements.length; ++n ) {
	dosomething(jqueryelements[n]);
}

addInitEvent()

registering callbacks to be run when the DOM is ready to be used - use jQuery's callback mechanism instead.

/* Old code */
addInitEvent(function(){
    alert("DOM is ready");
});
 
/* New code */
jQuery(function(){
    alert("DOM is ready");
});

addEvent()

registering event handlers - use jQuery's event methods instead.

/* Old code */
addEvent(obj,EVENT,function(){ alert("EVENT happened!") });
 
/* New code */
jQuery(obj).EVENT(function(){ alert("EVENT happened!") });
  • ⇒ replace EVENT by “click”, “change”, “blur”, “focus” and the like (s. jQuery link above!)

tw_sack

executing AJAX requests - use jQuery's AJAX methods instead.

/* Old code */
sack = new sack(DOKU_BASE + 'lib/exe/ajax.php');                                                        
sack.AjaxFailedAlert = '';                                                                              
sack.encodeURIString = false;
sack.runAJAX('call=linkwiz&q='+encodeURI(value));
 
/* New code */
jQuery.post(
    DOKU_BASE + 'lib/exe/ajax.php',
    { call: 'linkwiz', q: value }
);

What Codingstyle rules should I follow?

Please see javascript which has been updated with some jQuery specific rules.

Should I maintain two versions of my plugin?

If you really want to support old (pre-“Angua”) DokuWiki versions, you should have two versions of your plugin. The easiest way is to simply save your current plugin version (or tag it in your code revision system) and then upgrade your plugin to jQuery. Then add a link to the old, outdated version to your plugin's page.

Please refrain from supporting jQuery and non-jQuery in the same plugin version, as this increases code size and decreases maintainability. This means you should not add any own compatibility wrappers to your plugin. We already have compatibility wrappers in place for a whole year. Users should be encouraged to upgrade their old DokuWiki versions instead of making it easy for them to be lazy ;-).

Should I always use jQuery for DOM Manipulation?

You do not necessarily rewrite all your DOM-Manipulation to make use of jQuery. But when replacing deprecated functions you might encounter places where jQuery makes DOM manipulation much easier using less code than with native DOM functions, in such cases consider rewriting your code with jQuery.

Can I use jQuery plugins?

Please avoid the use of any unnecessary jQuery plugin. We already provide the full jQuery UI library which should cover most of your needs already. We might add commonly used/requested plugins to the core later - please write to the mailinglist if you think something should be added.

If you really want to use a plugin, it should be given a common, canonical name and loaded with our include_once syntax for JavaScript. The filename should be prefixed with jquery. and not contain any version numbers. This way multiple plugins can share the same jQuery plugin. Please do not use minified versions of the jQuery plugin - we're using our own minifier that can be easily disabled for debugging purposes.

For example, if you want to use the qTip jQuery plugin, choose “Development - Uncompressed source code” from the download page. The resulting filename (eg. jquery.qtip-1.0.0-rc3.js)) then has to be renamed to jquery.qtip.js and placed in your plugin folder. Then load it from your plugin's main script like this:

/* DOKUWIKI:include_once jquery.qtip.js */

Can I style JQuery UI in my template?

Yes, of course. Simply override our default jQuery UI CSS in your own template CSS files. The default theme used by DokuWiki can be found in lib/scripts/jquery/jquery-ui-theme/smoothness.css. Do not edit this file! Override styles in your own template instead.

  • override styles in CSS of your template
devel/jqueryfaq.txt · Last modified: 2016-01-09 08:01 by torpedo