Plugins in Official Tiddlywiki.com

[kookma]

The official https://tiddlywiki.com/ has few plugins as below! This is very important to ship it with minimum required plugins, but my question is: why Evernote is included? and why not highlight.js is include? Is there any reason?

By the way I appreciate this cleanup! Thank you Jeremy!

[nilslindemann]

Probably they didn't include the highlight.js plugin, because there are not many non-WikiText code examples in the docs and the current highlight.js library is sized 111 kb. If i am not wrong, there is currently no highlighter for WikiText, which would be the main use case.

BTW, I fixed some crude display errors in my local TiddlyWiki by

• updating highlight.pack.js with the current version.
• replacing this line with hljs.highlightElement(domNode); and
• this line with domNode.children[0].innerHTML = hljs.highlight(text, {language: language}).value;.

But I didn't test it on the current Wiki, with its p-soup :-p

[nilslindemann]

Regarding the Evernote plugin, I guess this is to let Evernote users test directly in the browser how it looks when they import their Evernote data into TiddlyWiki.

[kookma]

BTW, I fixed some crude display errors in my local TiddlyWiki by

• updating highlight.pack.js with the current version.
• replacing this line with hljs.highlightElement(domNode); and
• this line with domNode.children[0].innerHTML = hljs.highlight(text, {language: language}).value;.

Great work! I am not very familiar with JS and do not understand your modification, but I appreciate you efforts!

Please have a look at #4502

I am sure @Jermolene welcome to update highlight.js! For me it is important as I use Fortran syntax highlights and the current TW version of Hghlight.js has bug!

Please also have a look at #5961
I am not sure how much v11 changed from v9 as @pmario stated in #5961

[pmario]

I am not sure how much v11 changed from v9 as @pmario stated in #5961

I thought, there has been a PR somewhere. ... But I'm not sure atm

[nilslindemann]

I just tested with a download containing all languages. The file size of highlight.pack.js is then 1MB.

Aside of that, the highlighting works with my two changes in the highlightblock.js, mentioned above (these changes adapt to the breaking changes in the highlight.js project). Tested on tiddlywiki.com.

[pmario]

... Aside of that, the highlighting works with my two changes in the highlightblock.js,

I don't know if highlight.js has code sanitation. I would like to avoid .innerHTML() if possible.

[nilslindemann]

@pmario I am not an expert in this.

I know that

• TiddlyWiki strips away script tags from WikiText
• it escapes < from start and end tags
• Setting someElement.innerHTML to "<" + "script>alert('evil')</" + "script>"; does not execute that script.

While checking this, I found out that highlight.js warns about unescaped HTML in the console, when calling hljs.highlightElement() on elements which have child elements.

I got rid of this warning by doing

domNode.textContent = domNode.textContent;
hljs.highlightElement(domNode);

I do not know if this really solves the problem. I have asked here. I do not know why highlight.js doesn't do this internally.

Edit: that is actually not necessary, as highlight.js does this already. Instead – because TiddlyWiki properly escapes – we can replace this line with hljs.configure({tabReplace: " ", ignoreUnescapedHTML: true});, getting rid of the warning.

See here.

[nilslindemann]

This SO Answer is also interesting. Instead of passing a string directly, it first parses that string with a DOMParser and then returns the textContent from that parsed document. Why this prevents XSS, I do not know. I guess a DOM textNode gets interpreted differently by innerHTML than a vanialla string.

[pmario]

There is a list of languages in the plugin readme, with those we usually include

[Jermolene]

Thanks @kookma

why Evernote is included? and why not highlight.js is include? Is there any reason?

I think it goes back to the very early days when we didn't have a plugin library, and so I would have to make sure that there was an edition containing each plugin so that users could drag and drop them. At that point, when I'd added a new plugin I'd generally leave it on tiddlywiki.com for a while for people to be able to test it.

It's probably time to standardise the plugins in /index.html and /prerelease.html (the latter is preloaded with many plugins).

[kookma]

Many thanks for clarification @Jermolene. Yes, it is time to standardise the plugins!
I would also much appreciate to have a look at #6167 which is somehow related to distribution of official plugins and the way they appear in Sidebar and Control panel.