Plugin-packaging/display: Ideas and Suggestions

[dieg...@gmail.com]

Hello all,

I really like the Projectify plugin's inclusion of its excellent and thorough documentation as part of the plugin itself. This means all the documentation is included "in the namespace of the plugin":

$:/plugins/nico/projectify/doc/....etc...

I frequently forget the details of specific plugins, and then have to go back to open them, see if they have a readme, if they do great! If they dont have meaningful one, see if they have a link to a github demo, if they do great! If they dont, have to search google (not google groups since I hate google groups search), etc. etc.

So, to not make this post too long, some suggestions for plugin authors (of course, with the utmost respect and humility knowing full well I'm not a plugin author myself), is to:

• Follow in the great Mohammad's footsteps and always have clearly indicated a "Demo" and "code" link in the README of the plugin.
• Follow in Nico (and many others as well, just the latest one I can remember) steps of including comprehensive documentation packaged right along with the plugin itself!
  

--------------------------------

A side note: For point two above, I recently posted a feature suggested on GitHub about letting plugin authors more easily edit the viewTemplate of their plugins, getting rid of the (potentially) "scary" $:/plugins/... in the title, and instead exposing something like:

Plugins > Projectify > Documentation

even though the tiddler is of course actually titled "$:/plugins/nico/projectity/...". I closed it after some discussion, but I thought I'd mention it here in case anyone would like to share their thoughts about this possibility as well.

Best,

Diego

[Mohammad Rahmani]

On Sat, Mar 6, 2021 at 6:32 PM dieg...@gmail.com <dieg...@gmail.com> wrote:

Hello all,

Hi Diego,

Many thanks for your thoughts and great ideas you always share with the community!

Having some standards for creating plugins including docs, demos,... would be very helpful and this will make installing and using plugins much easier!

There were some ideas by Nico and he was working to create a community plugin library. I am not sure if he is still working on the project or not! If so, plugin authors, contributing to such community libraries could be asked to include some minimum tiddlers, ...

I really like the Projectify plugin's inclusion of its excellent and thorough documentation as part of the plugin itself. This means all the documentation is included "in the namespace of the plugin":

$:/plugins/nico/projectify/doc/....etc...

I frequently forget the details of specific plugins, and then have to go back to open them, see if they have a readme, if they do great! If they dont have meaningful one, see if they have a link to a github demo, if they do great! If they dont, have to search google (not google groups since I hate google groups search), etc. etc.

So, to not make this post too long, some suggestions for plugin authors (of course, with the utmost respect and humility knowing full well I'm not a plugin author myself), is to:

• Follow in the great Mohammad's footsteps and always have clearly indicated a "Demo" and "code" link in the README of the plugin.
• Follow in Nico (and many others as well, just the latest one I can remember) steps of including comprehensive documentation packaged right along with the plugin itself!

--------------------------------

A side note: For point two above, I recently posted a feature suggested on GitHub about letting plugin authors more easily edit the viewTemplate of their plugins, getting rid of the (potentially) "scary" $:/plugins/... in the title, and instead exposing something like:

Plugins > Projectify > Documentation

I think even having a plugin tiddler with a title like $:/plugins/author/name/tidname can be used as a customized view template to see it as a tidname, but you have to overwrite some core tiddlers. Maybe this can be added officially by Jeremy!

 

even though the tiddler is of course actually titled "$:/plugins/nico/projectity/...". I closed it after some discussion, but I thought I'd mention it here in case anyone would like to share their thoughts about this possibility as well.

Best,

Diego

--
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 view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywiki/7541bcde-2440-49c1-a971-2867e08c048fn%40googlegroups.com.