To Spellcheck or not to spellcheck

[Captain Packers]

I'm creating some distributable documentation in TiddlyWiki and faced with a dilemma.

The dilemma is the seemingly mutually exclusive but highly desirable features of the need for spell checking, ease of use with regard to saving, and generating an easily distributed self-contained wiki in a single html file.

I like TiddlyDesktop because it creates a self-contained wiki in an easy to distribute, single html file. But I don't want to distribute a product with a lot of spelling errors.

I also like node.js tiddlywiki because it uses the built in spell checking of the browser, but I don't think conversion to a single file html file is simple or straightforward.

Sure wish the simplicity of these two could somehow be combined.

I'm wondering what folks are doing as a work around the this dilemma.

Appreciate any feedback

[Mark S.]

There are multiple single-file save solutions. TiddlyServer is a lot like node, but serves both single files and data files. As a plus, when using data files, you can click on save and download a single file version. It has a lot of other features that, to my way of thinking, make it one of the top ways to save on TW.

-- Mark

[Jed Carty]

Bob lets you create wikis using node with easy saving and you can export single file wikis from it.

https://github.com/OokTech/TW5-BobEXE

[TonyM]

I understand you can access tiddlydesktop hosting wikis at a local url but do not know how to do it.

Bit even without that you can create and edit in tiddlydesktop or tiddlyserver but not at the same time, and spell check from the browser.

As Jed says you can save from folder to file using export from bob but I have not seen how written anywhere.

Regards
Tony

[TonyM]

Captian,

I would also point out its quite easy to bundle tiddlers and transfer them between wikis. Arguably you could design a workflow across wikis by simply using the same standards in each. You could make one wiki have all your editing, publishing and spell check tools then transfer the final content to a wiki shell created from a whole of wiki template containing the tools for reading, printing and searching, perhaps comnents or read only.

There is no limit with the tiddlywiki platform.

Regards
Tony

[Captain Packers]

That's what I decided to do in the end. I'm going to create my document using node TW, where I have the benefit of using the browsers built-in spellchecker, then export all the tiddlers and import them into a new blank TiddlyWiki in Tiddly Desktop, thus generating my spell-checked, distributable, single html file version.

Thanks for all the feedback.

[Mohammad]

Captain,

 Take a look also at

http://codemirror-spellcheck.tiddlyspot.com/

Specll check works in Tiddlydesktop and codemirror! The only concern is the size of dictionary is used for spell checking!

-Mohammad

[h0p3]

We're in somewhat similar shoes. A cryptographically signable single html file is always my product. After two years of just working on the single-file (using browser extensions to save), I'm taking another look at splitting up my development environment from the product itself (while maintaining the ability to effortlessly switch back to my battle-tested single-file editing mode). I require my browser extensions to productively work on my wiki; Grammarly has been a very useful tool in editing my wiki (my grammar is often awful).

The game changer for me is Bob's bi-directional input from .tid and browser. I'm going to be testing (and likely benchmarking) whatever methods there are for compiling the .tid files into a single file (and I'm willing to look at convoluted answers). I'm not sure if there is a simple or performant answer here, but I'm looking for one. I'd like to compile every minute for my toolchain, but I've found compilation (and decompilation) to be computationally expensive (although it's been a while since I've done it). I want to edit in my browser using a Bob server and have the single-file product automatically generated and distributed for me (with a cherry on top).

This is my current insane approach (there has to be a better way!):

https://philosopher.life/#Wiki%3A%20Rube-Goldberg%20Machine:%5B%5BWiki%3A%20Rube-Goldberg%20Machine%5D%5D

I'll let you know how it goes if you're interested, especially if I find a clean way to have your cake and eat it too.

[Jed Carty]

h0p3,

I just realised that I haven't released a lot of what I made after I got frustrated with some things so I haven't released my tools yet. But I have made things for Bob that take a single file wiki and split it up into .tid files and multiple methods for compiling a single file wiki from Bob. But compiling .tids into a single file should be a single button click. The two main methods I have right now are a download button that gives you the current wiki as a single html file without the Bob plugin or any of the server plugins (so like the download empty button on tiddlywiki.com, but it downloads the current wiki) and one that can take tiddlers from any of the wikis served by Bob and complies them into a single html file.

So using Bob to edit and have it give you a single file wiki is possible, I just never got around to publishing it.

I don't know what you use for signing but that doesn't sound like a bad idea for distributing wikis that aren't meant to be edited.

I am dyslexic and can barely read anything on your site so I have no idea what your process is there, so I don't think I can help much with that part.

[TonyM]

H0p3,

As much as we seperate save and export, I understand they are effectively the same thing. During the save process a filter is used To choose the tiddlers which ultimately saves the whole wiki. So you could build a wiki with authorship tools that generates a published wiki without those tools through the use of a custom export filter. Perhaps a username could be one of the filters or export everything except a subset.

I can think of another possible mechanisium I will share soon.

Tony

[h0p3]

@ Jed

Thank you for building this incredible toolset. It's badass. Among the many things it does (and you obviously know more than I do about what it can and will be used for), your tool makes Tiddlywiki a realtime GUI terminal for me, and it makes scripting outside of javascript for my wiki more worthwhile too. I suggest you have defeated some difficult race conditions.

> I just realised that I haven't released a lot of what I made after I got frustrated with some things so I haven't released my tools yet. But I have made things for Bob that take a single file wiki and split it up into .tid files and multiple methods for compiling a single file wiki from Bob. But compiling .tids into a single file should be a single button click. The two main methods I have right now are a download button that gives you the current wiki as a single html file without the Bob plugin or any of the server plugins (so like the download empty button on tiddlywiki.com, but it downloads the current wiki) and one that can take tiddlers from any of the wikis served by Bob and complies them into a single html file.

I will gladly click. I'll likely be running a bare minimum OS and browser with automated clicking inside a virtual machine to do it though. I just saw you had a release today. I'm excited to use it.

> So using Bob to edit and have it give you a single file wiki is possible, I just never got around to publishing it.

I am grateful to be able to see your previously unpublished work. Even the sketch of how you think it should be done is valuable to me.

> I don't know what you use for signing but that doesn't sound like a bad idea for distributing wikis that aren't meant to be edited.

I use PyNaLC (https://github.com/pyca/pynacl). I sign the wiki every minute. Currently, the signature file is separate, but I'm going to be saving the signature inside the wiki instead soon enough (when I get to it). The script will remove the old signature, generate the new signature, and place it in. I use a script to verify (which comes with the wiki too). I can't say I'm good at this part either, but I very much want my wiki to be self-contained.

> I am dyslexic and can barely read anything on your site so I have no idea what your process is there, so I don't think I can help much with that part.

I'm sorry. Perhaps I should offer an easy way to change the font to something more palatable (though, I daresay legibility improvements might not improve its readability). You have already helped with the process I have in mind! I'm re-engineering the backend of my process in virtue of Bob.

@ TonyM

Thank you very much. I actually did some testing in light of what you said and developed a response (it's sitting on my wiki), but now I can see that what I had to say is irrelevant with Jed's new release of Bob today. The export is clean and fast. Yay!

[Captain Packers]

Thanks for pointing this out. I may try this, but I have not yet ventured to try the CodeMirror editor. Is it better than the built-in editor?

[Captain Packers]

Mohammad,

Can you give me a little help with how to set this up and use it in TiddlyDesktop?

Is it a node npm package I need to intall?

I installed the CodeMirror plugin in my TiddlyWiki. Now how do I get it to use the dictionary?

On Tuesday, December 4, 2018 at 11:24:07 PM UTC-5, Mohammad wrote:

[Mohammad]

Hi Capitan,

 This code was developed by BTC, he knows the detail very well.

But in Summary, It uses a dictionary file plus a hacked codemirror.js file.

So, open http://codemirror-spellcheck.tiddlyspot.com/ and import those two tiddlers into your wiki.

It works in Tiddlydesktop!

I hope BTC have a look at this thread and give you details on that.

Best

Mohammad

[Captain Packers]

Thanks for the quick reply Mohammad. I've imported the codemirror and dictionary tiddlers into my tiddlywiki, but it does not highlight misspelled words in my tiddlywiki like it does in his. I wonder what I'm missing yet?

[Julio Peña]

Hello Captain and all:

Captain, hopefully you didn't forget to import this file? $:/plugins/tiddlywiki/highlight

Best regards,

Julio

[Mohammad]

Capitan,

You need to import the below plugins and tiddler to have spellcheck working: (spellcheck plugin, codemirror plugin, hacked engin.js)

1. http://codemirror-spellcheck.tiddlyspot.com/#%24%3A%2Fplugins%2Ftiddlywiki%2Fcodemirror-spellcheck

2. http://codemirror-spellcheck.tiddlyspot.com/#%24%3A%2Fplugins%2Ftiddlywiki%2Fcodemirror

3. http://codemirror-spellcheck.tiddlyspot.com/#%24%3A%2Fplugins%2Ftiddlywiki%2Fcodemirror%2Fengine.js

No need to have the highlight.js as Julio said!

[Captain Packers]

OK. It's working now. Thanks to all for the help.

One caveat for using this with TiddlyDesktop is that I cannot drag and drop plugins to a tiddlywiki running in TiddlyDesktop without TiddlyDesktop crashing. The only way I've been able to make this work in TiddlyDesktop is to download the tiddlywiki html file from codemirror-spellcheck.tiddlyspot.com and use it as a template. So I'm not convinced this is the best solution for building distributable stand alone wiki with spell check support. Will there be long term support for the spell checker? 

I still think the best solution is create a node tidllywiki, taking advantage of the browser's built in spell cheking, then export/import the tiddlers into a blank TiddlyDesktop tiddlywiki.

[Mohammad]

I hope BTC see this thread and answer your question.

He is the developer of spell check plugin.

There is another way to spell check see below post by Jeremy Ruston

https://groups.google.com/forum/#!msg/tiddlywiki/c3y-PycRP4M/V0IyOvR0AAAJ

Best

[Captain Packers]

Does anyone know if it's possible to add to the dictionary?