Utility Plugin Update 2.2.0 - 3.2.2

[Mohammad]

WARNING:

• This update does not work in TW5.2.0 and older nor in TW5.2.3p. For TW5.2.3+ wait to have TiddlyWiki official release of 5.2.3
• This update best works in Tiddlywiki 5.2.2 the current stable release (July 21st, 2022)

What is Utility plugin?

The utility plugin objective is to provide set of tools for authors. These tools includes simple transclusions, show raw contents of tiddlers, reader mode, wikitext macros, show fields in view mode, linkify, code, docit, and much more!

Utility enables authors to have a lot of controls on UI elements!

Tutorials

Demo and Code

• Demo: Utility 3.2.3 — utility kit for authors and developers
• Code: GitHub - kookma/TW-Utility: Utility macros, buttons, and styles for documentation and development · GitHub

Release Note

• July 20th, 2022
• [NEW] Update to Tiddlywiki 5.2.2
• [NEW] Reader mode, new shortcuts: ctrl-shift-Slash
• [NEW] Customize UI, new shortcuts: ctrl-shift-Period
• [NEW] Tiddlers tagged with$:/tags/Stylesheet use Cascades to show contents as CSS code block and not wikified. This is useful for dynamic stylesheets
• [NEW] Reveal code at button the bottom of all tiddlers. When show content is on, the button is not displayed
• [FIXED] The viewtemplate namespace was renamed to viewtemplates
• [FIXED] The macro namespace was renamed to macros
• [FIXED] Minor issue in page control button when is minified using Uglify plugin
• [FIXED] The show fields button now displays fields before tiddler body, so it does not overlap with other plugins like Thinkup
• [FIXED] Author tools and modal have been removed

Acknowledgement

• Jeremy Ruston
• Ton Gerner
• Mark s
• BTC
• Mat
• Anthony Muscio
• Damon Pritchett
• Eshka
• Saq Imtiaz
• Telumire

References

1. Utility Plugin: A Partial Update - Plugins - Talk TW (tiddlywiki.org)

[Mohammad]

HowTo

The Utility Reader Mode just got simpler.

1. open Utility 2.2.0 — utility kit for authors and developers (kookma.github.io)
2. Press shortcuts ctrl+shift+slash
3. It goes to Reader mode

Reader mode means to remove clutter from the UI. In other words to turn off all UI elements related to editing (e.g new tiddler, edit tiddler, delete tiddler, new journal, …) or not required for one who visits the page (wiki) or a reader.

Screenshot

In Reader mode

[Mohammad]

HowTo

The Utility Show/Hide Individual UI elements just got simpler.

1. open Utility 2.2.0 — utility kit for authors and developers (kookma.github.io)
2. Press shortcuts ctrl+shift+period
3. It goes to Show/Hide Individual UI elements

[Mohammad]

HowTo

The Utility Show/Hide Individual UI elements just got simpler.

1. open Utility 2.2.0 — utility kit for authors and developers (kookma.github.io)
2. Open a tiddler
3. Click on the dimmed Code button at the tiddler right bottom to see the raw wikitext
4. You can copy the wikitext using the copy to clipboard button

NOTE You can turn off the Code button from Utility Settings.

[Mohammad]

HowTo

The Utility show-macro lets to list all macros in a desired scope.

1. open Utility 2.2.0 — utility kit for authors and developers (kookma.github.io)
2. Create a new tiddler
3. in the text field enter: <<show-macro "$:/core/macros/list">>
4. Look at the output. This lists all macros in ‘’$:/core/macros/list’’

[Mohammad]

HowTo

The Utility show fields in view mode lets to manipulate .

1. open Utility 2.2.0 — utility kit for authors and developers (kookma.github.io)
2. open any tiddler
3. click on show-fields from page control
4. see fields in view
5. click again on show-fields from page control to hide fields

Screencast

[CodaCoder]

Looks good, @Mohammad

Couple of questions:

1. Can I change the keyboard shortcuts?

2. Are there alternate ways to access functionality without the shortcuts?

[Mohammad]

@CodaCoder

Can I change the keyboard shortcuts?

For sure! This is like other shortcuts! Just open $:/ControlPanel → Keyboard Shortcuts
and then assign new shortcuts you like!

@CodaCoder

Are there alternate ways to access functionality without the shortcuts?

In the current design:

• You can open Customize Ui from Sidebar → More → Utility → Show/hide selected UI elements
• For switch reader mode! You need to hack! You can create a tiddler use a $button and use the actions in switch-reader tiddler.

[Springer]

Mohammad, thanks for this update!

The “show fields” button is probably the most clicked button on several of my projects; I do want fields showing for some tasks, but I prefer them hidden for others. Perhaps I’m not alone in this…

Could there be a keyboard shortcut attached to the show fields button?

-Springer

[Mohammad]

@Springer

Could there be a keyboard shortcut attached to the show fields button?

I add this to improvement! It is possible

[Mohammad]

Utility plugin got an update to work with TW 5.2.3

Important Note

1. Always create backups before updating
2. Update Utility (this version does not work with TW 5.2.2 and older version)
3. Open $:/ControlPanel → Plugins → Utility → Contents
4. Delete any shadow tiddler if that has been overwritten

Demo and Code

• Demo: Utility 2.3.0 — utility kit for authors and developers
• Code: https://github.com/kookma/TW-Utility

[Mohammad]

@Springer

Could there be a keyboard shortcut attached to the show fields button?

Utility 2.3.1 has ctrl-slash for this as shortcuts. You well know how to change shortcuts and customize them for yourself. ($:/ControlPanel → Keyboard Shortcuts)

[Springer]

@Mohammad,

@Mohammad

Utility 2.3.1 has ctrl-slash for this as shortcuts

Somehow that keyboard shortcut is not working – and not appearing in the list of shortcuts at $:/ControlPanel – for me. I do see how it is supposed to work, at your plugin site.

Here’s my 5.2.3 “quick-demo” site with nothing other than a few plugins (incuding Utility 2.3.1) , which mysteriously does not seem to include your new keyboard shortcut:

Quick-demo TiddlyWiki

I’m sorry to tug on you for trouble-shooting! This is certainly not urgent, but perhaps something useful to others will emerge in the course of discovering the cause.

-Springer

[Mohammad]

@Springer

Here’s my 5.2.3 “quick-demo” site with nothing other than a few plugins (incuding Utility 2.3.1) , which mysteriously does not seem to include your new keyboard shortcut:

Would you please install 2.3.1 by drag and drop from demo site? (Please also delete the current installed plugin before drag and drop).

Edit: There was an issue in kookma plugin library. I will fix it by tomorrow.

[Springer]

Yes, the new feature(s) of the Utility 2.3.1 plugin do work when I install it by drag-and-drop. (I had intalled 2.3.1 via the kookma library.)

-Springer

[Mohammad]

@Springer

I had intalled 2.3.1 via the kookma library

The library now works as expected.

[Mohammad]

Utility plugin got a new update.

Release 2.4.0

• Nov 10th, 2022
• [NEW] Option to center storyriver when sidebar is closed
• [FIXED] bug fixes in simple navigation macro
• [FIXED] docs improved

Demo and Code

• Demo: Utility 2.4.0 — utility kit for authors and developers
• Code: GitHub - kookma/TW-Utility: Utility macros, buttons, and styles for documentation and development

Screenshot

[Mohammad]

Utility Plugin got a new update

Release 2.6.1

• Mar 8th, 2023
• [NEW] The .lorem macro supports number of words
• [NEW] The wikitext-macro supports embeded macro (macro embeded in host tiddler).
• [NEW] The wikitext-macro name has been changed. This is not backward compatible.
• [FIXED] Space in page control button (view-fields)
• [FIXED] The snippets for wikitext-example modified and corresponding tiddlers were renamed
• [FIXED] The wikitext-macro supports dark palettes
• [FIXED] The reveal-code does not show duplicate code for tiddlers has code-body field set to yes.

WARNING The wikitext-example and wikitext-example-without-html macros are not backward compatible. See examples and details before upgrading!

[Mohammad]

Release 3.1.2

• Nov 22st, 2024
• [NEW] A custom codeblock widget was added to include code caption and a copy-button. Special thanks to Saq Imtiaz, Telumire, Mateusz Wilczek, and Saq Imtiaz
• [NEW] A type mapping for text/vnd.tiddlywiki was added in $:/config/HighlightPlugin/TypeMappings/text/vnd.tiddlywiki to map text/vnd.tiddlywiki to xml
• [NEW] Extended subtitle to show optionally the created, and updated date on tiddler subtitle. Special thanks go to Soren Bjornstad
• [NEW] A new icon is used for view fields
• [FIXED] The code procedure is deprecated and instead using custom $codeblock is recommended
• [FIXED] The copy-button from procedures in $:/plugins/kookma/utility/procedures/wikitext-example (i.e. wikitext-example and wikitext-example-with-html) was removed
• [FIXED] The custom codeblock widget does not show the copy button when it is empty (e.g no code is existed)
• [FIXED] Update the toggle source tiddler to cover new rules in TW 5.3.6 (see $:/plugins/kookma/utility/viewtemplates/source-toggle-button)
• [FIXED] The $:/config/Utility JSON tiddler now holds all configuration of Utility plugin

For all changes see ChangeLog

Code and demo

• Demo: Utility 3.2.3 — utility kit for authors and developers
• Code: GitHub - kookma/TW-Utility: Utility macros, buttons, and styles for documentation and development · GitHub

[Mohammad]

The new View Fields icon on the page control may not be visually appealing, but it’s an improvement over the previous one, which resembled the dark/light theme switcher icon. I would appreciate a view field SVG as a replacement for the upcoming release. The standard TiddlyWiki icons are bold, and I believe the new icon should match the TW icons’ style.