docs: How to add new cascade and use it

[linonetwo]

No description provided.

[Jermolene]

Thank you @linonetwo – I am delighted at your willingness to tackle documentation tasks, and the standard of your contributions is very good.

[Jermolene]

It would be better to be self contained and transclude the shadow tiddler as a subtiddler from the core plugin. This will ensure that the real shadow is displayed even if it has been overridden.

[linonetwo]

This requires /dev doc site use prerelease of TW, will it be?

[linonetwo]

Or we merge this into master branch.

[Jermolene]

Hi @linonetwo yes it looks like this will need to be merged to "master"

[linonetwo]

@Jermolene There remains two concerns to discuss.

[Jermolene]

Hi @linonetwo are there any remaining concerns?

[linonetwo]

I don't know how to transclude subtiddler, there is a post https://talk.tiddlywiki.org/t/how-to-transclude-a-subtiddler-with-template-in-tiddlywiki/7100 , I tried the solution on it

<$transclude tiddler="$:/core" subtiddler="$:/core/ui/ViewTemplate/tags/default" template="$:/core/ui/ViewTemplate/body/code"/>

and it is not working.

---

I see, the syntax is correct, just can't use template. And the render result of it is empty string.

Use view widget instead. But it become plain text, don't have code style. Wrap with pre > code cause transclude fail.

[pmario]

Your code is wrong. The transclude-widget does not have a template parameter

If you use:

<$tiddler tiddler=HelloThere>
<$transclude $tiddler="$:/core" $subtiddler="$:/core/ui/ViewTemplate/tags/default" />
</$tiddler>

It works just fine at: https://tiddlywiki.com/prerelease/ see: prerelease

[pmario]

I think the added sentence does not make sense. -- At least I do not understand it.

[linonetwo]

Updated

[linonetwo]

<$tiddler tiddler=HelloThere>
<$transclude $tiddler="$:/core" $subtiddler="$:/core/ui/ViewTemplate/tags/default" />
</$tiddler>

Thanks, but this render a tag, instead of a codeblock. Jeremy want to transclude the raw tiddler content as codeblock here.

I leave a link to [[$:/core/ui/ViewTemplate/tags/default]] instead now.

[pmario]

<pre><$view tiddler="$:/core" subtiddler="$:/core/ui/ViewTemplate/tags/default" mode=block format=text/>
</pre>

[Jermolene]

Thanks @linonetwo. I am afraid that this hasn't turned out as well as I had hoped, and I am really struggling to follow it. I don't have time at the moment to edit it properly, but perhaps another English-speaking contributor may be prepared to help.

[Jermolene]

Hi @linonetwo sorry if that sounds harsh, I did start to work through some edits but I found it hard to track the intention in some areas. Here are my changes:

Partially completed edits

This guide shows you how to add a new [[cascade|https://tiddlywiki.com/#Cascades]] to the ~TiddlyWiki core or to your own plugins. This allows third-party plugins to extend the functionality of the core or your plugin.
!! Create a Control Panel Tab
To create a new tab under ControlPanel - Advanced - [[Cascade|$:/core/ui/ControlPanel/Cascades]].
title: $:/core/ui/ControlPanel/ViewTemplateTags
tags: $:/tags/ControlPanel/Cascades
caption: {{$:/language/ControlPanel/ViewTemplateTags/Caption}}

\define lingo-base() $:/language/ControlPanel/ViewTemplateTags/

<<lingo Hint>>

{{$:/tags/ViewTemplateTagsFilter||$:/snippets/ListTaggedCascade}}

It is important to add the related language files as follows:
title: $:/language/ControlPanel/

ViewTemplateTags/Caption: View Template Tags
ViewTemplateTags/Hint: This rule cascade is used by the default view template to dynamically choose the template for displaying the tags area of a tiddler.

!! Add Default Configuration
title: $:/config/ViewTemplateTagsFilters/
tags: $:/tags/ViewTemplateTagsFilter

default: [[$:/core/ui/ViewTemplate/tags/default]]

!! Use The New Cascade
This is a simplified example based on real-world use case. It provides a button to toggle the "EditMode" based on a state tiddler. It will show how the default template we created above can be overridden by a custom template.
!!! Your template
Add what you want to show conditionally, and update publisher/plugin-name to your own plugin name.
This template doesn't have anything directly related to the cascade mechanism we just created, but its title will be used later.
code-body: yes
title: $:/plugins/publisher/plugin-name/EditMode

\whitespace trim
<$reveal type="nomatch" stateTitle=<<folded-state>> text="hide" tag="div" retain="yes" animate="yes">
  <div class="tc-tags-wrapper" style="display:flex;">
    <$transclude tiddler="$:/core/ui/EditTemplate/tags"/>
    <$button class="tc-btn-invisible" style="margin-left:1em;">
      {{$:/core/images/done-button}}
      <$action-deletetiddler $tiddler={{{ [[$:/state/edit-view-mode-tags/]addsuffix<storyTiddler>] }}}/>
    </$button>
  </div>
</$reveal>

!!! The condition
Write a filter ends with the then[$:/plugins/publisher/plugin-name/EditMode].
code-body: yes
tags: $:/tags/ViewTemplateTagsFilter
title: $:/plugins/publisher/plugin-name/CascadeEditMode
list-before: $:/config/ViewTemplateTagsFilters/default

[[$:/state/edit-view-mode-tags/]addsuffix<currentTiddler>get[text]compare:string:eq[yes]then[$:/plugins/publisher/plugin-name/EditMode]]

!!! A button to trigger the condition
code-body: yes
tags: $:/tags/ViewTemplate/Tags
title: $:/plugins/publisher/plugin-name/TriggerEdit

\whitespace trim
<%if [<storyTiddler>get[tags]!is[blank]] %>
  <$button class="tc-btn-invisible" set={{{ [[$:/state/edit-view-mode-tags/]addsuffix<storyTiddler>] }}} setTo="yes" tooltip="add tags">
    {{$:/core/images/new-here-button}}
  </$button>
<%endif%>

[linonetwo]

Never mind, I'm also updating it. Please take your time review other PRs first.

[linonetwo]

@pmario Thanks, that works, I'm using it. And I update it to the forum https://talk.tiddlywiki.org/t/how-to-transclude-a-subtiddler-with-template-in-tiddlywiki/7100/5