Shiraz plugin new release 2.3.0

528 views
Skip to first unread message

Mohammad Rahmani

unread,
May 11, 2021, 4:30:08 AM5/11/21
to tiddl...@googlegroups.com
Shiraz plugin has just got a new update!

Shiraz is a small framework of stylesheets, templates and macros to create stylish contents in Tiddlywiki. Shiraz has customized elements like alerts, cards, panels, images, static tables, dynamic tables, badges, texts, etc. Shiraz uses some modified CSS classes from Bootstrap 4.3.1.

Code and demo
It is highly recommended to backup your data before trying any new plugin! Do it before installing shiraz.
Revision 2.3.0

  • Date: [10th May 2021]
  • [NEW] Palette switch on the page controls
  • [NEW] Setting for default light and dark (or dim) palette (see Sidebar More Tab, Shiraz)
  • [NEW] Slider macro accepts tiddler title as source (src) and extracts the text automatically
  • [NEW] Details macro accepts tiddler title as source (src) and extracts the text automatically
  • [FIXED] small type in card-image macro


If you like it star it at https://github.com/kookma/TW-Shiraz



Best wishes
Mohammad

Pall Sigurdsson

unread,
May 14, 2021, 10:13:54 AM5/14/21
to TiddlyWiki
Hi Mohammad,
I added this to my personal TiddlyWiki in version 2.2.2 and was impressed. I'm usually reluctant to import "packages" like this, which might contain a lot of stuff I end up not using, but then I guess I'm not using everything that's in the core either. The more I explore Shiraz I'm finding it more and more useful.
I upgraded the plugin to 2.3.0 yesterday and I'm trying out the changing "Details on Demand" now. Great addition! Immediately useful. Thanks!
Best regards,
Pall
Message has been deleted

si

unread,
May 14, 2021, 11:29:48 AM5/14/21
to TiddlyWiki
Thanks Mohammad - this is a very useful plugin.

I only just realized it had a details macro. I've been using this, but have been lamenting the fact that it doesn't let you include links in the title.

In your version there a way to change a state tiddler so that TiddlyWiki will remember whether a particular instance of the details macro was left open or closed? I can see there is a status field, but I'm looking for something that will "remember" the status it was last left in.

Mohammad Rahmani

unread,
May 14, 2021, 11:46:54 AM5/14/21
to tiddl...@googlegroups.com
Thank you Pall and Si

An extensive tutorial with many examples has accompanied the demo

YES, Shiraz has Display on Demand from version 1. 
Shiraz has two macro for this Slider and Details. both get status to set them open or closed by default!
Slider has an internal state variable that remembers its last status despite the default status! BUT note that $:/state tiddlers are deleted on Node.js

Mohammad Rahmani

unread,
May 14, 2021, 11:51:44 AM5/14/21
to tiddl...@googlegroups.com
Si,
 The slider and details macros are very powerful, especially if you use them with other tools in Shiraz. you create many useful design using them

Examples: Create FAQ in 5 finute!




Best wishes
Mohammad


On Fri, May 14, 2021 at 7:55 PM si <matthew...@gmail.com> wrote:
Thanks Mohammad - this is a very useful plugin.

I only just realized it had a details macro. I've been using this, but have been lamenting the fact that it doesn't let you include links in the title. Yours does so thank you!

On Tuesday, 11 May 2021 at 09:30:08 UTC+1 Mohammad wrote:

--
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/6299dea6-a9d9-41ed-8cd7-16f624d33d64n%40googlegroups.com.

si

unread,
May 14, 2021, 12:13:07 PM5/14/21
to TiddlyWiki
Thanks Mohammad for your reply.

>>> Slider has an internal state variable that remembers its last status despite the default status!

So I am being picky but is there any easy way to do this with the Details macro? I just prefer the look/feel of the HTML element. Obviously it is possible, because it has been done here: tid.li/tw5/plugins.html#DetailsWidget. But maybe that requires JavaScript wizardry?

>>> BUT note that $:/state tiddlers are deleted on Node.js

I don't use Node.js so this isn't a problem for me personally, but what is the logic of deleting state tiddlers? I mean there must be lots of examples where you would want to remember the state of something?

Mohammad Rahmani

unread,
May 14, 2021, 12:16:20 PM5/14/21
to tiddl...@googlegroups.com
Hi Pall,
Many people are reluctant to use plugins. Except for two plugins in Kookma, all plugins in kookma library are pure wikitext and do not use JS.


Shiraz is one of most powerful and useful plugins here, mimicking Bootstrap 4, one the most common CSS framework in web design nowadays!
Shiraz has safe classes of Bootstrap 4. Using Shiraz in Tiddlywiki you can make elegant web apps, seb page, static page , ... 

To get more familiar with Shiraz features see the https://kookma.github.io/TW-Shiraz/#Shiraz%20Tutorial

Some examples useful to be read

-  cards
- badges
- buttons
- multi column story river
- multi column tiddlers
- sticky footer
- color palette switch 
- ...









--
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.

Pall Sigurdsson

unread,
May 14, 2021, 6:00:28 PM5/14/21
to tiddl...@googlegroups.com
Thanks, I've been reading the tutorial. There is a lot to take in and I keep returning to it. The details widget is not the only thing I'm using so far. I've found alerts to be useful for various emphasis and examples. Then I've also put the dynamic tables into use. I'm for example experimenting with some kind of reference explorer similar to the one in Soren Bronstad's Zettelkasten (recent thread in this group), only using the Shiraz plugin instead of TiddlyTables. I've not gotten to where I want to be with it yet - for example I haven't figured out if or how it would be possible to have a separate column to show the type of link (forward link, backlink vs tagging) so I'm right having three separate tables right now in my ViewTemplate at the bottom. (I guess anyone reading this who hasn't checked out Soren Bronstad's video "A walk through my Zettelkasten" will have no idea what I'm talking about here.)

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/OBjYgzlr1Ys/unsubscribe.
To unsubscribe from this group and all its topics, send an email to tiddlywiki+...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywiki/CAAV1gMAs-0D_Nsm8LWCs6FfrMMnAnzAQJf1ahk1fbQfnJRkNWw%40mail.gmail.com.

Mohammad Rahmani

unread,
May 15, 2021, 12:23:36 AM5/15/21
to tiddl...@googlegroups.com
On Sat, May 15, 2021 at 2:30 AM Pall Sigurdsson <psigu...@gmail.com> wrote:
Thanks, I've been reading the tutorial. There is a lot to take in and I keep returning to it. The details widget is not the only thing I'm using so far. I've found alerts to be useful for various emphasis and examples. Then I've also put the dynamic tables into use. I'm for example experimenting with some kind of reference explorer similar to the one in Soren Bronstad's Zettelkasten (recent thread in this group), only using the Shiraz plugin instead of TiddlyTables. I've not gotten to where I want to be with it yet - for example I haven't figured out if or how it would be possible to have a separate column to show the type of link (forward link, backlink vs tagging) so I'm right having three separate


There is no such template for links in Shiraz! I can add it in the next release! But for now you need to write your own template!
Shiraz is very flexible and has good documentation to help you with tha! See

In the tutorial look at the column template and see how new user templates are written!

For you convenience I have attached a linktype column template to address your above problem and can have a ref explorer like Zettlkasten edition!

To unsubscribe from this group and all its topics, send an email to tiddlywiki+...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywiki/CAAV1gMAs-0D_Nsm8LWCs6FfrMMnAnzAQJf1ahk1fbQfnJRkNWw%40mail.gmail.com.

--
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.
$__plugins_kookma_shiraz_templates_body_linktype.json

Pall Sigurdsson

unread,
May 15, 2021, 1:01:57 AM5/15/21
to tiddl...@googlegroups.com
Thank you, Mohammad! I will try out the template and let you know.

Best regards,
Pall

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/OBjYgzlr1Ys/unsubscribe.

To unsubscribe from this group and all its topics, send an email to tiddlywiki+...@googlegroups.com.

Pall Sigurdsson

unread,
May 15, 2021, 9:43:08 AM5/15/21
to tiddl...@googlegroups.com
Hello Mohammad,

Your template returned always the string "backlink", also in the case of forward links. In addition to links and backlinks I also wanted to identify child tiddlers, that is tagging tiddlers. I managed to achieve all that by "borrowing" some additional code from the linktype template in Soren Bjornstad's Zettelkasten and combine it with yours. The full template from Soren includes some additional link types which I was not able to understand, for example "memberof" and "spouse". I ignored those for now and included only links, backlinks and tagging. I'm attaching the updated template.

After this small exercise I'm starting to understand the power of column templates.

Best regards,
Pall
$ _plugins_kookma_shiraz_templates_body_linktype.json

Mohammad Rahmani

unread,
May 15, 2021, 10:38:05 AM5/15/21
to tiddl...@googlegroups.com
Pall,
In dynamic table currentRecord is equivalent to currentTiddler. In the example I sent you
it only cares about links and backlinks not other types of nodes like tagging! but you can add them!


I will add examples to Shiraz Demo later! But it seems you have been able to get template work for you!
The Soren solution is a comprehensive one!


Yes, you need to do some practice with template, they are really powerful!


Best wishes
Mohammad


Mohammad

unread,
May 19, 2021, 2:52:05 PM5/19/21
to TiddlyWiki
Hi Pall,
 See new update of Shiraz. It supports linktype using a new column template!

Please see

Pall Sigurdsson

unread,
May 23, 2021, 3:23:03 AM5/23/21
to tiddl...@googlegroups.com
Hi Mohammad, 

Thanks, I noticed but haven't gotten around to taking a look at your version of it - too busy building other things in TiddlyWiki :) - but meanwhile I noticed what seems to be a small oversight in the Shiraz settings. The settings tiddler is tagged with $:/tags/ControlPanel/SettingsTab but the tag should be $:/tags/ControlPanel/Settings (without tab at the end if it's supposed to show in the settings tab).

Best regards,
Pall










Mohammad Rahmani

unread,
May 23, 2021, 4:30:28 AM5/23/21
to tiddl...@googlegroups.com
Hi Pall,
 Thank you for your feedback. Yes, the issue is bare TW has not those sub tabs under settings! Those are created by CodeMirror!
In fact CodeMirror overwrites the setting tab of core and creates those sub tabs!

 So if you have installed codemirror, you can see that setting page! See below screenshot

image.png


I have submitted a ticket on GitHub and am waiting for a decision! If Jeremy accepts the proposal, then every plugin setting tab will appear
in $:/ControlPanel --> Settings as a sub tab not alongside Settings, Saving, Appearance ...

Best wishes
Mohammad


Mohammad Rahmani

unread,
May 23, 2021, 4:32:04 AM5/23/21
to tiddl...@googlegroups.com
Quick access tab!

Note: If you have not CodeMirro installed, look at the Sidebar / More tab / Shiraz tab
You will find there the Shiraz and other kookma plugin settings for quick access!


Best wishes
Mohammad


Pall Sigurdsson

unread,
May 23, 2021, 6:46:03 AM5/23/21
to tiddl...@googlegroups.com
Ah, so it's kind of a dependency to CodeMirror right now. It makes no difference to me as I'm just using the settings in the More tab.

I tried installing CodeMirror earlier but removed it because I found it to interfere with editing tiddlers with TiddloidLite on Android. I was unable to select words or sentences by pressing on them. Apart from that, the plugin looked promising but I'm very well getting on without it. Shiraz is a completely different story. I got quickly addicted to that and I don't think it would be easy for me to back out of that if I wanted :)

Best regards,
Pall


Mohammad Rahmani

unread,
May 23, 2021, 10:28:45 AM5/23/21
to tiddl...@googlegroups.com
On Sun, May 23, 2021 at 3:15 PM Pall Sigurdsson <psigu...@gmail.com> wrote:
Ah, so it's kind of a dependency to CodeMirror right now. It makes no difference to me as I'm just using the settings in the More tab.

I will resolve the issue! I have resistance to overwriting Core tiddler even in this case, which is a very simple change in the Settings tab! 

I tried installing CodeMirror earlier but removed it because I found it to interfere with editing tiddlers with TiddloidLite on Android. I was unable to select words or sentences by pressing on them. Apart from that, the plugin looked promising but I'm very well getting on without it. Shiraz is a completely different story. I got quickly addicted to that and I don't think it would be easy for me to back out of that if I wanted :)

Yes, Shiraz is a very handy tool especially if you like to have nice visual effects (e.g alerts, cards, images, ...) the dynamic table, list-search, slider, details, FAQ, ... is also very handy in most cases!
Message has been deleted

si

unread,
Jun 6, 2021, 8:36:50 AM6/6/21
to TiddlyWiki
Hi Mohammad,

I've been using Shiraz for a while now, and its super amazing and useful, however I have noticed that it has some features that feel like they should belong in a separate plugin.

Specifically there are a few features that don't have much do do with creating stylish content, and more what I would consider "theme tweaks". For example:
  • Colorify sidebar tabs
  • Button for light/dark mode
  • Tiddler visibility on mouse hover
I am referring essentially to everything under the Shiraz settings tab. These are all extremely useful tools, but I just think they diverge quite far from your description of Shiraz: "Shiraz is a small framework of stylesheets, templates and macros to create stylish contents in Tiddlywiki."

Currently if a user installs Shiraz, they will also find that their wiki theming has been tweaked, and will have to go to the settings tab if they want to turn everything off. In my opinion it would make more sense to these tweaks into a separate plugin so that the user can choose whether or not to install them.

I hope this doesn't sound critical, as Shiraz is one of my favourite TW plugins. It's just my personal opinion and I'm curious if there is a logic to including theme tweaks and styling macros as part of the same plugin that I am not seeing?


On Tuesday, 11 May 2021 at 09:30:08 UTC+1 Mohammad wrote:

Mohammad Rahmani

unread,
Jun 6, 2021, 10:34:43 AM6/6/21
to tiddl...@googlegroups.com
Hi Si,
 Many thanks for your comments! 
Ideas and opinions are always welcome !
Sure I note this and will consider it in the next release! 
Maybe we can have a "sweat tweak" plugin ;-) to include such things?
I think these are:
- two column story river
- colorful tabs
- colorful view toolbars and hide/show on mouse hover





Best wishes
Mohammad


On Sun, Jun 6, 2021 at 5:06 PM si <matthew...@gmail.com> wrote:
Hi Mohammed,

I've been using Shiraz for a while now, and its super amazing and useful, however I have noticed that it has some features that feel like they should belong in a separate plugin.

Specifically there are a few features that don't have much do do with creating stylish content, and more what I would consider "theme tweaks". For example:
  • Colorify sidebar tabs
  • Button for light/dark mode
  • Tiddler visibility on mouse hover
I am referring essentially to everything under the Shiraz settings tab. These are all extremely useful tools, but I just think they diverge quite far from your description of Shiraz:

>>> Shiraz is a small framework of stylesheets, templates and macros to create stylish contents in Tiddlywiki.

Currently if a user installs Shiraz, they will also find that their wiki theming has been tweaked, and will have to go to the settings tab if they want to turn everything off. In my opinion it would make more sense to these tweaks into a separate plugin so that the user can choose whether or not to install them.

I hope this doesn't sound critical, as Shiraz is one of my favourite TW plugins. It's just my personal opinion and I'm curious if there is a logic to including theme tweaks and styling macros as part of the same plugin that I am not seeing?
On Tuesday, 11 May 2021 at 09:30:08 UTC+1 Mohammad wrote:

--
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.

Mohammad Rahmani

unread,
Jun 6, 2021, 10:38:17 AM6/6/21
to tiddl...@googlegroups.com
On Sun, Jun 6, 2021 at 5:06 PM si <matthew...@gmail.com> wrote:
Hi Mohammad,

I've been using Shiraz for a while now, and its super amazing and useful, however I have noticed that it has some features that feel like they should belong in a separate plugin.

Specifically there are a few features that don't have much do do with creating stylish content, and more what I would consider "theme tweaks". For example:
  • Colorify sidebar tabs
  • Button for light/dark mode
  • Tiddler visibility on mouse hover
I am referring essentially to everything under the Shiraz settings tab. These are all extremely useful tools, but I just think they diverge quite far from your description of Shiraz: "Shiraz is a small framework of stylesheets, templates and macros to create stylish contents in Tiddlywiki."

Currently if a user installs Shiraz, they will also find that their wiki theming has been tweaked, and will have to go to the settings tab if they want to turn everything off. In my opinion it would make more sense to these tweaks into a separate plugin so that the user can choose whether or not to install them.

I hope this doesn't sound critical, as Shiraz is one of my favourite TW plugins.


 
It's just my personal opinion and I'm curious if there is a logic to including theme tweaks and styling macros as part of the same plugin that I am not seeing?

The reason was: all those tweaks are done using simple css! nothing else!


 


On Tuesday, 11 May 2021 at 09:30:08 UTC+1 Mohammad wrote:
Shiraz plugin has just got a new update!

Shiraz is a small framework of stylesheets, templates and macros to create stylish contents in Tiddlywiki. Shiraz has customized elements like alerts, cards, panels, images, static tables, dynamic tables, badges, texts, etc. Shiraz uses some modified CSS classes from Bootstrap 4.3.1.

Code and demo
It is highly recommended to backup your data before trying any new plugin! Do it before installing shiraz.
Revision 2.3.0

  • Date: [10th May 2021]
  • [NEW] Palette switch on the page controls
  • [NEW] Setting for default light and dark (or dim) palette (see Sidebar More Tab, Shiraz)
  • [NEW] Slider macro accepts tiddler title as source (src) and extracts the text automatically
  • [NEW] Details macro accepts tiddler title as source (src) and extracts the text automatically
  • [FIXED] small type in card-image macro


If you like it star it at https://github.com/kookma/TW-Shiraz



Best wishes
Mohammad

--
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.

Si

unread,
Jun 13, 2021, 1:01:52 PM6/13/21
to TiddlyWiki
>>> The reason was: all those tweaks are done using simple css! nothing else!

Yes, and its very cool! I'm just saying that I don't understand the logic of keeping it all in one plugin. A plugin that just contains "Things that use CSS" seems a little broad to me, and doesn't tell you much about the actual purpose of the plugin?

Mohammad Rahmani

unread,
Jun 13, 2021, 3:00:54 PM6/13/21
to tiddl...@googlegroups.com
Thank you for your comment Si. I will revise the description in the next release!
In its original form Shiraz is a small CSS and macro framework! but later on it extended to cover tables. images, etc...

Best wishes
Mohammad


Message has been deleted

Si

unread,
Jun 14, 2021, 11:37:35 AM6/14/21
to TiddlyWiki
Hi Mohammad,

Sorry I didn't see this original reply so I only responded to your second comment!

>>> Maybe we can have a "sweat tweak" plugin ;-) to include such things?
>>> I think these are:
>>> - two column story river
>>> - colorful tabs
>>> - colorful view toolbars and hide/show on mouse hover

Yes I personally think that this would be better. The original Shiraz for "Macros for creating stylish content in TiddlyWiki", and a new plugin for "Theme tweaks" (e.g. light/dark mode, colorful sidebar tabs etc). I think that narrower categorisation will make it easier for new users to grasp how they can apply these tools.

That's just my opinion - I will continue to use Shiraz regardless, and I appreciate the work you have put in to all your plugins!

Mohammad Rahmani

unread,
Jun 14, 2021, 2:43:23 PM6/14/21
to tiddl...@googlegroups.com
Thank you Si,

No problem! your feedback is much appreciated!



Best wishes
Mohammad


On Mon, Jun 14, 2021 at 8:06 PM Si <si43...@gmail.com> wrote:
Hi Mohammed,

Sorry I didn't see this original reply so I only responded to your second comment!

>>> Maybe we can have a "sweat tweak" plugin ;-) to include such things?
>>> I think these are:
>>> - two column story river
>>> - colorful tabs
>>> - colorful view toolbars and hide/show on mouse hover

Yes I personally think that this would be better. The original Shiraz for "Macros for creating stylish content in TiddlyWiki", and a new plugin for "Theme tweaks" (e.g. light/dark mode, colorful sidebar tabs etc). I think that narrower categorisation will make it easier for new users to grasp how they can apply these tools.

That's just my opinion - I will continue to use Shiraz regardless, and I appreciate the work you have put in to all your plugins!

On Sunday, 6 June 2021 at 15:34:43 UTC+1 Mohammad wrote:
Reply all
Reply to author
Forward
0 new messages