Utility plugin Release 0.5.0 beta

[Mohammad]

Announcement:Utility plugin

Date: Oct 11, 2019

Release: 0.5.0 beta

Status:  in progress

This is to announce the beta release Utility plugin! It is a complement to Shiraz. This plugin targets who like authoring specially developer.

Demo: https://kookma.github.io/TW-Utility/

Source: https://github.com/kookma/TW-Utility

Your feedback is highly welcome.

If you like it star it at GitHub (https://github.com/kookma/TW-Utility)

--Mohammad

Utility Plugin

11th October 2019 at 4:28pm

Tiddlywiki5.1.19+

 

LicenseMIT

 

Release0.5.0 beta

 

Statusstable

What is Utility plugin?

Utility plugin is a small set of stylesheets, templates and macros. It has different tools for customizing and authoring specially for developers.

Install

Packaged plugin

1. Drag and drop $:/plugins/kookma/utility into your wiki
2. Save and reload your wiki

Client-Server installation (separate files)

• For Node.js (server version) download the utility folder from source folder and paste in your Tiddlywiki plugins folder
• For local installation put the utility folder into your local plugins folder under your wiki folder

It is highly recommended to backup your data before trying any new plugin! Do it before installing Utilty

Tutorials

Utility Tutorial is a good point to start. Also have a look at indivial demo.

1. Custom transclusion
2. Wikitext macro
3. Show macro
4. Simple navigation
5. Fields in view mode
6. Tiddlywiki version badge
7. Svg image in wikitext
8. Fields in view mode

Acknowledgement

• Jeremy Ruston
• Ton Gerner
• Mark s
• BTC
• Anthony Muscio (TonyM)

History

Revision 0.5.0 beta

• Date: [10th Oct 2019]
• beta release
• documentation improved

[Birthe C]

 Hi Mohammad,

I am a little confused. You start with simple-navigation, next an example using simpleNavigation. All the writing is about tag, but then I see a tiddler named simple navigation tagged $:/tags/ViewTemplate containing <<simple-navigation alert>>.

A typo, tiddler named demo/Viw-field (Demo View-field I suppose)

Leaving for now to "play" some more, lovely on a cold and rainy day ;-)

Birthe

[Mohammad]

Hi Birthe,

 Let me to check! I will add more clear explanation!

--Mohammad

On Friday, October 11, 2019 at 7:20:26 PM UTC+3:30, Birthe C wrote:

 Hi Mohammad,

I am a little confused. You start with simple-navigation, next an example using simpleNavigation. All the writing is about tag, but then I see a tiddler named simple navigation tagged $:/tags/ViewTemplate containing <<simple-navigation alert>>.

Simple navigation adds previous | next buttons at the bottom of tiddlers tagged with a specified word like demo! 

So, it uses tags to work!

I will check for typo!

 

A typo, tiddler named demo/Viw-field (Demo View-field I suppose)

Thank you! I correct it! 

Leaving for now to "play" some more, lovely on a cold and rainy day ;-)

Enjoy!

 

Birthe

[Mohammad]

Hi Birthe

A new release 0.6.0 beta pushed!

Typo has been corrected

Better example has been given for simple-navigation

Some other minor correction

--Mohammad

On Friday, October 11, 2019 at 7:20:26 PM UTC+3:30, Birthe C wrote:

[@TiddlyTweeter]

This is to announce the beta release Utility plugin! It is a complement to Shiraz. This plugin targets who like authoring specially developer.

Its good. Its useful.

But I'm not sure (yet) whether its better to have its own wiki or just be integrated with TWScripts?

Part of the problem is that the category "developer" kinda blurrs in TW. 

I mean I'm NOT a developer but there are things in the plugin I understand & can use.

So I'm not clear how its different than TWScripts, other than being a plugin?

I'd rather not have to visit two places when one will do?

Just thoughts

Josiah

[Damon Pritchett]

Hey Mohammad,

I like your utility plugin very much! Thanks. I was wondering what modifications to the simple-navigation macro could be done to close the current tiddler when using the previous or next buttons.

Thanks,

Damon

[Mohammad]

One simple solution is using Zoomin storyview!

But it is possible to add a close message! So you can use the below modified version

\define simple-navigation(tag:"demo", class)
<$list filter="[all[current]tag[$tag$]]">
<div class="$class$">
<$list filter="[tag[$tag$]before<currentTiddler>]" variable="prevTiddler">
<$button to=<<prevTiddler>> tooltip=<<prevTiddler>> class="tc-btn-invisible">previous
<$action-sendmessage $message="tm-close-tiddler" $param=<<currentTiddler>>/>
</$button>
</$list>
<$list filter="[tag[$tag$]after<currentTiddler>] [tag[$tag$]before<currentTiddler>] +[count[]] -1" variable=ignore>|</$list>
<$list filter="[tag[$tag$]after<currentTiddler>]" variable="nextTiddler">
<$button to=<<nextTiddler>> tooltip=<<nextTiddler>> class="tc-btn-invisible">next
<$action-sendmessage $message="tm-close-tiddler" $param=<<currentTiddler>>/>
</$button></$list>
</div>
</$list>
\end

--Mohammad

[Mohammad]

The Utility plugin is a set of tools can be used for any purpose! but it is specially useful when you are writing something to explain the TW itself or a plugin, script and like that!

So, in normal use one does not need to have wikitext-example macro!

Tha't is the reason I said it is good for developer.

It is different from TW-Script where, TW-Scripts is a resource and TW-Utility is a plugin! and part of it cannot be found in TW-Scripts!

Furthermore TW-Scripts is a resource, a reference wiki NOT a plugin!

--Mohammad

[Mohammad]

More input!

When I write documentation for plugin or solutions I need a tool such as Utility!

You will find it in all my revised or new demo (documentation) wikis.

--Mohammad

On Monday, October 14, 2019 at 10:04:02 PM UTC+3:30, @TiddlyTweeter wrote:

[Damon Pritchett]

Thanks so much. That worked beautifully! I actually created a new macro with the added lines and called it simple-navigation-close. Best of both worlds that way.

Damon

[TonyM]

Mohammad,

Lovely work once again. You really make things happen. I have a set of designer tools as well would you like me to submit them to you for inclusion or should I publish separately?

Regards

Tony

[TonyM]

Mohammad,

SInce I have quite a few I thought I would follow your lead and publish my own, perhaps at later date we may merge them.

Regards

Tony

[Mohammad]

Hi Tony!

 Sounds great! Your ideas, helps and solutions always useful for TW community!

Looking forward to see your designer tools. I have seen many interesting tiny tools in PSat and worth

to publish them.

--Mohammad 

[Mohammad]

Hi Damon,

 Yep, good idea to have both :-)

--Mohammad

[Mohammad]

Announcement:Utility plugin

Date: Oct 15, 2019

Release: 1.1.0

Status:  stable

This update has a modified simple-navigation macro based on Damon request to optionally close the currentTiddler on navigation.

Thanks Damon!

Revision 1.1.0

• Date: [15th Oct 2019]
• The simple-navigation has new parameter close
• The simple-navigation macro optionally closes the current tiddler when the previous | next button is clicked

Revision 1.0.0

• Date: [13th Oct 2019]
• stable release
• viewtemplate to display global macro content
• documentation improved

[@TiddlyTweeter]

Ciao Mohammad

Fields in view mode is a useful tool.

How would I add the tags mechnism to change Tags without having to open the editor? 

And the Content-Type?

I'm interested particularly in being able to change the Content-Type in view mode. 

This would help with a regex utility I'm working on?

I'm not expecting you to do it! 

I just need to understand what I'd need to look into to understand how I might have Content-Type setting in view mode!

Any tips appreciated.

Best wishes

Josiah

Mohammad wrote:

Announcement:Utility plugin

Date: Oct 11, 2019

Release: 0.5.0 beta

Status:  in progress

1. 
   
2. Fields in view mode
3. 
   

[Birthe C]

TT,

Are you using the toggle field button for that? You could have a button to toggle tags also. I have an example in one of my wikis. In fact trying to translate some of my cookbook into english ;- ) http://mycookbook.tiddlyspot.com/ I do not remember the origin but at some point early on a lot of us used it.

Birthe

[@TiddlyTweeter]

Birthe

Lovely recipies! Nice approach.

I might start a thread on "A History Of Cooking & TiddlyWiki" :-).

Seriously, the history looks like a very good illustrative approach to common issues.

Thanks for the Tab live edit tool. 

I had seen it before but (as usual could not find it in the GG history when needed).

All I need know now is how to figure out how to do the same for Content-Type.

Best wishes

TT

[@TiddlyTweeter]

Ciao Mohammad

I better understand it now.

I want to re-phrase my comment.

Is "Utility Plugin" the closest term to its aim? "Utility" is very generic. 

It lacks any definition of scope.

But, from what you wrote, it seems more like a "Documentation Assistant"?

Just a thought!!! No WAY do I dislike it. Just wonder if the naming is relevantly precise?

Best wishes

Josiah

[Mohammad]

Hi Josiah,

Yes, that's right!

Hopefully I will add more tools in future.

I use the utility title as it has some handy tools in plugin development phase.

--Mohammad

[Birthe C]

TT

Look one more time http://mycookbook.tiddlyspot.com/ and find the toggle-type-button. The Fairy emoji button. I really do not need any of those button in the mycookbook, so I do not think they will stay there for ever.

Birthe

[Mohammad]

Birthe,

 Your cookbook has great tools!

Thank you for sharing.

Best

Mohammad

[Damon Pritchett]

Hey Mohammad,

Works like a charm! Thanks very much!!!! Wonderful set of utilities!

Damon

[@TiddlyTweeter]

Does NOT make sense.

"Utility" is so generic it means "whatever". 

Its without a portfolio. So broad its meaningless.

This is purely semantics. I like the CONTENT but IMO the NAME is WRONG.

Broad "Utility" is NOT what it is.

BUT it does not matter since in GG everything goes into mush anyway. 

And anyone can name anything ANYTHING.

So just do what you will do, already.

Best wishes

TT

[@TiddlyTweeter]

I archived your thing already :-)

[Mohammad]

Announcement:Utility plugin

Date: Oct 23, 2019

Release: 1.3.0

Status:  stable

Revision 1.3.0

• Date: [23th Oct 2019]
• Minor issue fixed on show fields button