Add Level to the Heading struct

[jmooring]

Use Case 1

Building a TOC by walking .Page.Fragments.Headings works great, and it's easy to control the start and end levels from site and/or page params.

[params.toc]
startLevel = 2
endLevel = 4

However, to do this, the partial needs to keep track of the current Level while walking the map, adding 1 each time it goes a level deeper. This is not difficult to do, but would be a bit easier if we could access .Level for each heading.

Use Case 2

Control whether or not a TOC is displayed based on the number of headings of a certain level or levels.

[params.toc]
startLevel = 2
endLevel = 4
minNumHeadings = 3

If there are 3 or more headings of Level 2, 3, or 4 (combined), then display the TOC, otherwise don't.

I could walk the map once to get the counts, then walk it again to render, but it would be easier if I could get the counts up front. While some sort of count method would be ideal, adding Level would be sufficient.

{{ $count := where (sort .Fragments.HeadingsMap) "Level" "in" (slice 2 3 4) | len }}

The example above works because sort removes the first level keys.

[bep]

Yea, we can add that.

But I think what you ask for gets less obvious if you start from an arbitrary level, e.g.

{{ $startHeading := index .Fragments.HeadingMap "heading-on-level3" }}
// How do I  walk 2 level down from where I am now?

Building a ToC with this new structure would always need a recursive template, so passing add $currentLevel 1 to the template shouldn't be too hard.

[jmooring]

Yea, we can add that.

I suggest waiting until a use case with more value comes along.

add $currentLevel 1 to the template shouldn't be too hard

Agreed.

[l1x]

{{ range .Fragments.HeadingsMap }}
{{ $headings = $headings | append . }}
{{ end }}

Could you show a complete example please?

{{ range .Fragments.HeadingsMap }}
  {{ $headings = $headings | append . }}
{{ end }}

plate failed: template: posts/single.html:19:17: executing "main" at <$headings>: undefined variable: $headings
Error: Error building site: failed to render pages: render of "page" failed: "layouts/posts/single.html:19:17": execute of template failed: template: posts/single.html:19:17: executing "main" at <$headings>: undefined variable: $headings

Thanks in advance!

[khayyamsaleem]

@l1x This kind of question is better suited for https://discourse.gohugo.io/ so we can focus the discussion on @jmooring 's feature request.

However, the error you're encountering is because there's no $headings variable initialized, so before the range loop, you can just initialize it as an empty slice:

{{ $headings := slice }}
{{ range .Fragments.HeadingsMap }}
  {{ $headings = $headings | append . }}
{{ end }}

But best to ask these question on discourse; something like "Collect headings from .Page"

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.