mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
90da7664bf
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
103 lines
2.6 KiB
Go
103 lines
2.6 KiB
Go
// Copyright 2019 The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package page
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/gohugoio/hugo/common/types"
|
|
|
|
qt "github.com/frankban/quicktest"
|
|
)
|
|
|
|
func TestRelated(t *testing.T) {
|
|
c := qt.New(t)
|
|
|
|
t.Parallel()
|
|
|
|
pages := Pages{
|
|
&testPage{
|
|
title: "Page 1",
|
|
pubDate: mustParseDate("2017-01-03"),
|
|
params: map[string]any{
|
|
"keywords": []string{"hugo", "says"},
|
|
},
|
|
},
|
|
&testPage{
|
|
title: "Page 2",
|
|
pubDate: mustParseDate("2017-01-02"),
|
|
params: map[string]any{
|
|
"keywords": []string{"hugo", "rocks"},
|
|
},
|
|
},
|
|
&testPage{
|
|
title: "Page 3",
|
|
pubDate: mustParseDate("2017-01-01"),
|
|
params: map[string]any{
|
|
"keywords": []string{"bep", "says"},
|
|
},
|
|
},
|
|
}
|
|
|
|
ctx := context.Background()
|
|
opts := map[string]any{
|
|
"namedSlices": types.NewKeyValuesStrings("keywords", "hugo", "rocks"),
|
|
}
|
|
result, err := pages.Related(ctx, opts)
|
|
|
|
c.Assert(err, qt.IsNil)
|
|
c.Assert(len(result), qt.Equals, 2)
|
|
c.Assert(result[0].Title(), qt.Equals, "Page 2")
|
|
c.Assert(result[1].Title(), qt.Equals, "Page 1")
|
|
|
|
result, err = pages.Related(ctx, pages[0])
|
|
c.Assert(err, qt.IsNil)
|
|
c.Assert(len(result), qt.Equals, 2)
|
|
c.Assert(result[0].Title(), qt.Equals, "Page 2")
|
|
c.Assert(result[1].Title(), qt.Equals, "Page 3")
|
|
|
|
opts = map[string]any{
|
|
"document": pages[0],
|
|
"indices": []string{"keywords"},
|
|
}
|
|
result, err = pages.Related(ctx, opts)
|
|
c.Assert(err, qt.IsNil)
|
|
c.Assert(len(result), qt.Equals, 2)
|
|
c.Assert(result[0].Title(), qt.Equals, "Page 2")
|
|
c.Assert(result[1].Title(), qt.Equals, "Page 3")
|
|
|
|
opts = map[string]any{
|
|
"namedSlices": []types.KeyValues{
|
|
{
|
|
Key: "keywords",
|
|
Values: []any{"bep", "rocks"},
|
|
},
|
|
},
|
|
}
|
|
result, err = pages.Related(context.Background(), opts)
|
|
c.Assert(err, qt.IsNil)
|
|
c.Assert(len(result), qt.Equals, 2)
|
|
c.Assert(result[0].Title(), qt.Equals, "Page 2")
|
|
c.Assert(result[1].Title(), qt.Equals, "Page 3")
|
|
}
|
|
|
|
func mustParseDate(s string) time.Time {
|
|
d, err := time.Parse("2006-01-02", s)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
return d
|
|
}
|