mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-02 02:19:09 -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
139 lines
4.1 KiB
Go
139 lines
4.1 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"
|
|
"html/template"
|
|
|
|
"github.com/gohugoio/hugo/lazy"
|
|
"github.com/gohugoio/hugo/markup/converter"
|
|
)
|
|
|
|
// OutputFormatContentProvider represents the method set that is "outputFormat aware" and that we
|
|
// provide lazy initialization for in case they get invoked outside of their normal rendering context, e.g. via .Translations.
|
|
// Note that this set is currently not complete, but should cover the most common use cases.
|
|
// For the others, the implementation will be from the page.NoopPage.
|
|
type OutputFormatContentProvider interface {
|
|
OutputFormatPageContentProvider
|
|
|
|
// for internal use.
|
|
ContentRenderer
|
|
}
|
|
|
|
// OutputFormatPageContentProvider holds the exported methods from Page that are "outputFormat aware".
|
|
type OutputFormatPageContentProvider interface {
|
|
ContentProvider
|
|
TableOfContentsProvider
|
|
PageRenderProvider
|
|
}
|
|
|
|
// LazyContentProvider initializes itself when read. Each method of the
|
|
// ContentProvider interface initializes a content provider and shares it
|
|
// with other methods.
|
|
//
|
|
// Used in cases where we cannot guarantee whether the content provider
|
|
// will be needed. Must create via NewLazyContentProvider.
|
|
type LazyContentProvider struct {
|
|
init *lazy.Init
|
|
cp OutputFormatContentProvider
|
|
}
|
|
|
|
// NewLazyContentProvider returns a LazyContentProvider initialized with
|
|
// function f. The resulting LazyContentProvider calls f in order to
|
|
// retrieve a ContentProvider
|
|
func NewLazyContentProvider(f func() (OutputFormatContentProvider, error)) *LazyContentProvider {
|
|
lcp := LazyContentProvider{
|
|
init: lazy.New(),
|
|
cp: NopCPageContentRenderer,
|
|
}
|
|
lcp.init.Add(func(context.Context) (any, error) {
|
|
cp, err := f()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
lcp.cp = cp
|
|
return nil, nil
|
|
})
|
|
return &lcp
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) Reset() {
|
|
lcp.init.Reset()
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) Content(ctx context.Context) (any, error) {
|
|
lcp.init.Do(ctx)
|
|
return lcp.cp.Content(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) Plain(ctx context.Context) string {
|
|
lcp.init.Do(ctx)
|
|
return lcp.cp.Plain(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) PlainWords(ctx context.Context) []string {
|
|
lcp.init.Do(ctx)
|
|
return lcp.cp.PlainWords(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) Summary(ctx context.Context) template.HTML {
|
|
lcp.init.Do(ctx)
|
|
return lcp.cp.Summary(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) Truncated(ctx context.Context) bool {
|
|
lcp.init.Do(ctx)
|
|
return lcp.cp.Truncated(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) FuzzyWordCount(ctx context.Context) int {
|
|
lcp.init.Do(ctx)
|
|
return lcp.cp.FuzzyWordCount(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) WordCount(ctx context.Context) int {
|
|
lcp.init.Do(ctx)
|
|
return lcp.cp.WordCount(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) ReadingTime(ctx context.Context) int {
|
|
lcp.init.Do(ctx)
|
|
return lcp.cp.ReadingTime(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) Len(ctx context.Context) int {
|
|
lcp.init.Do(ctx)
|
|
return lcp.cp.Len(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) Render(ctx context.Context, layout ...string) (template.HTML, error) {
|
|
lcp.init.Do(context.TODO())
|
|
return lcp.cp.Render(ctx, layout...)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) RenderString(ctx context.Context, args ...any) (template.HTML, error) {
|
|
lcp.init.Do(ctx)
|
|
return lcp.cp.RenderString(ctx, args...)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) TableOfContents(ctx context.Context) template.HTML {
|
|
lcp.init.Do(ctx)
|
|
return lcp.cp.TableOfContents(ctx)
|
|
}
|
|
|
|
func (lcp *LazyContentProvider) RenderContent(ctx context.Context, content []byte, renderTOC bool) (converter.Result, error) {
|
|
lcp.init.Do(ctx)
|
|
return lcp.cp.RenderContent(ctx, content, renderTOC)
|
|
}
|