MasterIncludesPlugin: beta testing

5 views
Skip to first unread message

FND

unread,
Jan 10, 2008, 7:34:46 AM1/10/08
to TiddlyWikiDev
Continuing the discussion spawned on [tw][1], this thread is intended to
follow up on issues regarding the current beta version of
MasterIncludesPlugin[2].

As reported by Wolfgang, there are currently two main issues:

#1 Backstage

After adding a custom element (e.g. the search macro) to the backstage
(as described at [3]), the backstage bar won't properly close again.

> I tried [...] with the latest and original TiddlyTools TW

Not sure what you mean by "original TiddlyTools TW" - a document with
the entire collection of Eric's plugins? Or just the BackstageTweaks?
Since I could not reproduce this problem with a vanilla TW, there must
be some sort of interaction between MIP and the remaining plugins; I'll
need more details to analyze this.

#2 Remote Files

Including a remote master document does not work reliably, neither with
relative nor with absolute paths:

> |''MasterLocation''|master.html|
> |''MasterLocation''|http://vipa.awardspace.com/master.html|

A very similar configuration worked fine in my preliminary test runs
(using a local XAMPP server), so I will have to do more testing.

> This way MasterIncludesConfig itself seems to be loaded, at least into
> the backstage - but doesn't include anything nor presents any reports.

The missing reports are a known issue; for some reason they do appear
after using the EnableEdit bookmarklet.
So it seems to have something to do with readOnly, but I have yet to
look into that.


-- F.


[1] http://groups.google.com/group/TiddlyWiki/t/6533548448e19d91
[2] http://fnd.lewcid.org/svn/TiddlyWiki/plugins/MasterIncludesPlugin/
[3] http://www.tiddlywiki.org/wiki/Backstage#Customization

wolfgang

unread,
Jan 10, 2008, 12:24:50 PM1/10/08
to TiddlyWikiDev
Hi F,

> > > I tried [...] with the latest and original TiddlyTools TW
> >
> > Not sure what you mean by "original TiddlyTools TW" - a document with
> > the entire collection of Eric's plugins? Or just the BackstageTweaks?
> > Since I could not reproduce this problem with a vanilla TW, there must
> > be some sort of interaction between MIP and the remaining plugins; I'll
> > need more details to analyze this.

wolfgang wrote:
http://groups.google.com/group/TiddlyWiki/browse_thread/thread/6533548448e19d91

> Indeed, I use an adapted version of BackstageTweaks by Eric. So the
> first thing I tried was with the latest and original TiddlyTools TW.
> And as soon as one opened any dropdown of the backstage, with MIP
> installed, and for simplicity just placed into the whole of your
> downloaded MIP folder, it blocks it from completely closing.
>
> Double checked it with your slave again, nothing altered, just opened
> any of the original dropdown in the backstage - and again it too
> doesn't close again. I mean the black backstagebar, not the dropdowns
> there.
>
> So it's not any other plugins, but MIP causing this.

Sorry for my maybe confusing way of expression. What I meant is this:

1.) Since I suspected the difficulty closing the backstage after
adding MIP to a costumized TW to be related to an incomparability with
my adapted version of BackstageTweaks (suspecting the cause for the
error in 'my' adaptation - and not in BackstageTweaks itself) - I used
a complete and freshly downloaded TiddlyTools, with nothing added or
deleted (ie. 'original'), other than MIP installed.

I did this test not by creating anything new, but by placing
TiddlyTools.html into a folder with your freshly downloaded
master.html, slave.html and MasterIncludesPlugin.js.

2.) Next I tested this with your slave.html - and there the same error
occurred too!

Contrary to what you experience. Again, nothing added, changed or
deleted, just for the first time used after downloading it from
http://fnd.lewcid.org/svn/TiddlyWiki/plugins/MasterIncludesPlugin/

Meanwhile I tried it numerous times again, and as many times this
error occurred:

- I open the backstage - at this stage everything is fine and I can
close the backstage again.
- Then I open, just as an example, the 'plugins' dropdown, close it
again - and from then onward clicking 'close' doesn't close the black
backstage bar again!

So there is something not understandable happening here? - Because for
me this error is replicated with your otherwise empty TW's on my
harddrive, and online too, again and again.

> The missing reports are a known issue; for some reason they do appear
> after using the EnableEdit bookmarklet.
> So it seems to have something to do with readOnly, but I have yet to
> look into that.

I use EnableEdit bookmarklet just as well, and there are report
tiddlers under the missing tab, but by opening, for example
ReportErrors, as any other of the 'missing' report tiddlers, it reads:

"The tiddler 'ReportErrors' doesn't yet exist. Double-click to create
it"

Please try it at the following location - if for you the black
backstage bar closes there ""AFTER"" opening one of the backstage
dropdowns and closing it again:

http://vipa.awardspace.com/tinytiddly.html

Regards,

W.


FND schrieb:

wolfgang

unread,
Jan 12, 2008, 5:48:45 AM1/12/08
to TiddlyWikiDev
Hi everyone,

> Please try it at the following location - if for you the black
> backstage bar closes there ""AFTER"" opening one of the backstage
> dropdowns and closing it again:
>
> http://vipa.awardspace.com/tinytiddly.html

Tried it?

> > > Also, my example TW which I used for this trial uses systemConfigs
> > > with special characters. Though they show up when installed in the
> > > master.html - but not after being drawn into the slave there?
> >
> > Sounds like an encoding issue. I'm not an expert on that, but I believe
> > JS always uses UTF-8 - maybe your server serves the files as ISO-8859-1,
> > leading to a mismatch?
> > Can you give me an example of such a special char (e.g. umlauts)?
>
> Actually, I used plain symbols for the closing, fold/unfold and jump
> buttons of each tiddler in the file I send you and can be seen there.
> And its functioning online with the older version: TiddlyMasterPlugin,
> here:
>
> http://vipa.3host.biz/TiddlyDesktop.html
>
> thanks for your efforts,
>
> W.

Actually, in this case it can't be MIP itself having the trouble -
because by importing the same TiddlyWiki configuration (but with the
TiddlyMasterPlugin instead, where the symbols otherwise show) into a
virgin TW, the symbols are dropped too. Therefore I guess this error
is rather related to the standard import function of the backstage.

Regards,

W.

On 10 Jan., 18:24, wolfgang <wolfgangl...@gmail.com> wrote:
> Hi F,
>
> > > > I tried [...] with the latest and original TiddlyTools TW
>
> > > Not sure what you mean by "original TiddlyTools TW" - a document with
> > > the entire collection of Eric's plugins? Or just the BackstageTweaks?
> > > Since I could not reproduce this problem with a vanilla TW, there must
> > > be some sort of interaction between MIP and the remaining plugins; I'll
> > > need more details to analyze this.
> wolfgang wrote:
>
> http://groups.google.com/group/TiddlyWiki/browse_thread/thread/653354...
>
> > Indeed, I use an adapted version of BackstageTweaks by Eric. So the
> > first thing I tried was with the latest and original TiddlyTools TW.
> > And as soon as one opened any dropdown of the backstage, with MIP
> > installed, and for simplicity just placed into the whole of your
> > downloaded MIP folder, it blocks it from completely closing.
>
> > Double checked it with your slave again, nothing altered, just opened
> > any of the original dropdown in the backstage - and again it too
> > doesn't close again. I mean the black backstagebar, not the dropdowns
> > there.
>
> > So it's not any other plugins, but MIP causing this.
>
> Sorry for my maybe confusing way of expression. What I meant is this:
>
> 1.) Since I suspected the difficulty closing the backstage after
> adding MIP to a costumized TW to be related to an incomparability with
> my adapted version of BackstageTweaks (suspecting the cause for the
> error in 'my' adaptation - and not in BackstageTweaks itself) - I used
> a complete and freshly downloaded TiddlyTools, with nothing added or
> deleted (ie. 'original'), other than MIP installed.
>
> I did this test not by creating anything new, but by placing
> TiddlyTools.html into a folder with your freshly downloaded
> master.html, slave.html and MasterIncludesPlugin.js.
>
> 2.) Next I tested this with your slave.html - and there the same error
> occurred too!
>
> Contrary to what you experience. Again, nothing added, changed or
> deleted, just for the first time used after downloading it fromhttp://fnd.lewcid.org/svn/TiddlyWiki/plugins/MasterIncludesPlugin/

FND

unread,
Jan 13, 2008, 3:58:53 AM1/13/08
to Tiddly...@googlegroups.com
>> http://vipa.awardspace.com/tinytiddly.html
>
> Tried it?

Well, yes and no; I can now confirm that, in fact, there is some kinda
bug with the backstage not properly closing - even in an empty TW.

However, I won't have the time/nerve to get coding/bufixing again for a
couple of days (possibly even weeks - though I hope it won't come to that).

> by importing the same TiddlyWiki configuration (but with the
> TiddlyMasterPlugin instead, where the symbols otherwise show) into a
> virgin TW, the symbols are dropped too

Can you start a new thread concisely describing how to replicate this?
Then we could create a ticket for the core.

Thanks!


-- F.

wolfgang

unread,
Jan 13, 2008, 6:31:38 AM1/13/08
to TiddlyWikiDev
Good morning Fred,

I can emphasis. Out of my own experience - even as a non-developer -
how some projects with TW start with full vigor and so promising - but
even after months of continued work one has to accept, and place
priorities.

After all, I'm already ''REALLY'' satisfied with TiddlyMasterPlugin!
Because before I used loadExternalv2.js - in lack of any alternatives
- and that was rough and costed me much nerves really.
TiddlyMasterPlugin version leveled its bugs and made its use really
smooth with additional features, I could only dream of before:

* like loading tiddlers from a master TW wasn't possible before at
all !
* therefore loading a number of plugins as fast as possible (other
than it would from separate files)
* (therefore) no loading according to tags was possible before either
* adding different tags I had to hack the code of loadExternalv2, but
this also is possible really smooth
now
* the worst bug, and my biggest worry with its former use - a complete
blank TW with even the backstage gone, if only one of the loading
files was removed - you knew how to solve right away


Only with MasterIncludesPlugin the difficulties started - and from my
testing - with no advance in any features yet at all.

* the backstage dropdown panel was removed, stumbling into the bug of
TW itself, the talk in this thread is mainly about. In my eyes this
removing wasn't any refinement of features anyway, but complicated
things in everyday use (like being the first ever external link in my
TWs, which wasn't opening in a new tab)
* for avoiding bloat (8 kb) the features of TiddlyMasterPlugin were
spitted into:
** MasterIncludesPlugin.js (10 kb)
** TiddlerFilesModule.js (3 kb)
** MasterIncludesPluginLogMacro.js (1 kb)
- but in actuality (of course I know - this was far from final) this
added 6 kb were really complicating things unnecessarily, and didn't
bring any advance (and I'm still not sure if such a lean plugin's
split-up would make sense anyway).
* guess this added kb were meant for making this work on a single
server - a feature I haven't thought of before, and now I would really
like to see, one day - but isn't working yet anyway.


So, for now and all these reasons, I'll will stick to
TiddlyMasterPlugin (isn't everything in life TMP anyway ;-)

And would find it nice, if you would keep this version without bugs
available for others in your repository too.
TiddlyMasterPlugin would deserve this - 'cos really no others plugins
out there with the same abilities.
(and maybe sticking the MasterIncludes stuff away in an other
'experimental' folder)

Kind regards on a beautiful Sunday morning,

W.

FND

unread,
Jan 13, 2008, 7:36:24 PM1/13/08
to Tiddly...@googlegroups.com
> I can emphasis. Out of my own experience - even as a non-developer -
> how some projects with TW start with full vigor and so promising

I still think it's promising (not to mention desperately needed - by
myself, mind you). And while ironing out the kinks isn't exactly a
glamorous and fun task, I still intend to polish it for a public
release. It's just real life getting in the way, not allowing me to
focus on solving such complex issues right now.

> Only with MasterIncludesPlugin the difficulties started - and from my
> testing - with no advance in any features yet at all.

I see your point - but there wasn't really a big code change between TMP
and MIP - it was just a renaming thing. (That's me speaking from a
commit-to-SVN point of view. You've probably skipped a few revisions in
between your downloads though - so it might have looked like there was a
single big change, instead of the gradual evolution it actually was.)

As an aside, your file-size listing isn't quite fair, because there's a
lot of fluctuation in terms of temporary comments and stuff like that.
(Also, MasterIncludesLogMacro has since been moved back into the MIP core.)

The main reason I put TiddlerFilesModule into an external file, though,
was to discourage regular users from (ab)using it - and I stand by that
decision. If it works for you in productive use, that's great, but it's
not to be a fully-supported part of this plugin.

> * the backstage dropdown panel was removed, stumbling into the bug of
> TW itself

This actually seems to be related to the TW core - so it's a good thing
we (well, you) have discovered it!
However, it's probably not as much a bug as it's incomplete instructions
on the community wiki; the Save button in the backstage works just fine,
so it should be possible. In fact, looking at the backstage's
onClickCommand() function gives me some ideas, but making that button
trigger "backstage.switchTab(null);" alone doesn't seem to cut it.
Before we start a thread here on [twdev] on this, could you try to
figure out the exact steps that are needed to replicate this with an
empty TW document?

> this removing wasn't any refinement of features anyway, but complicated things

I really hated the shadow tiddler in TMP's backstage panel.
However, now that I have the refactored code (and MasterIncludesLogMacro
in particular), it would be relatively easy to create that shadow
tiddler again. I'll have to think about that - don't hesitate to keep
reminding me until I've made a final decision.

> the first ever external link in my TWs, which wasn't opening in a new tab

That's a fair point - consistency is important, so I've added the
respective argument to that button, for the time being.

> So, for now and all these reasons, I'll will stick to
> TiddlyMasterPlugin (isn't everything in life TMP anyway ;-)

Quite understandable - if the old version works for you while the newer
one still has too many issues, that's fine by me.

> And would find it nice, if you would keep this version without bugs
> available for others in your repository too.

All revisions are available in the SVN repository - that's pretty much
the point of revision control - but the web front-end only shows the
latest (head) revision.
TMP - even more so than MIP - is still alpha quality, so I can't
actively encourage using it. For that reason, if someone feels like
using it, I think it's not unreasonable to expect him to do an SVN checkout.

Either way, thanks for your continued enthusiasm.


-- F.

FND

unread,
Mar 14, 2008, 4:08:11 PM3/14/08
to Tiddly...@googlegroups.com
Sorry for the hiatus - I'm not back to full productivity yet (e.g. still
need to figure out the perfect Linux setup), and perfecting this plugin
is currently not a priority.
Nevertheless, here's a quick sitrep:

> #1 Backstage

Turns out this is a more global issue, so it's not directly related to
this particular plugin:
http://tinyurl.com/2b9tj9
(http://groups.google.com/group/TiddlyWikiDev/browse_thread/thread/525a5139d808faa7)

> #2 Remote Files

Still not sure what the problem is here; need to do more testing.

I've committed a quick fix to ensure that loading external files works
on non-Windows systems as well - but that seems unrelated to this problem.

> The missing reports are a known issue; for some reason they do appear
> after using the EnableEdit bookmarklet.
> So it seems to have something to do with readOnly, but I have yet to
> look into that.

Still need to do that...


-- F.

Reply all
Reply to author
Forward
0 new messages