Yazd: a KISS collection of Tiddlywiki macros

[Mohammad]

Announcement: Yazd

Date: Mar 23rd, 2019

7th October 2019

• Release 0.5
  • updated to Tiddlywiki 5.1.21
  • added several new macros
  • wiki-wiki-todo macro

BTC is acknowledged for his very simple todo list solution. 

Announcement: Yazd

Date: Mar 23rd, 2019

23rd March 2019

• Release 0.2
  • New documentation style
  • added several new macros

Announcement: Yazd

Date: Mar 21st, 2019

Yazd is a KISS collection of Tiddlywiki macros. These are macros their script is less than 20 lines and simple in concept, modular and easy to use.

KISS principle

The KISS principle states that most systems work best if they are kept simple rather than made complicated; therefore, simplicity should be a key goal in design, and unnecessary complexity should be avoided. In this project KISS stands for Keep It Short and Simple.

• How Yazd works?
• How create and document macros

Code: https://github.com/tw-scripts/Yazd

Demo: https://tw-scripts.github.io/Yazd/

Please give your feedback, share your thoughts and resources if any!

I also highly welcome your contribution. 

Yazd is project in https://github.com/tw-scripts. So, if you have a GitHub account, and like to contribute I highly recommend to join.

Best

Mohammad

[S. S.]

I have no idea why 3 posts I made here have been auto deleted.
I was trying to show a different way of presenting the information.

[Mohammad]

Hello S.S.,

 I changed the layout as you proposed! One question:

Why you put the macro script at the middle?

--Mohammad

[Mohammad]

It is possible also to have the code inside a slider!

On Friday, March 22, 2019 at 11:08:44 AM UTC+4:30, S. S. wrote:

[S. S.]

Mohammad,

Sorry, I actually wrote out the full explanation of the changes 3 times, and all those posts were auto deleted.
So on the 4th post I was too frustrated to explain it all again.

I very much appreciate and like the idea you have come up with, as well as it's good presentation.

I am suggesting following a structure similar to tiddlywiki.com, specially the Core Macros documentation tiddlers.
Next is that the actual coding of the macro is only put into context once the the Purpose and Syntax are understood.
Thus it should make sense to first lay out the context of what is being done, then show how it is being done.

Also note that I changed: attribute :to: parameter - as I believe macros take parameters and not attributes.

I also added in the Reference header.

Good work!

Regards

[S. S.]

Mohammad,

I agree. It may be the right way to have not only the CODE but also the Revision & Reference in a reveal slider.
That way, all the most important information is presented openly, and those who want additional info (mostly coders I expect) can reveal those other parts.

Regards

On Friday, March 22, 2019 at 3:21:10 PM UTC+7, Mohammad wrote:

It is possible also to have the code inside a slider!

on.

[Mohammad]

Hi S.S.,

Thank you for your clarification!

I changed the layout and you will see the changes in the next update.

--Mohammad

[TonyM]

Great inititive mohammad.

I will contribute

Tony

[Mohammad]

New update

 

Announcement: Yazd

Date: Mar 23rd, 2019

23rd March 2019

• Release 0.2
  • New documentation style
  • added several new macros

Code: https://github.com/tw-scripts/Yazd

Demo: https://tw-scripts.github.io/Yazd/

Best

Mohammad 

[Mohammad]

Announcement: Yazd

Date: Mar 23rd, 2019

7th October 2019

• Release 0.5
  • updated to Tiddlywiki 5.1.21
  • added several new macros
  • wiki-wiki-todo macro

BTC is acknowledged for his very simple todo list solution. 

Code: https://github.com/tw-scripts/Yazd

Demo: https://tw-scripts.github.io/Yazd/

--Mohammad

[Sebastian Ovide]

thanks Mohammad. I absolutely will use the slider !

[Riz]

This is a good collection! You should submit it to community part of tiddlywiki. I would have done it myself but I am in a bit of stay-away-from-github phase. I have posted about it in reddit.

sincerely,

Riz

[David Gifford]

Mohammad, thank you for the Yazd plugin with so many goodies.

I apologize that I missed this in March when you released it. I must have thought it was an update to Shiraz. Or vice versa. I always confuse "Iranian cities with 'az' at the end." Anyway, I am making up for it by adding each macro individually to the toolmap. I am adding (Yazd) to each. Blessings.

Also a minor correction: please remove one 'm' from 'docummenting' in the docit macro.

[Mohammad]

Hi David,

 Thank you!

I will also check the typo! I appreciate to inform me if you find any other issues.

--Mohammad

[Mohammad]

Hi Riz,

 I have put this repo on https://github.com/tw-scripts/Yazd which is an GitHub organization lets other people simply involve.

 I know may Tiddliwikian have collection of macros. Here I tried to explain each and try to document them in a such way usable for others

 Some of macros are no deprecated like linkto! TW 5.1.21 has a better $link widget and cover what linkto do! I need to have some free time

 to revise and announce it to Tiddlywiki communiy!

Thank you for posting it to Reddit. I welcome any suggestion and more important any contribution.

Best regards

Mohammad

[Mohammad]

On Tuesday, October 8, 2019 at 3:14:56 PM UTC+3:30, David Gifford wrote:

Mohammad, thank you for the Yazd plugin with so many goodies.

I apologize that I missed this in March when you released it. I must have thought it was an update to Shiraz. Or vice versa. I always confuse "Iranian cities with 'az' at the end." Anyway, I am making up for it by adding each macro individually to the toolmap. I am adding (Yazd) to each. Blessings.

David

This is Yazd: https://en.wikipedia.org/wiki/Yazd

Since 2017, the historical city of Yazd is recognized as a World Heritage Site by UNESCO.[6]

and this is Shiraz: https://en.wikipedia.org/wiki/Shiraz

Shiraz is known as the city of poets, literature, wine, and flowers.^[6][7]

Both worth a visit! also their plugins :-)

Cheers

Mohammad

[David Gifford]

The photos on Wikipedia and Google images for Shiraz are beautiful. Yazd looks a little dry and spartan for my tastes, but still looks nice. Not sure Iran would extend a tourist visa to someone in my profession, but if I had the money, I would definitely enjoy sightseeing there! And yes, the plugins are DEFINITELY worth the visit!

[Mohammad]

I hope sometimes you could visit those great and ancient cities!

Cheers

Mohammad

[Birthe C]

HI Mohammad,

Thank you for describing and linking ....lovely and interesting. Tiddlywiki comes around ;-). I would really like to see it real life, but looking at the temperatures there, I do not need to feel sorry for not having the money for it...(remember I am from the north (Denmark).

Now we know some of your inspiration for your beautiful and very useful wikies.

Birthe

[Mohammad]

Hi Birthe,

 I am happy you found it useful!

I hope I could find time to improve Yazd!

Cheers

Mohammad