kookma / tw-shiraz

Shiraz is a small Tiddlywiki 5 plugin contains macros, stylesheets, templates, snippets, images, static tables, dynamic tables and acts as a starter kit.

Shiraz

Shiraz is a small TW5 plugin contains several macros, stylesheets, templates, snippets and acts as a starter kit for Tiddlywiki.

Tutorial

• Open the https://kookma.github.io/TW-Shiraz/
• Go to tutorial and see a demo of most features

Installation

For dtails on how install Shiraz plugin in your wiki, have a look at https://kookma.github.io/TW-Shiraz/#Install

Shiraz subplugins

Subplugins are addons extend the Shiraz features or simplify the use of Shiraz. These subplugins are available from shiraz GitHub repo (https://github.com/kookma/TW-Shiraz)

• Formatter adds text formating and snippets to Shiraz see: https://kookma.github.io/TW-Shiraz/shiraz-formatter.html
• Callout adds admonitions (also called callout) to Shiraz see: https://kookma.github.io/TW-Shiraz/shiraz-callout.html

tw-shiraz's Issues

[dynamic table][contrebution] only show expand arrow if text is not empty

I have modified the $:/plugins/kookma/shiraz/templates/dtable-body/tbl-expand so the buttons only show if the text field is not empty

I think this is better because you know at a glance where there is content to look at.

<$reveal type="nomatch" state=<<currentRecord>> text="">{{$:/core/images/right-arrow}}</$reveal>

$__plugins_kookma_shiraz_templates_dtable-body_tbl-expand.txt

[SOLVED] Transposed tables

SOLVED

I was wondering if it is possible to have an enhancement on tables and dynamic-tables whereby Columns and rows are interchanged. I checked on stackoverflow and it is possible to do it using just css as per this post so I tried to give it a go but it only works partially.

I am assuming it is perhaps down to something minor but I am not knowledgable enough to work out what. Would you be able to either include it as a style or perhaps provide some guidance on this please?

shiraz demo is down

I need documentation :(

hope to see it again soon :)

[Feature Request] Provide Snippets

Hi Mohammad, I have been using your great plugins for a while, they help me a lot both in my public and private wikis!

I found one thing that may have a huge positive impact on your plugin libraries: Would you consider adding snippets to your plugin?

For example, this is the one added by myself into my wiki:

Then I can use your dynamic table more easily, without the need to open the document site and copy the code.

Your document site is beautiful and very clear, but I think for the most case, the API of your macro is clear enough, so we might not need to read the document, and can just figure out how to use these macros by looking at the fields.

So it will be much convenient if you bundle some snippets alongside with your plugins!

---

P.S. Gk0Wk is creating a code mirror plugin that will list tiddlers with $:/tags/TextEditor/Snippet tag, if the user types / in the editor. It will feel just like how notion and other modern note app works.
(base framework is in https://github.com/Gk0Wk/TW5-CodeMirror-Enhanced , he is working on snippet feature today, not complete yet)

Config tiddler for light & dark palette

I was typing here, but I made it a forum post instead https://talk.tiddlywiki.org/t/config-for-light-dark-palette-e-g-palette-dark/8071 because I think the config tiddler name may need some consensus.

ControlPanel/Settings wrong tag. not in controlpanel

$:/plugins/kookma/shiraz/ui/ControlPanel/Settings

shuld have the tag $:/tags/ControlPanel/Settings not $:/tags/ControlPanel/SettingsTab

Double click on table cell to edit that cell.

I used to use DynamicTables, it can edit single cell by db-click.

Can you add that to DynamicTables in the Shiraz?

DatePicker, Dates and Timezones.

I'm having an issue with using the Task Manager example, with due-dates and the dates provided by the date picker, and likely time representation in TiddlyWiki itself.

To start with, I have had issues in the past with using dates in TiddlyWiki without a timestamp. There are times of the day where the dates are off by a day. The solution to this was to always include the timestamp 12:00:00 in any date storage.

Using the Task Manager example, I created a new task with a due date for today (2022-02-01). TiddlyWiki is now showing it as 2022-01-31 and my filter based on date doesn't show it at all. This includes in the date picker as well as the due-date list in the dynamic table.

If I set the due date to tomorrow (2022-02-02), the dynamic table shows the due date as today.

I think the resolution much like my other date issues in TiddlyWiki is that the timestamp for 12:00:00 is required. I don't know however how to make the date picker understand that the timestamp is there, and to supply it when setting the date.

shiraz-callout supports multiple lines

Shiraz-callout doesn’t seem to support multiple lines of text.

<<callout type:"note" title:"Beta vault - contributions are welcome!" src:" This sandbox vault is in beta!
 
 If you spot a typo or a mistake, feel free to submit a pull request [here](https://github.com/obsidianmd/obsidian-docs/tree/master/Sandbox).
">>

https://tiddly-gittly.github.io/tidgi-obsidian-manager/#%CE%BB%3A%2FObsidian%20Sandbox%2FStart%20Here

Allow DTable store field in tiddler instead of JSON

Now DTable will create a JSON just to store color info.
And despite my table and tiddlers are store in a private folder using FileSystemPath, this JSON still created in the default folder, resulted in a leak of privacy...

Can DTable store this info in the checked todo tiddler itself, or allow me to auto-assign a Tag to JSON tiddler, so it can be detected by FileSystemPath and get stored in a private folder?

tbl-expand doesn't work for tiddlers which have '/' in their titles

Hi,
I'd like to report an issue.

The issue is using a dynamic table of Shiraz, and if there are tiddlers which have '/' in their titles, then these titles couldn't be expand by clicking the special column "tbl-expand".

For example, if a tiddler's title is "Foobar", then "tbl-expand" works. If I change this tiddler's title to "Foobar/", then "tbl-expand" stop working on it.

URL in readme plugin

Hi Mohammad,

There is a mistake in $:/plugins/kookma/shiraz/readme with URL :

https://kookma.github.io/Shiraz/ which is 404

Because it's now https://github.com/kookma/TW-Shiraz/

Cheers,
Sylvain

[IDEA] add the list-pages features to list-search macro

On the GG Eskha proposed:

Indeed when using the list-search macro, the filter option is different from the text input.
You define the filter in the macro-call, for instance "[tag[Definitions]]" (or use default filter "[tags[]]").
Then, the text you write into the text input narrow down the search to the filtered titles matching the text input.
For instance (on Tiddlywiki.com) with the filter option "[tag[Definitions]]" and the text "URI", you would only see two elements in the list: Data URI and URI.
In your use-case, the text input is replacing the filter option.

For other, I add a link to your well explained "demo/list-search-macro" tiddler:
Shiraz 2.1.2 — extended markups: styles, macros, images, tables (kookma.github.io)

To summarize, what would be my "ideal" behavior would be that an optional "entries-per-page" attribute exists in list-search!

Dynamic table shows " Delete all 232 records? " on sidebar

On my wiki https://wiki.onetwo.ren/#%E4%BE%A7%E8%BE%B9%E6%A0%8F%E6%83%B3%E6%B3%95%E5%88%97%E8%A1%A8:%E4%BE%A7%E8%BE%B9%E6%A0%8F%E6%83%B3%E6%B3%95%E5%88%97%E8%A1%A8%20Index

(This wiki is readonly, the source note is at https://github.com/linonetwo/wiki/blob/62232058e9659e32b1846fa340253af1be443318/tiddlers/%E4%BE%A7%E8%BE%B9%E6%A0%8F%E6%83%B3%E6%B3%95%E5%88%97%E8%A1%A8.tid#L12 )

This is strange.

(also, I was unable to sort it by Created field, using macro parameter, maybe same as #36 )

Expand stylesheets to cover th header cells

The macros in $:/plugins/.mr/shiraz/stylesheet/tables style only header cells tagged with thead > td, e.g.,

.thead-orange thead td{background-color: #FFA500; color: #ffffff;}

This is perfectly correct for the output from TW tables using header rows, e.g.,

| Header 1 |  Header 2 |h

I, however, wrote a macro which generated tables with header cells tagged with thead > th. When I attempted to style them with Shiraz stylesheets, the headers did not style correctly. I fixed the problem by altering the macro to use td tags for header cells.

If you extend your stylesheets to also support header cells which use th tags, it will improve the usability of your plugin for those producing tables from custom macros.

If you're okay with this change, I'm willing to do a pull request to implement it.

WikiText in dynamic table

Seems WikiText is not passed in the macro table-dynamic.

Step to reproduce this error.

In the https://kookma.github.io/TW-Shiraz/, create a new Tiddler with contents below (text field add).

<<table-dynamic filter:"[tag[sample]]" fields:"title text email created tags" stateTiddler:"exmp01" caption:"''Table 1. Dynamic table example''">>

It renders as below.

The column Text is not rendered.

What does stateTiddler mean?

I read through dynamic table examples, seems it is not used.

For example:

<$macrocall $name=table-dynamic filter="[tag[data]]" indexes="tbl-checkbox tbl-expand title name midterm homework final" stateTiddler="Houri" class="thead-dark" sortOp="sortan"/>

I search for Houri but not found a tiddler named this.

So is stateTiddler necessary?

Using another macro output as input for Shinraz plugin input

Hi I'm staring to learn Tiddlywiki. I have found your plugin and love it so far
Here I take one of your example and I want to display it in table

\define theme() primary secondary success warning danger info light dark

<table>
	<$list filter="[enlist<theme>]" variable=__curtheme__>
	<tr>
		<td><<__curtheme__>></td>
		<td><<badge type:"<<__curtheme__>>" src:"<<__curtheme__>> badge">></td>
	</tr>
	</$list>
</table>

When paste it to Tiddlywiki, you can see that only the text of badge is render, the badge itself isn't however.
Can you tell me this is because of Tiddlywiki mechanic, the plugin or my code wasn't proper.

Thank you very much!

[Feature Request] Clickable image card

https://www.craft.do/

This card is a clickable link to another page, which is very attractive and beautiful, can card macro in shiraz combine with something to make this effect?

link overrideClass

Hi Team,

I just install TW-Shiraz on my TW and some macros won't work.

For example:

<$link overrideClass="btn btn-secondary btn-sm" to="https://google.com">Google</$link>

TW-Shiraz: I see a button.

My TW: I see just text: Google.

What should I do to fix it?

Thank you in advance!

Suggestion: Package the Tutorial for easy import

Hey Mohammad! Thanks again for your great plugin! I was trying to easily drag over the entire tutorial into my own wiki, so I can: 1. refer it when I dont have internet in the future, 2. maybe even extend/edit it as I continue to learn/understand/etc.

To accomplish this right now, I'd have to filter by: [tag[demo]!tag[advanced]] and then import all of them, and then tag all of with Shiraz and Documentation, etc. etc.

So to be clear - it is currently possible and relatively straight forward. I was just thinking it could be made a bit easier by either: 1. packaging the docs directly with the plugin like Nico does for Projectify (discussing this idea in GG right now) or 2. Adding a single tag pill I can easily just grab to drag/drop over.

Thanks again!