Add page fragments support to Related

The main topic of this commit is that you can now index fragments (content heading identifiers) when calling `.Related`.

You can do this by:

* Configure one or more indices with type `fragments`
* The name of those index configurations maps to an (optional) front matter slice with fragment references. This allows you to link
page<->fragment and page<->page.
* This also will index all the fragments (heading identifiers) of the pages.

It's also possible to use type `fragments` indices in shortcode, e.g.:

```
{{ $related := site.RegularPages.Related .Page }}
```

But, and this is important, you need to include the shortcode using the `{{<` delimiter. Not doing so will create infinite loops and timeouts.

This commit also:

* Adds two new methods to Page: Fragments (can also be used to build ToC) and HeadingsFiltered (this is only used in Related Content with
index type `fragments` and `enableFilter` set to true.
* Consolidates all `.Related*` methods into one, which takes either a `Page` or an options map as its only argument.
* Add `context.Context` to all of the content related Page API. Turns out it wasn't strictly needed for this particular feature, but it will
soon become usefil, e.g. in #9339.

Closes #10711
Updates #9339
Updates #10725
This commit is contained in:
Bjørn Erik Pedersen
2023-02-11 16:20:24 +01:00
parent 0afec0a9f4
commit 90da7664bf
66 changed files with 1363 additions and 829 deletions

View File

@@ -21,13 +21,13 @@ import (
"path/filepath"
"testing"
"github.com/gohugoio/hugo/common/collections"
"github.com/gohugoio/hugo/common/hexec"
"github.com/gohugoio/hugo/common/loggers"
"github.com/gohugoio/hugo/config"
"github.com/gohugoio/hugo/config/security"
"github.com/gohugoio/hugo/markup/converter"
"github.com/gohugoio/hugo/markup/markup_config"
"github.com/gohugoio/hugo/markup/tableofcontents"
qt "github.com/frankban/quicktest"
)
@@ -343,49 +343,8 @@ testContent
c.Assert(err, qt.IsNil)
toc, ok := r.(converter.TableOfContentsProvider)
c.Assert(ok, qt.Equals, true)
expected := tableofcontents.Root{
Headings: tableofcontents.Headings{
{
ID: "",
Text: "",
Headings: tableofcontents.Headings{
{
ID: "_introduction",
Text: "Introduction",
Headings: nil,
},
{
ID: "_section_1",
Text: "Section 1",
Headings: tableofcontents.Headings{
{
ID: "_section_1_1",
Text: "Section 1.1",
Headings: tableofcontents.Headings{
{
ID: "_section_1_1_1",
Text: "Section 1.1.1",
Headings: nil,
},
},
},
{
ID: "_section_1_2",
Text: "Section 1.2",
Headings: nil,
},
},
},
{
ID: "_section_2",
Text: "Section 2",
Headings: nil,
},
},
},
},
}
c.Assert(toc.TableOfContents(), qt.DeepEquals, expected)
c.Assert(toc.TableOfContents().Identifiers, qt.DeepEquals, collections.SortedStringSlice{"_introduction", "_section_1", "_section_1_1", "_section_1_1_1", "_section_1_2", "_section_2"})
c.Assert(string(r.Bytes()), qt.Not(qt.Contains), "<div id=\"toc\" class=\"toc\">")
}
@@ -404,22 +363,7 @@ func TestTableOfContentsWithCode(t *testing.T) {
c.Assert(err, qt.IsNil)
toc, ok := r.(converter.TableOfContentsProvider)
c.Assert(ok, qt.Equals, true)
expected := tableofcontents.Root{
Headings: tableofcontents.Headings{
{
ID: "",
Text: "",
Headings: tableofcontents.Headings{
{
ID: "_some_code_in_the_title",
Text: "Some <code>code</code> in the title",
Headings: nil,
},
},
},
},
}
c.Assert(toc.TableOfContents(), qt.DeepEquals, expected)
c.Assert(toc.TableOfContents().HeadingsMap["_some_code_in_the_title"].Title, qt.Equals, "Some <code>code</code> in the title")
c.Assert(string(r.Bytes()), qt.Not(qt.Contains), "<div id=\"toc\" class=\"toc\">")
}
@@ -443,21 +387,7 @@ func TestTableOfContentsPreserveTOC(t *testing.T) {
c.Assert(err, qt.IsNil)
toc, ok := r.(converter.TableOfContentsProvider)
c.Assert(ok, qt.Equals, true)
expected := tableofcontents.Root{
Headings: tableofcontents.Headings{
{
ID: "",
Text: "",
Headings: tableofcontents.Headings{
{
ID: "some-title",
Text: "Some title",
Headings: nil,
},
},
},
},
}
c.Assert(toc.TableOfContents(), qt.DeepEquals, expected)
c.Assert(toc.TableOfContents().Identifiers, qt.DeepEquals, collections.SortedStringSlice{"some-title"})
c.Assert(string(r.Bytes()), qt.Contains, "<div id=\"toc\" class=\"toc\">")
}