Find macro application: List all macros in a wiki

[Mohammad]

Referring to Find macro announcement (https://groups.google.com/d/msg/tiddlywiki/I-tJ-ITpfi4/VhrgQ2xcGgAJ)

I would like to introduce some application of this incredible macro here.

Display macros as separate block

Concept

Macros in Tiddlywiki are stored in tiddlers tagged with $:/tags/Macro and their contents are hidden. For documentation purpose it is desired to show macros in separate blocks with macro name as heading and content wrapped into <pre> tag.

Using find with delimiters begin="\define" and end="\end" can extract macros from any tiddler. When a macro is extracted a second find run on the result with start=" " and end="(" can extract the macro name.

Usage

In any tiddler contains macros, put the below script

!! Macro
<<<
<<show-macro>>
<<<

Limitation

The show-macro works based on delimiters. If macro is defined as a single line (with no \end delimiter) the macro may fail.

Install

Drag and drop the below macros into your wiki

• macro/find
• macro/show-macro

 

Code: https://github.com/kookma/find-macro

Demo: https://kookma.github.io/find-macro/

[Mohammad]

Case II

How to list all macros in a wiki?

his example shows how the shod-macro macro can be used to display macros inside a filtered list of tiddlers.

• Example

List all macros in first three tiddlers tagged with $:/tags/Macro

 copy to clipboard

<$list filter="[tag[$:/tags/Macro]limit[3]]">
<li><$link to=<<currentTiddler>>> <$text text=<<currentTiddler>> /></$link></li>
<blockquote>
<<show-macro>>
</blockquote>
</$list>

That renders as:

• .mr/macro/dbadge

 DBADGE

\define dbadge(subject,status, type:"primary")
<div class="dbadge"><span class="dbadge-subject">$subject$</span><span class="dbadge-status dbadge-$type$ ">$status$</span></div>
\end

• $:/plugins/.mr/shiraz/macro/alerts

 ALERT

\define alert(type:"primary" text:"", width:"100%", class:"")
<div class="alert alert-$type$ $class$" style="width:$width$;">
$text$
</div>
\end

 ALERT-LEFTBAR

\define alert-leftbar(type:"primary" text:"", width:"100%")
<div class="alert bg-transparent leftbar border-$type$" style="width:$width$;">
$text$
</div>
\end

• $:/plugins/.mr/shiraz/macro/wikitext-macros

 WIKITEXT-EXAMPLE

\define wikitext-example(src)
<div class="doc-example">

<$macrocall $name="copy-to-clipboard-above-right" src=<<__src__>>/>

```
$src$
```

That renders as:

$src$
\end

 WIKITEXT-EXAMPLE-WITHOUT-HTML

\define wikitext-example-without-html(src)
<div class="doc-example">

<$macrocall $name="copy-to-clipboard-above-right" src=<<__src__>>/>

```
$src$
```

That renders as:

$src$
</div>
\end

Code: https://github.com/kookma/find-macro

Demo: https://kookma.github.io/find-macro/

Best 

Mohammad

[Mohammad]

Try this on tiddlywiki.com and see the interesting results!

--Mohammad

Demo:  file:///G:/TW/TW-Findmacro/Find%20macro.html#Example%2001%3A%20List%20Macros%20from%20Tiddlers

Best 

Mohammad

[Birthe C]

Hi Mohammad,

Do you have a working link for this?

Birthe

[Mohammad]

Hi Birthe,

 Check it here:

Code: https://github.com/kookma/find-macro

Demo: https://kookma.github.io/find-macro/

Sorry for incorrect link. I modify the original posts. You can check this also on Tiddlywiki.ocm

--Mohammad

[Mohammad]

For those receive posts through email. I corrected the links as below

Code: https://github.com/kookma/find-macro

Demo: https://kookma.github.io/find-macro/

Best

 Mohammad

[TonyM]

Mohammad,

nice example of using access to macros such that they are somewhat self documenting.

As suggested by me previously I think it would still be valuable to develop a convention to create a fied macro-macroname containing the syntax and descriptor of any macro in a given tiddler. We could then combine these to give a full description of any macro.

However rather than in line in wiki text an editor toolbar item with a dialogue that searches for macronames and displays the macro content with an option to past into wikitext or clipboard would realy help desiging.

I am happy to help build the editor toolbar item.

Regards
Tony

[Mohammad]

Hi Tony
Good suggestion. Here I want to show the capability of find macro. I have started another project to create a TW resource for useful macros. I will share my idea in another thread to announce it and I would be happy to collaborate on that.
By the way, we may need more efficient search and paste then.

Many thanks for your feedback and your idea.

Best
Mohammad

[@TiddlyTweeter]

Mohammad

I like your approach very much.

FYI---very helpful for people who are not particularly interested in coding but do need to understand basics.

It has helped me understand macros can be quite easy for basic things.

They are actually Very Good Learning Materials, as well as adding to utility.

Many thanks

Josiah

[Mohammad]

Many thanks Josiah!

I hope I can improve this app to be more useful.

--Mohammad