Shiraz 3.0: Plan for the Next Major Release

Plugins
#1

Shiraz is among the common plugin in Tiddlywiki community. It is a small fraework and extends Tiddlywiki features by employing Bootstrap CSS framework and many macros for tables, images, cards, alerts, …

The next major release of Shiraz contains

  • Modular add-ons
  • Bootstrap 5.2.2 (the latest)
  • Improved modules (tables, images, cards, alerts, badges, buttons, accordions,…)

Report bugs

I would appreciate if you kindly report here any bug and issue or requested feature based on working Shiraz 2.5.6.

NOTE

Please note that, I am keen to keep Shiraz as an integrated framework. Breaking down it to several independent plugins can cause maintenance difficult, and time consuming! But I am going to create some subplugins where it is possible.

5 Likes
#2

I have one suggestion. Add transclusion backlinks support to node-explorer in Shiraz.

I noticed that the node explorer in Mehregan does it. And I copied the relevant code from there into my wiki.

Mehregan currently does not show tranclusion links though.

Or if you are open to the idea, I can open a PR that shows transclusion back and forward links. (Fingers crossed that my TiddlyWiki-fu will not fail me).

#3

I am not sure whether you are interested in making dynamic tables a seperate add on to the Shiraz. But tiddlywiki definitely needs an actively maintained advanced dynamic table. I know of the tiddlytables and I use it extensively in my budget wiki. But it’s no longer actively maintened. We can’t blame the creator of that since he might be lacking enough time to update it. Till now it hasn’t shown any bugs. But I am interested in a few more features in it. So I don’t know how long I can keep on using it. So in case you are making Shiraz dynamic table a seperate add on, I will present my feature requests.

#4

Shiraz 2.5.6 has already this feature!

Mehregan shows links to tiddlers transclude the currentTiddler (may be this back-transclusion similar to backlinks), the reverse is not implemented! I mean displaying what has been transcluded in the currentTiddler! Do you want this?

1 Like
#5

Dynamic table in current state is really complex! I tried to keep it modular to be able to address reported bugs!
I believe if a volunteer with JS knowledge implements a dynamic table plugin, it would be much more simpler and faster than what I or Alan Aldrich have implemented using WikiText!

I have got already some requests like multi-columns sort, but these are really complex in WikiText!

My main purpose in updating Shiraz to Release 3.0 is

  • update bootstrap classes to 5.2.2
  • support for dark themes (right now most colorful components has color issue in dark mode)
  • use CSS variables to simplify styling
  • integrate my previous works like vertical tabs, grid templates, image gallery, sliders, … into Shiraz
  • address issues
2 Likes
#6

Ah! I need to update.

That would be cool. This would complete the “transclusion link types.”

#7

You are welcome to submit a PR if you like!

2 Likes
#8

Cherry-picked from Shiraz 3.0.0: Breadcrumb

image
image875×457 29 KB

Shiraz 3.0.0 has a view template to show breadcrumbs on demand. Just turn it on!

5 Likes
#9

Cherry-picked from Shiraz 3.0.0: Bubble Notification

image
image873×601 27.8 KB

Shiraz 3.0.0 has Bootstrap classes and Tiddlywiki macros to show bubble notification. They are dynamic.

7 Likes
#10

Cherry-picked from Shiraz 3.0.0: Card Group

image
image868×921 163 KB

Shiraz 3.0.0 has Bootstrap classes and Tiddlywiki macros to show cards in columns in a simpler way.

image
image870×995 189 KB

7 Likes
#11

The cards work really well with Swiffy Slider too.

1 Like
#12

Sgiraz 3.0 has all Bootstrap 5 alerts.

2 Likes
#13

Shiraz 3.0 admonitions.

A callout sub plugin which implements the MkDocs admonitions. The MkDocs is popular for creating professional static site.

Static callout

Acts like alerts in Shiraz, they are colorful sections.

image
image614×665 18.9 KB

Collapsible callout

These forms use the html5 details tag! So they work when tiddler exported as static html.

789_msedge

NOTE i: Both of these forms work when tiddler is exported as static page. So, you have the callout in your TiddlyWiki and when you make a static page.

NOTE ii: The new callouts support dark palettes in Tiddlywiki

9 Likes
#14

Really looking forward to this! Any chance Shiraz 3 is releasing soon? :slight_smile:

-Springer

1 Like
#15

I am waiting for TW 5.3.0 release. I hope I can have some beta along with TW 5.3.0 more stable prerelease.

1 Like
#16

Shiraz Callout of Shiraz 3.0 is published as a release candidate with Shiraz 2.7.2

For code and demo see: Shiraz Plugin Update 2.5.4 - 2.7.2 - #11 by Mohammad

#17

A little update
Shiraz is a very rich plugin with many macros, styles, templates, … so, updating it to TW 5.3.x is a lengthy and tedious process.

Now, Shiraz 3 will be updated to Bootstrap 5.3.3 and will split into smaller sub plugins.
Tables (dynamic and quick tables) are written using the new TW 5.3.x paradigm. Macros are replaced with procedures; text substitutions are removed, and functions are employed whenever is possible.
Many $list and $reveal which were used for conditional statements are replaced with <%if ... %>
The code is much simpler now.
I hope I can push final release in summertime.

10 Likes
#18

Shiraz 3.0.0 Release Candidate has been published to GitHub.
It is a release under new branch (Shiraz 3.0.0). It is only for test and review/comments.
It is not distributed in Kookma Plugin Library, nor in CPL.

To give a try

Documentation will gradually be updated.

Important Changes

  • Shiraz 3 requires TiddlyWiki 5.3.5
  • Shiraz 3 is based on Bootstrap 5.3.3
  • It partially supports dark mode (same as Bootstrap)
  • It supports Settings to on/off some visual features
  • Breadcrumbs work using StoryList and HistoryList

Dynamic Tables

  • Dynamic tables were rewritten from scratch
  • Dynamic tables are now more performant, and the code is much easier to hack
  • Functions, procedures, parametrized transclusion is used as much as possible

Shiraz 3 is not fully backward compatible. Don’t Upgrade your TiddlyWiki with Shiraz 2.

Please do not use Shiraz 3 for any important TiddlyWiki with your valuable data. Only use it for experimentation and evaluation.

7 Likes
#19

I’m excited that there’s an upgrade that takes advantage of powerful and efficient new recent features of TiddlyWiki… and yet I’m also a bit concerned about this lack of backwards compatibility.

Will there be something like an upgrade path for projects that use Shiraz 2.x? I’ve invested a great deal in developing shiraz-based elements over the years, and it would be quite difficult to reconstruct everything from scratch. For this reason alone, I might not actually upgrade, despite being one of your biggest fans. :slight_smile:

Will you at least (at some point once you’re past RC stage) be able to spell out which specific details cause backward-compatibility issues, so that it’s easier to troubleshoot conversion — without having to completely re-create every view template that uses dynamic tables, etc.?

1 Like
#20

Sure, I will. I will also put a list of dropped features and new one!

I assume you have mainly used dynamic tables, quick tables, alerts, callouts, cards, images, …
These are backward compatible.

3 Likes