Table of contents questions

1

Hi all, I am experimenting, and not getting anywhere, so I have a couple of questions.

  1. Is there a way to set up a viewtemplate tiddler so that if there are tiddlers tagged with the tiddler being viewed, the toc macro will appear under the tiddler content?

  2. In the toc macro, how does one sort first by caption, then by title if there is no caption?

2

  1. Something like this:

    title: TOC ViewTemplate
list-after: $:/core/ui/ViewTemplate/body
tags: $:/tags/ViewTemplate

<% if [<currentTiddler>tagging[]] %>

<div class="tc-table-of-contents">
  <hr/>
  <h2>Related Info</h2>
  <$transclude $variable="toc-selective-expandable" tag=<<currentTiddler>> />
</div>

<% endif %>

  2. Use sortsub

    <$let caption-then-title ="[{!!caption}] [{!!title}] +[join[]]">
<<toc "MyTag" "sortsub:string<caption-then-title>" >> 
</$let>

Update: replaced +[join[~]] with [join[]] in the above, as the tilde character was still showing up when the caption is empty. Other techniques are possible, but this seems simplest.

3

Thanks Scott! I will try that out today. And a few extra words to meet the minimum for a post here.

4

My setup isn’t a full TOC, but may be useful to you or others.

I have a ‘TaggingFooter’ (tagged with ViewTemplate) with the following:

<<tag>> is tagging
<<dlist-link "[tag{!!title}]" " | ">>
</small>

where dlist-link is defined as a macro thus:

<$list filter="$filter$ +[butlast[]]"><$link/>$delimiter$</$list>
<$list filter="$filter$ +[last[]]" emptyMessage="nothing"><$link/></$list>
\end

<!-- tuned for $:/_local/TaggingFooter (esp the emptyMessage)
original from https://talk.tiddlywiki.org/t/macro-produce-a-delimited-list/1266/3 -->

<!-- etymology: "dlist" for delimited list. and link for the list being links -->

The result is not an expandable TOC, and has no sorting, but it consumes minimal space which is often a goal of mine. (I have it left aligned at the bottom of the tiddler, sharing the same vertical space as the author (“subtitle”) and date to the right, via some further CSS hints

5

Just a question, how would I do #2 in connection with number one? Number one isn’t a toc macro, it is a transclude widget.

6

Thank you Nemo. How does it answer one or both of my questions? What is the value of this?

7

It displays (and links to) each of the tiddlers that are linked from the one being viewed - that (to my interpretation) was the core of your query. My setup doesn’t use the toc macro hence my disclaimers.

8

You can always think of the <<something "with" "some" "args">> syntax as a shortcut for

<$transclude $variable="something" param1="with" param2="some" param3="args" />

The shortcut is much nicer for many uses, but it’s less flexible, as you can only pass plain strings as arguments here. We need to pass <<currentTiddler>> so we’ll have to use the longer format.

This is how I would combine them:

<% if [<currentTiddler>tagging[]] %>
<$let caption-then-title ="[{!!caption}] [{!!title}] +[join[]]">

<div class="tc-table-of-contents">
  <hr/>
  <h2>Related Info</h2>
  <$transclude $variable="toc-selective-expandable" tag=<<currentTiddler>> sort="sortsub:string<caption-then-title>"/>
</div>

</$let>
<% endif %>

Obviously you would need to choose which TOC implementation you actually want. I usually choose toc-selective-expandable.

Here, with tiddlers like this:

title caption sort key
ABC “ABC”
Tiddler 1 Foo “FooTiddler 1”
Tiddler 2 Bar “BarTiddler 2”
Tiddler 3 Baz “BazTiddler 3”
Tiddler 4 “Tiddler 4”
Tiddler 5 Qux “QuxTiddler 5”

We would get this sort order:

  1. ABC
  2. Bar
  3. Baz
  4. Foo
  5. Qux
  6. Tiddler 4

I also made a mistake in the original (which I will edit right now) In the key, I joined fields to make the key with an actual character. (I used ~.) For technical reasons, that might cause problems when the caption is empty. So it’s updated to join on an empty string.

You can see this in action by downloading this and dragging the resulting file on any wiki:

CaptionThenTitle.json (1.6 KB)

If you open MyTag you will see the results above.

9

Thanks Scott for the detailed explanation! Blessings.