jQuery API documentation in TiddlyWiki

94 views
Skip to first unread message

FND

unread,
Feb 13, 2010, 11:37:50 AM2/13/10
to TiddlyWikiDev
The jQuery folks are nice enough to provide a raw XML dump of their API
documentation (http://api.jquery.com).
I wrote a quick macro to parse that data and store it as tiddlers:
http://svn.tiddlywiki.org/Trunk/contributors/FND/plugins/jQueryDocsImportMacro.js
Demo:
http://fnd.lewcid.org/tmp/jQueryAPI.html

The data mapping has not been heavily tested, so let me know if you come
across any problems or inconsistencies.

There are plenty of possible improvements - among the more obvious ones,
a navigation menu for the existing categories and a link to the official
documentation with each individual tiddler.


-- F.

Paul Downey

unread,
Feb 13, 2010, 12:05:04 PM2/13/10
to tiddly...@googlegroups.com
On Sat, Feb 13, 2010 at 4:37 PM, FND <FN...@gmx.net> wrote:
> The jQuery folks are nice enough to provide a raw XML dump of their API
> documentation (http://api.jquery.com).
> I wrote a quick macro to parse that data and store it as tiddlers:
> http://svn.tiddlywiki.org/Trunk/contributors/FND/plugins/jQueryDocsImportMacro.js
> Demo:
> http://fnd.lewcid.org/tmp/jQueryAPI.html

Great! I've been meaning to do this myself, but this is great!

> The data mapping has not been heavily tested, so let me know if you come
> across any problems or inconsistencies.
>
> There are plenty of possible improvements - among the more obvious ones, a
> navigation menu for the existing categories and a link to the official
> documentation with each individual tiddler.

And getting the demos to work ..

Thanks Fred!
--
Paul (psd)
http://blog.whatfettle.com

FND

unread,
Feb 13, 2010, 12:11:54 PM2/13/10
to tiddly...@googlegroups.com
> And getting the demos to work ..

The macro button will only work off a file:// URI (same-origin policy).
That might be regarded as an advantage though, as the XML file at
http://api.jquery.com/api/ is being generated dynamically for each request*.
Nevertheless, the error message could certainly be improved...


-- F.


* https://forum.jquery.com/topic/raw-api-dump-invalid-xml

Jeremy Ruston

unread,
Feb 13, 2010, 12:15:58 PM2/13/10
to tiddly...@googlegroups.com
Wow, Fred, that's great, genuinely useful already. I often find myself
coding in gaps between connectivity, so thank you.

Cheers

Jeremy

> --
> You received this message because you are subscribed to the Google Groups
> "TiddlyWikiDev" group.
> To post to this group, send email to tiddly...@googlegroups.com.
> To unsubscribe from this group, send email to
> tiddlywikide...@googlegroups.com.
> For more options, visit this group at
> http://groups.google.com/group/tiddlywikidev?hl=en.
>
>

--
Jeremy Ruston
mailto:jer...@osmosoft.com
http://www.tiddlywiki.com

Jeremy Ruston

unread,
Feb 13, 2010, 12:17:41 PM2/13/10
to tiddly...@googlegroups.com
Hmm it seems that the tag drop downs in the tags tab in the right hand
sidebar don't work properly if the page has been scrolled.

Cheers

Jerm

mahemoff

unread,
Feb 13, 2010, 12:29:40 PM2/13/10
to TiddlyWikiDev
This is brilliant Fred! Perfect for offline and I imagine easier when
working online too, as it provides a convenient (and easily hackable)
interface for browsing the docs, without having to do any reloads.

On Feb 13, 5:15 pm, Jeremy Ruston <jeremy.rus...@gmail.com> wrote:
> Wow, Fred, that's great, genuinely useful already. I often find myself
> coding in gaps between connectivity, so thank you.
>
> Cheers
>
> Jeremy
>
>
>
> On Sat, Feb 13, 2010 at 5:11 PM, FND <F...@gmx.net> wrote:
> >> And getting the demos to work ..
>
> > The macro button will only work off a file:// URI (same-origin policy).
> > That might be regarded as an advantage though, as the XML file at

> >http://api.jquery.com/api/is being generated dynamically for each request*.


> > Nevertheless, the error message could certainly be improved...
>

Squirting content into an iFrame would be the answer, perhaps.
For reference, my AppFrame plugin (http://trac.tiddlywiki.org/browser/
Trunk/contributors/MichaelMahemoff/plugins/AppFramePlugin/
AppFramePlugin.js) lets you compose HTML, CSS, and Javascript and
injects it into an iFrame (used in PlayGround -
http://trac.tiddlywiki.org/browser/Trunk/contributors/MichaelMahemoff/verticals/playground,
sorry no online demo yet).

FND

unread,
Feb 13, 2010, 2:31:13 PM2/13/10
to tiddly...@googlegroups.com
> Hmm it seems that the tag drop downs in the tags tab in the right hand
> sidebar don't work properly if the page has been scrolled.

I can't seem to reproduce this - also, it's just vanilla TiddlyWiki
(though cooked from Trunk, i.e. a nightly build).


-- F.

FND

unread,
Feb 14, 2010, 3:17:58 AM2/14/10
to tiddly...@googlegroups.com
> There are plenty of possible improvements - among the more obvious ones,
> a navigation menu for the existing categories and a link to the official
> documentation with each individual tiddler.

The latter has been done now, using the recently created WebLinkerMacro
(who would've thought that'd actually come in handy?).

I've also changed the rendering of arguments to use a table.


-- F.

Jeremy Ruston

unread,
Feb 14, 2010, 5:43:09 AM2/14/10
to tiddly...@googlegroups.com
I think it's another case of Jeremy using Safari for his testing... I
don't see the same thing on other TiddlyWiki sites.

Cheers

Jeremy

FND

unread,
Feb 15, 2010, 6:02:44 AM2/15/10
to tiddly...@googlegroups.com
> I think it's another case of Jeremy using Safari for his testing... I
> don't see the same thing on other TiddlyWiki sites.

Confirmed; it was a core bug in the TiddlyWiki nightly build:
http://trac.tiddlywiki.org/ticket/1151#comment:5


-- F.

FND

unread,
Mar 21, 2010, 3:32:27 PM3/21/10
to tiddly...@googlegroups.com
I've applied the new TagsplorerMacro* to this, which seems very useful
indeed (due to the excellent metadata provided by the jQuery team):
http://fnd.lewcid.org/misc/jQueryAPI.html


-- F.


* http://groups.google.com/group/tiddlywiki/t/2986d7efae85b6ef

Reply all
Reply to author
Forward
0 new messages