diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2023-02-11 16:20:24 +0100 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2023-02-21 17:56:41 +0100 |
commit | 90da7664bf1f3a0ca2e18144b5deacf532c6e3cf (patch) | |
tree | 78d8ac72ebb2ccee4ca4bbeeb9add3365c743e90 /tpl | |
parent | 0afec0a9f4aace1f5f4af6822aeda6223ee3e3a9 (diff) |
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
Diffstat (limited to 'tpl')
-rw-r--r-- | tpl/internal/go_templates/texttemplate/hugo_template.go | 1 | ||||
-rw-r--r-- | tpl/transform/transform.go | 5 | ||||
-rw-r--r-- | tpl/transform/transform_test.go | 5 |
3 files changed, 7 insertions, 4 deletions
diff --git a/tpl/internal/go_templates/texttemplate/hugo_template.go b/tpl/internal/go_templates/texttemplate/hugo_template.go index dab5a05a3..96f526005 100644 --- a/tpl/internal/go_templates/texttemplate/hugo_template.go +++ b/tpl/internal/go_templates/texttemplate/hugo_template.go @@ -62,6 +62,7 @@ func NewExecuter(helper ExecHelper) Executer { type ( dataContextKeyType string hasLockContextKeyType string + stackContextKeyType string ) const ( diff --git a/tpl/transform/transform.go b/tpl/transform/transform.go index 039d674c4..0f9ad61d4 100644 --- a/tpl/transform/transform.go +++ b/tpl/transform/transform.go @@ -15,6 +15,7 @@ package transform import ( + "context" "html" "html/template" @@ -118,13 +119,13 @@ func (ns *Namespace) HTMLUnescape(s any) (string, error) { } // Markdownify renders s from Markdown to HTML. -func (ns *Namespace) Markdownify(s any) (template.HTML, error) { +func (ns *Namespace) Markdownify(ctx context.Context, s any) (template.HTML, error) { home := ns.deps.Site.Home() if home == nil { panic("home must not be nil") } - ss, err := home.RenderString(s) + ss, err := home.RenderString(ctx, s) if err != nil { return "", err } diff --git a/tpl/transform/transform_test.go b/tpl/transform/transform_test.go index edef4e1bd..86ddb1259 100644 --- a/tpl/transform/transform_test.go +++ b/tpl/transform/transform_test.go @@ -14,6 +14,7 @@ package transform_test import ( + "context" "html/template" "strings" "testing" @@ -185,7 +186,7 @@ func TestMarkdownify(t *testing.T) { {tstNoStringer{}, false}, } { - result, err := ns.Markdownify(test.s) + result, err := ns.Markdownify(context.Background(), test.s) if bb, ok := test.expect.(bool); ok && !bb { b.Assert(err, qt.Not(qt.IsNil)) @@ -218,7 +219,7 @@ This is some more text. And then some. ` - result, err := ns.Markdownify(text) + result, err := ns.Markdownify(context.Background(), text) b.Assert(err, qt.IsNil) b.Assert(result, qt.Equals, template.HTML( "<p>#First</p>\n<p>This is some <em>bold</em> text.</p>\n<h2 id=\"second\">Second</h2>\n<p>This is some more text.</p>\n<p>And then some.</p>\n")) |