Since your question seems to be mainly about documenting macros, why not
put your macro definitions in a data tiddler. Then as you edit, if you need
a reminder just type
{{macs##mymacro1}}
and see something like
mymacro1(size of tiddler, name of field)
over in the preview window.
Putting all the definitions in one place also has the advantage that you
can quickly test at any time to make sure you're not accidentally creating
a tiddler with the same name as an existing one.
On Sunday, May 3, 2020 at 3:21:56 AM UTC-7, TonyM wrote:
>
> Folks,
>
> This Question is for the more advanced TiddlyWiki user.
>
> *The Many Macros Question - design and performance*
>
> I am hard at work on a large wiki with many macros driving its operation.
> As I hope to generalise my code I am calling for any advice on your
> practices with managing lots of macros.
>
> Background
>
> - I have a number macro tiddlers containing a couple of dozen macro
> definitions each.
> - I also document each macro in a field on the tiddler macro-macroname
> with the field value containing the syntax
> - When I need to review a macro its easy to find the tiddler its in,
> but it is hard work locating the definition within the tiddler, especially
> in edit, and when I have similar names, a search is slow too.
> - You have to be careful because a key stroke in the wrong place in
> macro definitions will break things
>
> I am thinking of doing something like as follows; but not sure if it will
> add unnecessary overheads/performance;
>
> - I could excise every macro to its own tiddler and tag that
> with $:/tags/Macro
> - This will give more opportunities to document the macro, add
> keywords
> - If one macro depends on another it could make things harder to
> troubleshoot
> - Can tiddlywiki cope with hundreds of $:/tags/Macro tiddlers?
> - I could bundle some macros together to reduce the number of tiddlers
> but does this help anyway?
> - Unfortunately I started this design before the recent versions that
> introduced SystemTag: $:/tags/Macro/View
> - even then I am not sure how to divide my macros between view and
> global as they are often but not always both
> - In future wikis how can I use this opportunity to use
> $:/tags/Macro/View vs $:/tags/Macro
> - Using import variables in appropriate places may allow me to
> selectively include a set of macros in different places.
> - How best will I divide my macros between macro tiddlers this way?
> - But where are the best places to import variables (not in the
> currentTiddler)
> - Over lapping import variables are not a problem if its in a good
> cause, but they could make performance impacts.
> - Would conditional transcluding or using view templates to choose
> when to transclude or import macros at appropriate times help?
> - Does tiddlywiki's native indexing lend a hand in any of the above
> cases to improve performance?
>
>
> I hope to generate some helpful guidelines from what I learn here.
>
> Thanks in advance
> Tony
>
--
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 view this discussion on the web visit
https://groups.google.com/d/msgid/tiddlywiki/855f4b0d-aaac-45ce-9960-0914a34d21af%40googlegroups.com.
