See my announcement of YAZD project here https://groups.google.com/d/msg/tiddlywiki/1btgb6dmiBU/-L1nllP5AgAJ
I proposed a coding practice here. I also noted the recent efforts by S.S. on documentation here: https://tiddlywiki.com/prerelease/#Improving%20TiddlyWiki%20Documentation I appreciate to give me your feedback and share your thoughts *Initial draft* How to create and document a macro in Yazd collection? Start - from right sidebar, List of Macros, click on New macro button - fill in the required fileds as recommended below Macro name - use semantic name - all in lower case - single word recommended - if multi words is used, connect them using a dash - - example: print-items Macro parameters - parameters all have an initial value - single word parameter name is recommended - multi words parameter shall be used in camel case form - example: saveTiddler Macro tiddler - each macro is stored in a separate tiddler - a macro can have several sub-macros. These are helper macros used by main macro - tiddler tiltle is in lower case and has a macro prefix as macro/name - example: macro/timer - tiddler tagged with yazd and $:/tags/Macro - tiddler has the following fields - *description* [required]: one line description including keywords - *syntax* [required]: a one line text shows how call the macro with its all parameters - *author* [optional]: the name of developer - *url* [optional]: the possible page Stylesheet and Viewtemplate - a macro can have dedicated CSS. These css are stored in a tiddler as below - tiddler name stalysheet/macro-name - tagged with $:/tags/Stylesheet and yazd - a macro can have dedicated viewtemplate. It is stored in a tiddler as below - tiddler name viewtemplate/macro-name - tagged with $:/tags/Viewtemplate and yazd Documentation - documentation is placed inside the macro tiddler, after macro definition - a template has been provided, fllow it - in calling macro use named parameters - example: <<mymacro p1:"hello">> Extra examples - for more examples create a tiddler named doc/macro-name - follow the same instruction for documentation as described in the macro definition template Links: 1. Coding practice: https://tw-scripts.github.io/Yazd/#Coding%20Practice 2. Macro summary: https://tw-scripts.github.io/Yazd/#Macro%20Summary @TonyM Regarding having snippets in editor toolbar or having one extra button to insert the macro calls, I would be happy to have your plan. Best regards 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 [email protected]. To post to this group, send email to [email protected]. Visit this group at https://groups.google.com/group/tiddlywiki. To view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywiki/889e93ea-7344-4ce7-83c8-454bcafde16d%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
