mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -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
71 lines
1.7 KiB
Go
71 lines
1.7 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 hugolib
|
|
|
|
import (
|
|
"context"
|
|
"sync"
|
|
|
|
"github.com/gohugoio/hugo/navigation"
|
|
)
|
|
|
|
type pageMenus struct {
|
|
p *pageState
|
|
|
|
q navigation.MenuQueryProvider
|
|
|
|
pmInit sync.Once
|
|
pm navigation.PageMenus
|
|
}
|
|
|
|
func (p *pageMenus) HasMenuCurrent(menuID string, me *navigation.MenuEntry) bool {
|
|
p.p.s.init.menus.Do(context.Background())
|
|
p.init()
|
|
return p.q.HasMenuCurrent(menuID, me)
|
|
}
|
|
|
|
func (p *pageMenus) IsMenuCurrent(menuID string, inme *navigation.MenuEntry) bool {
|
|
p.p.s.init.menus.Do(context.Background())
|
|
p.init()
|
|
return p.q.IsMenuCurrent(menuID, inme)
|
|
}
|
|
|
|
func (p *pageMenus) Menus() navigation.PageMenus {
|
|
// There is a reverse dependency here. initMenus will, once, build the
|
|
// site menus and update any relevant page.
|
|
p.p.s.init.menus.Do(context.Background())
|
|
|
|
return p.menus()
|
|
}
|
|
|
|
func (p *pageMenus) menus() navigation.PageMenus {
|
|
p.init()
|
|
return p.pm
|
|
}
|
|
|
|
func (p *pageMenus) init() {
|
|
p.pmInit.Do(func() {
|
|
p.q = navigation.NewMenuQueryProvider(
|
|
p,
|
|
p.p.s,
|
|
p.p,
|
|
)
|
|
|
|
var err error
|
|
p.pm, err = navigation.PageMenusFromPage(p.p)
|
|
if err != nil {
|
|
p.p.s.Log.Errorln(p.p.wrapError(err))
|
|
}
|
|
})
|
|
}
|