mirror/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-08-28 22:19:59 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add page fragments support to Related

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

26
markup/asciidocext/convert.go
View File

@@ -53,10 +53,10 @@ func (p provider) New(cfg converter.ProviderConfig) (converter.Provider, error)
type asciidocResult struct {
converter.Result
toc tableofcontents.Root
toc *tableofcontents.Fragments
}
func (r asciidocResult) TableOfContents() tableofcontents.Root {
func (r asciidocResult) TableOfContents() *tableofcontents.Fragments {
return r.toc
}
@@ -205,16 +205,16 @@ func hasAsciiDoc() bool {
// extractTOC extracts the toc from the given src html.
// It returns the html without the TOC, and the TOC data
func (a *asciidocConverter) extractTOC(src []byte) ([]byte, tableofcontents.Root, error) {
func (a *asciidocConverter) extractTOC(src []byte) ([]byte, *tableofcontents.Fragments, error) {
var buf bytes.Buffer
buf.Write(src)
node, err := html.Parse(&buf)
if err != nil {
return nil, tableofcontents.Root{}, err
return nil, nil, err
}
var (
f func(*html.Node) bool
toc tableofcontents.Root
toc *tableofcontents.Fragments
toVisit []*html.Node
)
f = func(n *html.Node) bool {
@@ -242,12 +242,12 @@ func (a *asciidocConverter) extractTOC(src []byte) ([]byte, tableofcontents.Root
}
f(node)
if err != nil {
return nil, tableofcontents.Root{}, err
return nil, nil, err
}
buf.Reset()
err = html.Render(&buf, node)
if err != nil {
return nil, tableofcontents.Root{}, err
return nil, nil, err
}
// ltrim <html><head></head><body> and rtrim </body></html> which are added by html.Render
res := buf.Bytes()[25:]
@@ -256,9 +256,9 @@ func (a *asciidocConverter) extractTOC(src []byte) ([]byte, tableofcontents.Root
}
// parseTOC returns a TOC root from the given toc Node
func parseTOC(doc *html.Node) tableofcontents.Root {
func parseTOC(doc *html.Node) *tableofcontents.Fragments {
var (
toc tableofcontents.Root
toc tableofcontents.Builder
f func(*html.Node, int, int)
)
f = func(n *html.Node, row, level int) {
@@ -276,9 +276,9 @@ func parseTOC(doc *html.Node) tableofcontents.Root {
continue
}
href := attr(c, "href")[1:]
toc.AddAt(tableofcontents.Heading{
Text: nodeContent(c),
ID: href,
toc.AddAt(&tableofcontents.Heading{
Title: nodeContent(c),
ID: href,
}, row, level)
}
f(n.FirstChild, row, level)
@@ -289,7 +289,7 @@ func parseTOC(doc *html.Node) tableofcontents.Root {
}
}
f(doc.FirstChild, -1, 0)
return toc
return toc.Build()
}
func attr(node *html.Node, key string) string {

82
markup/asciidocext/convert_test.go
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\">")
}