Hide Table Of Contents when theres only 1 item

[christianseel]

Summary

When showing the TOC, we should make sure there is more than 1 item. I'd propose to hide when there's only 1 heading

Why?

Not helpful for such small pages

[Mark-H]

Got an example link of a page where this happens?

[christianseel]

Yep http://docs.modx.org/3.x/en/getting-started/maintenance

[Mark-H]

Rather than fixing this in the app, I think we can fix this in the documentation sources, by simply removing that one heading.

[christianseel]

I'd say a single heading in a document is still important and helps structuring text visually and helps the human eye scanning a document. So I'd say single headlines should be kept!

In the case of that maintenance page the headline below the title is of course useless.
But there might be valid examples like this: https://docs.modx.org/current/en/building-sites/client-proofing/dashboards/usergroups

[Ibochkarev]

@Mark-H Can do this:

            {% if toc is not empty %}
                <div class="l-main__toc">
                    <nav class="c-toc" aria-labelledby="toc-title">
                        <div class="c-toc__wrapper">
                            <span class="c-toc__title" id="toc-title">
                                {{ lang.in_this_document }}
                            </span>
                            {{ toc|raw }}
                        </div>
                    </nav>
                </div>
            {% endif %}

Change to

            {% if toc|length > 1 %}
                <div class="l-main__toc">
                    <nav class="c-toc" aria-labelledby="toc-title">
                        <div class="c-toc__wrapper">
                            <span class="c-toc__title" id="toc-title">
                                {{ lang.in_this_document }}
                            </span>
                            {{ toc|raw }}
                        </div>
                    </nav>
                </div>
            {% endif %}

[Mark-H]

The toc variable contains the rendered (HTML) table of contents, not the number of results unfortunately.. So checking the length will only tell you that it has a value.

In Model/Page->getTableOfContents it parses the body to get the menu:

            return $tocGenerator->getHtmlMenu(
                $this->getRenderedBody(),
                $topLevel,
                $depth,
                $renderer
            );

From TocGenerator::getHtmlMenu:

        $menu = $this->getMenu($markup, $topLevel, $depth);
        return $renderer->render($menu);

So in Page->getTableOfContents I think we'll need to change getHtmlMenu to getMenu, check if it has at least 2 items, and if so render it.

[Ibochkarev]

Well then check for JS and hide this section