create new tag
, view all tags

JQueryPluginDev Discussion: Page for developer collaboration, enhancement requests, patches and improved versions on JQueryPlugin contributed by the TWikiCommunity.
• Please let us know what you think of this extension.
• For support, check the existing questions, or ask a new support question in the Support web!
• Please file bug reports in the JQueryPlugin bug database.

Feedback on JQueryPlugin

-- MichaelDaum 02 Aug 2007

Thanks Micha for contributing this plugin. What is the difference to the existing YahooUserInterfaceContrib? The YUI is the standard for AJAX in TWiki.

Feedback on the plugin topic:

  • Escape the header link (linking to itself is confusing)
    • I like it that way, because i use the h1 header to reload the topic. It is only confusing in PatternSkin due to the extra underline.
    • A big and screaming linked text pointing to the same page is distracting; if you need the page reload funtionality you could add this to the skin or sidebar (such as a reload icon). See Jakob Nielsen's Alertbox: The Ten Most Violated Homepage Design Guidelines. -- PeterThoeny
    • I think twiki.org has more sever usability problems than that. Wikis are shock full of cross-references and anchors, some of which are pointing back to the page itself. It only becomes a problem if there are too many. Self-referencing links are very rare or on non-wikis but appear quite often in wikis. There are only two places where I allways want a backrefernce to the page itself in a wiki: (a) the h1 should be clickable (b) the last element of a breadcrumbs navigation - pointing to the current page - should also be clickable. This is well defined and very regular, and thus enhances usability. If an anchor in h1 is screaming too loud, then fix PatternSkin. -- MichaelDaum
  • Under "Installation Instructions" it would be helpful to have the standard "you do not need to install anything on the browser..." blurb
    • This is a useless blurb. Why should one get the idea that TWiki plugins are browser plugins? Installation instructions typically tell you what you have to do in order to install the software. Telling someone what he is not suppose to do to install the plugin is probably an endless task wink .
    • This is based on feedback I got from end users. Users new to TWiki do not know the architecture, they could confuse this with browser based plugins; plugin topics serve as end user documentation, so the plugin installation instruction may confuse new users. -- PeterThoeny
    • Can't follow: what is the foundation a visitor to twiki.org could expect to find a browser plugin for - let's say - firefox? For regular users this seems very far fetched. -- MichaelDaum
  • The "Contrib Info" should be "Plugin Info"
    • Feel free to fix it in SVN.
    • The twiki.org templates are specific to the type of extension; there is only one template in SVN for all extensions, I do not know why it was done that way. For maintenance it would be better to have just one template source, e.g. if the "create new extension" script uses the twiki.org templates. -- PeterThoeny

-- PeterThoeny - 12 Aug 2007

I can't get this to work. I added the line to twiki.tmpl, even changed %PUBURL% to %PUBURLPATH%, but the examples still wo'nt run. Any ideas what could go wrong?


  • this Plugin won't install from the configure interface (file not recognized as zip or tar)
  • The links at the bottom of the plugin topic still point to non-existing JQueryContrib topics

-- JosMaccabiani - 25 Aug 2007

odd. As I've installed it via configure, and am using it actively. (on a 4.1.2 system, and one where I'm developing NatEditContrib).

I did not edit any twiki.tmpl All I did was install, and then enable it.

mmm, though I don't recal trying the examples since mid July.

a few moments later...

oh. maybe that 'edit twiki.tmpl is old docco - I added jquery to my SKIN setting (as you can see near the end of the NatEditContrib doc.

so i have Set SKIN = jquery,pattern

-- SvenDowideit - 25 Aug 2007

Thanks the for plugin. I can verify that setting the skin works, twiki.tmpl edit does not.

-- VinceBriggeman - 30 Aug 2007

Some comments in red.

-- MichaelDaum - 01 Sep 2007

Shouldn't installation instructions read

<script type="text/javascript" src="%PUBURLPATH%/%TWIKIWEB%/JQueryPlugin/jquery.js"></script>
instead of only PUBURL, SYSTEMWEB and JQueryContrib?

-- MarcoPoli - 27 Oct 2007

What about providing a spinner API with that plug-in? Is that already done? Are you already considering that Michael? Want me to get involved? Something like http://www.command-tab.com/2007/05/07/jquery-spinner-plugin/.

-- StephaneLenclud - 14 Feb 2008

I like it. I am currently working to restructure the internals of the plugin in a way we can add as many of these plugins as we want without increasing the js load on every page, which is unfortunately the case right now. For now I upgraded to jquery-1.2.3 respective all plugins. Next is to componentize it and implement proper TWikiWidgets for each plugin to ease their use under TWiki.

-- MichaelDaum - 15 Feb 2008

I've checked-in changes for Bugs:Item5392. When are you planning to publish the next release Michael?

-- StephaneLenclud - 25 Feb 2008

I did not add any examples yet as I'm not sure how that would work especially concerning the UI themes. Maybe we need to add a default UI theme to your Makefile. I believe theme CSS must be in the head but I would need to double check that.

Do we have a script somewhere to install a plug-in from SVN. Something that would do SVN export and read the MANIFEST to put files in the specified installation directory?

-- StephaneLenclud - 25 Feb 2008

I am delaying the release of the JQueryPlugin, because there are a couple of other packages that depend on the current one: NatEditContrib, NatSkin and JQueryTwistyPlugin. All of these - including JQueryPlugin - must be released in one go. I am still checking some of the css in NatSkin before doing this step. There are a lot of changes, i.e. to NatEditContrib.

The command to install a plugin in a SVN checkout is ./pseudo-install.pl -link XXXPlugin.

-- MichaelDaum - 26 Feb 2008

Sounds good! Looking forward to take a look at the latest NatSkin wink

-- StephaneLenclud - 26 Feb 2008

I just submitted changes. Adding =, = and /p/pub/TWiki06x00/JQueryPlugin/images in an attempt to make thing easier for jQuery developer. Those changes are totally untested. Hope it works though. Hope you like it too.
As I gathered from our IRC it turns out that link element in body are not valid though. See http://www.w3.org/TR/html401/struct/links.html#edef-LINK.

-- StephaneLenclud - 28 Feb 2008

Stephane, can we please first discuss this before you add these new features? For one, why do you want a JQTHEME tag instead of a preference variable? Please, elaborate what the other tags should do and how you'd like to implement and use them. Note, that once we've added new tags to a plugin, it is hard to get rid of them again. So careful.

-- MichaelDaum - 29 Feb 2008

See JQueryDevPlugin#Syntax_Rules for documentation. The same documentation was also added on JQueryPlugin in SVN.

  • JQSCRIPT expands in a script element
  • JQTHEME expands in a link element
  • JQIMAGESURLPATH typically expands in /pub/TWiki/JQueryPlugin/Images. Useful when using the spinner for instance.

The idea with the theme is that it should be possible to use different jQuery theme from topic to topic; very much in the same way you can use a specific SKIN and NatSkin style for each topic. I also wanted to avoid using plug-in settings on pages as it is now recommended to use LocalSite.cfg settings instead. However the fact that link in body is no valid HTML is a concern. Maybe there is another element we could use to include a CSS from page body.

If you look at the last JQueryDevPlugin I'm not using the commonTagHandler anymore but delegate that for the jQuery developer to include the theme and scripts needed. This was done to avoid blindly adding all js to every topic as you rightly mentioned before. In fact unless you are using an "AJAX skin" there no need to even include jquery.js on each topic.

JQueryPlugin has not been re-published yet so it's not a problem to remove those tags before the next release. Just feel free to revert some of those changes or ask me to remove them. Each of those tags account for 4 lines of code in JQueryPlugin.pm.

-- StephaneLenclud - 29 Feb 2008

Michael, the version 0.5 published in 28 Apr 2008 does not install the topics with examples: JQueryPluginExamples, PluginTestJQueryPlugin. Examples would be very useful.

-- CarlinhosCecconi - 30 Apr 2008

Ah, and I've forgotten to include jquery UI as well. Try 0.6 now.

-- MichaelDaum - 30 Apr 2008

I upgraded to the latest version of this pluging and started having problems with some of my own js that uses jquery functions. Frustratingly FF wasn't having the problem so no firebug to rely on, IE6 was Done with errors on the page but still giving a useable result, and IE7 was totally bailing-out. The problem seemed to be with wrapInner when there is only a text-node to be wrapped (no problem with wrapping an img). Anyway, juggling with the jquery-all.js file, I've found that completely removing the metadata code solves the problem, even the uncompressed code causes the problem.

-- DavidPatterson - 05 Sep 2008

Sorry, I should make it clear that this is nothing to do with the plugin but seems to be an issue in the jquery camp. My code works fine when there's no metadata function but suffers different degrees of failure in IE6 and 7 when there is. Just wanted to warn if someone else had similar problems.

-- DavidPatterson - 05 Sep 2008

And, if I'd shown a bit more patience I could have posted the problem and fix all in one go... So, if you're using wrapInner() and the jquery metadata plugin is also present (as is the case with this JQueryPlugin 'cause the tabpanes plugin depends on it), you need to make sure you are not just wrapping a text node because IE doesn't like it. A simple solution is to start by not having a text-node that you want to wrap: put your text in a span tag.

-- DavidPatterson - 05 Sep 2008

I found a little bug in the implementation of the tabs by twiki. When you do nested tabs, if the javascript blocks like so:

jQuery(function($) { $("#jqTabPane10").tabpane({select:1}); });

There are multiple of these (with different numbers - ...Pane11, etc.). If they are not in the right order, then you get broken nested tabs. On Sandbox.JQueryTabTest2, in the top set of tabs, select Tab 2, then Tab 2.2, and you'll see that things break. On the bottom set of tabs, which are hard-coded, the javascript blocks are in-order. Put block "12" before block "10" - breaks. Not sure how this is handled in the code, so I'm not sure how easy the fix is. Thanks.

-- AaronLWalker - 2011-05-30

Seems like an issue. Please file at bug at TWikibug:JQueryPlugin.

-- PeterThoeny - 2011-05-30

Hello , How do i load the jquery.superfish.css style inside the topic, using the plugin format? Ex. %JQSCRIPT{"jquery-ui.js"}% or a %JQTHEME{"..."}% - content. Or this is possible only by calling the css file address in the root of the plugin ? Thank you.

-- AlinGramescu - 2011-10-03

Edit | Attach | Watch | Print version | History: r23 < r22 < r21 < r20 < r19 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r23 - 2011-10-03 - AlinGramescu
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2018 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.