[TW5] Experience with PlantUML and TW5

1,007 views
Skip to first unread message

Richard Evans

unread,
Jan 13, 2016, 11:30:51 PM1/13/16
to TiddlyWiki
Hi,

I'm experimenting with PlantUML, there is a plugin for TiddlyWiki (https://github.com/anibalch/tiddlywiki-plantuml). The instructions appear to be for TiddlyWiki Classic. As I have limited experience with TiddlyWiki and no experience with using plugins. I want to establish exactly what to do.

Does anybody have any experience with using PlantUML with TW5?

Alternatively, can anybody advise me how to add the plugin to TW5?

Thanks  Ric Evans

Tobias Beer

unread,
Jan 14, 2016, 1:55:02 PM1/14/16
to TiddlyWiki
Hi Richard,

Almost ready. ;-)
Tomorrow.

Best wishes,

Tobias.

Tobias Beer

unread,
Jan 14, 2016, 2:05:14 PM1/14/16
to tiddl...@googlegroups.com
Well, let's do it this way:
Here's a "sneak preview" 0.5.0 version of tobibeer/plantuml:


Gotta say, I like this stuff, despite the dependency ;-)

Best wishes,

Tobias.

Anibal Caceres Hernando

unread,
Jan 14, 2016, 4:07:07 PM1/14/16
to TiddlyWiki
Hi,
Well done, Tobias, thank you very much!!
This is Aníbal, author of the PlantUml plugin for TiddlyWiki Classic. Richard asked me yesterday about updating the plugin for TW5, and I was going to have a look at it, and see how to build a plugin for TW5, and now what I find is that you've already done the work, which is very nice :).
I'll link your plugin from mine's page, so if people find it, will know a version for TW 5 exists. Also, would be good if you inform PlantUML people about it, so they can link it from their site.
Thanks again!!
Kind regards,

Aníbal Cáceres.

El jueves, 14 de enero de 2016, 20:05:14 (UTC+1), Tobias Beer escribió:
Well, let's do it this way:
Here's a "sneak preview" 0.5.0 Beta version of tobibeer/plantuml:

Alex Hough

unread,
Jan 14, 2016, 4:34:32 PM1/14/16
to TiddlyWiki
Tobias,

Fantastic


Alex

--
You received this message because you are subscribed to the Google Groups "TiddlyWiki" group.
To unsubscribe from this group and stop receiving emails from it, send an email to tiddlywiki+...@googlegroups.com.
To post to this group, send email to tiddl...@googlegroups.com.
Visit this group at https://groups.google.com/group/tiddlywiki.
To view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywiki/c741a062-a925-4453-9f57-545ba3daa47b%40googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

Mat

unread,
Jan 14, 2016, 5:10:21 PM1/14/16
to TiddlyWiki, Jeremy Ruston
No way! I finished a UML2.0 class just a month ago and was thinking that UML would be a perfect thing to implement in TW. With the release of Astrids wonderful Railroad diagrams, I recall @Jeremy explicitly saying that he was very interested exploring TW as a "notational tool" (paraphrase there). I'd agree that is extremely interesting - imagine musical notes for example.

A thought; Couldn't this be made into an edition? (...which, which probably Railroad should be too). This way it can be promoted as more of a standalone tool with a particularly interesting and powerful UI for people who search for UML tools. I believe it is valuable to make TW things that are not really about TW into standalones that work as a potential gateway (an appetizer!) into TW. While the PlantUML community might not be huge (or?) it is on the other hand very much the "kind" of people that would be valuable for the TW project.

@Jeremy - any thoughts on this?

BTW, I was happy to note that discover PlantUML  according to Wikipedia apparently is UML 2.0

@Tobias - forgive me if it is obvious but what does "Render plantuml diagrams online" mean? Can it not be used offline? Is it somehow connected to the PlantUML servers?

@Anibal - also my thanks to your for your previous TW2 work on this!


<:-)

Brian Theado

unread,
Jan 14, 2016, 7:01:15 PM1/14/16
to tiddl...@googlegroups.com
On Thu, Jan 14, 2016 at 5:10 PM, Mat <matia...@gmail.com> wrote:
> @Tobias - forgive me if it is obvious but what does "Render plantuml
> diagrams online" mean? Can it not be used offline? Is it somehow connected
> to the PlantUML servers?

It looks like it does access the plantuml.com server in order to
render the image.

There are several libraries which perform similar functionality
client-side only:

https://bramp.github.io/js-sequence-diagrams/
http://knsv.github.io/mermaid/sequenceDiagram.html
http://www.nomnoml.com/

I didn't look at Tobias' code to see how easy it would be to integrate
any of the above.

Also of related interest: http://mdaines.github.io/viz.js/ - this one
is not UML, but rather a javascript implementation of
http://graphviz.org. More of a way to create graphs like tiddlymap and
tidgraph, only with a text based syntax rather than with tiddler
relationships.

Brian

Tobias Beer

unread,
Jan 15, 2016, 12:59:09 AM1/15/16
to TiddlyWiki
Hi Anibal,
 
Well done, Tobias, thank you very much!!

Thank you. At first the plantuml plantuml looked somewhat plain. But, exploring a bit, it appears to cater for quite a lot of modeling and all that with a nice, readable syntax. I like that a lot.
 
This is Aníbal, author of the PlantUml plugin for TiddlyWiki Classic.

Cool stuff! I'm a bit amazed that I have not come across your plugin yet.
Now that TiddlySpace is closing up shop,
...and will add a reference to your PlantUML plugin in the process.
 
Richard asked me yesterday about updating the plugin for TW5, and I was going to have a look at it, and see how to build a plugin for TW5, and now what I find is that you've already done the work, which is very nice :).

I'll do a little more polishing. If you have anything else in mind, since you've done a similar thing and perhaps stumbled over similar blocks / wishes, feedback is sure welcome.
 
I'll link your plugin from mine's page, so if people find it, will know a version for TW 5 exists.

Great!
 
Also, would be good if you inform PlantUML people about it, so they can link it from their site.

Will do. Is it ok for you if I asked them to put the links to both plugins like this:



Best wishes,

Tobias Beer.

Tobias Beer

unread,
Jan 15, 2016, 2:16:43 AM1/15/16
to TiddlyWiki, jeremy...@gmail.com
Hi Mat,

I'd agree that is extremely interesting - imagine musical notes for example.

I think someone (Mans?) once did some integrating with Bopland.
Turns out this was TWC, the integration having been a whole lot simpler.
But it pretty much operates in the same mode,
it passes notation to a server (whereas the bopland script does the heavy lifting)
and then embeds whatever is returned.
 
A thought; Couldn't this be made into an edition?

Not sure if a dependency to a third party online-provider qualifies for this.
 
(...which, which probably Railroad should be too).

That definitely. I was looking for it and didn't find anything.
For one, I'd think railroad should outsource the docs (more)
and have a proper installation source.
 
This way it can be promoted as more of a standalone tool with a particularly interesting and powerful UI for people who search for UML tools.

Definitely, perhaps for now an entry in the Community section makes most sense.
 
I believe it is valuable to make TW things that are not really about TW into standalones that work as a potential gateway (an appetizer!) into TW.

Very much agree.
 
While the PlantUML community might not be huge (or?) it is on the other hand very much the "kind" of people that would be valuable for the TW project.

Actually, I think it's tools like these that integrate with TiddlyWiki really well and can bring about a quite fruitful symbiosis on both ends.

@Tobias - forgive me if it is obvious but what does "Render plantuml diagrams online" mean? Can it not be used offline? Is it somehow connected to the PlantUML servers?

So, yes, it means that for it to render any images it entirely depends on the availability of that server. I'll, however, make it so that it will at least support different servers.

Best wishes, Tobias.

Tobias Beer

unread,
Jan 15, 2016, 2:25:25 AM1/15/16
to TiddlyWiki
Hi Brian,
 
It looks like it does access the plantuml.com server in order to
render the image.

Indeed,
 
I didn't look at Tobias' code to see how easy it would be to integrate
any of the above.

While there are possibly some similarities,
I think the process will be different for other libraries.
Having a server do the rendering makes things simpler.
For plantuml, I am actually using the image widget under the hood,
or an iframe for textual renderings.

If a js library created the output,
then that would have to be rendered by equivalent
widgetry and markup into the dom.
The docs are a bit unpolished still,
will improve later today.

More of a way to create graphs like tiddlymap and
tidgraph, only with a text based syntax rather than with tiddler
relationships.

I think the real interesting parts come about when the two can be intermingled,
as is the case with TiddlyMap and TidGraph.

Plantuml does not allow you to click on the image "nodes"
to navigate TiddlyWiki.

Perhaps Jed could create a basic ui based on his SVG editing tool
that would allow creating some sort of invisible svg "overlay",
or where you could "highlight" those nodes in your wiki
and make the overlay clickable so as to navigate around.

Best wishes,

Tobias.

Richard Evans

unread,
Jan 16, 2016, 3:33:34 PM1/16/16
to TiddlyWiki
Thanks Tobias, I shall look forward to trying it out when I have time

Anibal Caceres Hernando

unread,
Jan 17, 2016, 4:19:06 PM1/17/16
to tiddl...@googlegroups.com
Hi Tobias,
Yes, your proposal to send theinfo about both plugins to plantuml people is ok for me.
Thanks!!
Kind regards,

Aníbal.


--
You received this message because you are subscribed to a topic in the Google Groups "TiddlyWiki" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/tiddlywiki/GYL09vPH9T8/unsubscribe.
To unsubscribe from this group and all its topics, send an email to tiddlywiki+...@googlegroups.com.

To post to this group, send email to tiddl...@googlegroups.com.
Visit this group at https://groups.google.com/group/tiddlywiki.

Terry Chen

unread,
Aug 2, 2019, 4:02:18 AM8/2/19
to TiddlyWiki
It's really a fantastic work! Thanks a lot!

BTW, I'm wondering that is it feasible to render the image via local file "plantuml.jar"?

在 2016年1月15日星期五 UTC+8下午3:25:25,Tobias Beer写道:

Octavian Petrescu

unread,
Aug 13, 2022, 5:22:26 PM8/13/22
to TiddlyWiki
This still works in 2022! :) TW FTW :)
Reply all
Reply to author
Forward
0 new messages