soo_toc table of contents generator

Destry · 2020-12-23 20:13:58

Hi Jeff! Nice to see you around. I’ve been using the plugin so long a certain way, I guess I started assuming that was the only way. Never mind me. Everything I need is there. /goes back to dunce corner /

jsoo · 2020-12-23 20:36:03

Well, I’ll join you there. What I said above about the limit attribute isn’t quite correct; it will match the actual h-tag number. I’ve corrected my example in my last post above.

Destry · 2020-12-25 14:23:51

Merry xmas, everyone. I’m sitting around at the in-laws doing squat so, you know, ironing out web problems.

This is to anyone, but I suspect it’s a situation with how the plugin works. Not being a dev, I can’t say. This is only local dev for the time being, but…

I’ve managed to refactor my CSS so that soo_toc now powers both the ordered and unordered contents lists; e.g. my policies page using <txp:soo_toc wraptag="ol" />, and any ‘default style’ contents lists elsewhere using the plugin’s default ul (no wraptag needing declared).

My contents lists are all marked up consistently within a section element like this:

<section id="contents">
  <hr class="startrule">
  <h2>Contents</h2>
  <txp:soo_toc  />
  <hr class="endrule">
</section>

That works and looks as designed when the markup is added to the top of the body field.

Naturally, I want to minimize that eyesore by using an easier to remember shortcode instead (called contents). The one I showed before without the wraptag="" attribute incorporated works fine, rendering output as expected.

But as I just discovered, if I add the wraptag attribute to the shortcode to account for all list type situations in my newly refactored CSS:

<section id="contents">
  <hr class="startrule">
  <h2<txp:if_article_id id="3"> class="nosync"</txp:if_article_id>>Contents</h2>

  <txp:soo_toc level='<txp:if_yield name="levels"><txp:yield name="levels" /></txp:if_yield>' 
               wraptag='<txp:if_yield name="wrap"><txp:yield name="wrap" /></txp:if_yield>' />

  <hr class="endrule">
</section>

…the shortcode won’t work.

That is, if I declare ol (<txp::contents wraptag="ol" levels="4" />), the ol elements wraps the entire section block:

<ol>
<section id="contents">
  <hr class="startrule">
  <h2>Contents</h2>
  <li><a href="#idselector">Heading</a></li>
  <li><a href="#contents">Contents Items</a></li>
  <li><a href="#contents-l1">Test h3</a></li>
  <li><a href="#contents-l2-1">Test h4</a></li>
  <li><a href="#contents-l2-2">Test h4</a></li>
  <li><a href="#table">Table Tester</a></li>
  <li><a href="#form">Form Tester</a></li>
  <hr class="endrule">
</section>
</ol>

If I leave out that attribute to use a default ul list (<txp::contents levels="3" />), no ul elements is added at all:

<section id="contents">
  <hr class="startrule">
  <h2>Contents</h2>
  <li><a href="#idselector">Heading</a></li>
  <li><a href="#contents">Contents Items</a></li>
  <li><a href="#contents-l1">Test h3</a></li>
  <li><a href="#contents-l2-1">Test h4</a></li>
  <li><a href="#contents-l2-2">Test h4</a></li>
  <li><a href="#table">Table Tester</a></li>
  <li><a href="#form">Form Tester</a></li>
  <hr class="endrule">
</section>

How to fix?

Last edited by Destry (2020-12-25 14:31:27)

colak · 2020-12-25 16:07:28

Hi Destry,
Did you try using the labeltag and label attributes? I also sightly amended your yields.

<section id="contents">
  <hr class="startrule">
  <txp:soo_toc <txp:if_yield name="levels">level='<txp:yield name="levels" />'</txp:if_yield> 
               <txp:if_yield name="wrap">wraptag='<txp:yield name="wrap" />'</txp:if_yield>
               label="Contents"
               labeltag="h2"
 />
  <hr class="endrule">
</section>

Bloke · 2020-12-25 16:27:36

Slightly confused. Your short code yield is looking for the wrap attribute but you’re passing in wraptag. Might this work better? …

<txp::contents wrap="ol" levels="4" />

colak · 2020-12-25 16:35:09

Bloke wrote #327854:

Slightly confused. Your short code yield is looking for the wrap attribute but you’re passing in wraptag. Might this work better? …

I took it that Destry used a shorthand for wraptag in his yield name.

jsoo · 2020-12-25 16:37:04

I’ll have to think about this one a bit. Currently, if soo_toc has a wraptag other than ul (the default) or ol, it returns a simple (i.e., non-nested) listing of all h# elements, using the wraptag and break as usual for Txp. So that’s what’s happening here.

So maybe a quick-and-dirty solution would be something like this:

<section id="contents">
  <hr class="startrule">
  <h2<txp:if_article_id id="3"> class="nosync"</txp:if_article_id>>Contents</h2>

  <txp:if_yield name="wrap"><txp:yield name="wrap" />
    <txp:soo_toc level='<txp:if_yield name="levels"><txp:yield name="levels" /></txp:if_yield>' wraptag="ol" />
  <txp:else />
    <txp:soo_toc level='<txp:if_yield name="levels"><txp:yield name="levels" /></txp:if_yield>' />
  </txp:if_yield>

  <hr class="endrule">
</section>

assuming that ol is always the wraptag you want in this case. Not pretty, but perhaps it will work?

Destry · 2020-12-25 17:09:32

A lot of people at the in-laws, apparently. ;)

colak wrote #327855:

I took it that Destry used a shorthand for wraptag in his yield name.

Correct. I was just naming the yield tag, but using the plugin’s wraptag attribute and passing in a value of ol.

But, Colak’s code works!

I don’t know why, but using the plugin’s label and labeltag attributes instead of straight markup made the problem go away.

(I also changed the h2 to h1 to be consistent with similar section headers (back matter sections), and that allowed me to remove three ugly CSS lines. But that’s a different thing.)

Thanks, gents. Back to your nog.

Last edited by Destry (2020-12-25 17:15:23)

Destry · 2020-12-25 17:21:03

Bloke wrote #327854:

Might this work better? … <txp::contents wrap="ol" levels="4" />...

Actually, you might be right. I thought I knew what I was doing, but it was still throwing a wrench. I just made it all consistent wraptag now through the naming and it seems okay.

Textpattern CMS

Textpattern CMS support forum

#13 2020-12-23 20:13:58

Re: soo_toc table of contents generator

#14 2020-12-23 20:36:03

Re: soo_toc table of contents generator

#15 2020-12-25 14:23:51

Re: soo_toc table of contents generator

#16 2020-12-25 16:07:28

Re: soo_toc table of contents generator

#17 2020-12-25 16:27:36

Re: soo_toc table of contents generator

#18 2020-12-25 16:35:09

Re: soo_toc table of contents generator

Bloke wrote #327854:

#19 2020-12-25 16:37:04

Re: soo_toc table of contents generator

#20 2020-12-25 17:09:32

Re: soo_toc table of contents generator

colak wrote #327855:

#21 2020-12-25 17:21:03

Re: soo_toc table of contents generator

Bloke wrote #327854:

Board footer