mirror of
https://github.com/gohugoio/hugo.git
synced 2025-08-20 21:31:32 +02:00
Make Page an interface
The main motivation of this commit is to add a `page.Page` interface to replace the very file-oriented `hugolib.Page` struct. This is all a preparation step for issue #5074, "pages from other data sources". But this also fixes a set of annoying limitations, especially related to custom output formats, and shortcodes. Most notable changes: * The inner content of shortcodes using the `{{%` as the outer-most delimiter will now be sent to the content renderer, e.g. Blackfriday. This means that any markdown will partake in the global ToC and footnote context etc. * The Custom Output formats are now "fully virtualized". This removes many of the current limitations. * The taxonomy list type now has a reference to the `Page` object. This improves the taxonomy template `.Title` situation and make common template constructs much simpler. See #5074 Fixes #5763 Fixes #5758 Fixes #5090 Fixes #5204 Fixes #4695 Fixes #5607 Fixes #5707 Fixes #5719 Fixes #3113 Fixes #5706 Fixes #5767 Fixes #5723 Fixes #5769 Fixes #5770 Fixes #5771 Fixes #5759 Fixes #5776 Fixes #5777 Fixes #5778
This commit is contained in:
64
resources/page/pages_language_merge.go
Normal file
64
resources/page/pages_language_merge.go
Normal file
@@ -0,0 +1,64 @@
|
||||
// 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 (
|
||||
"fmt"
|
||||
)
|
||||
|
||||
var (
|
||||
_ pagesLanguageMerger = (*Pages)(nil)
|
||||
)
|
||||
|
||||
type pagesLanguageMerger interface {
|
||||
MergeByLanguage(other Pages) Pages
|
||||
// Needed for integration with the tpl package.
|
||||
MergeByLanguageInterface(other interface{}) (interface{}, error)
|
||||
}
|
||||
|
||||
// MergeByLanguage supplies missing translations in p1 with values from p2.
|
||||
// The result is sorted by the default sort order for pages.
|
||||
func (p1 Pages) MergeByLanguage(p2 Pages) Pages {
|
||||
merge := func(pages *Pages) {
|
||||
m := make(map[string]bool)
|
||||
for _, p := range *pages {
|
||||
m[p.TranslationKey()] = true
|
||||
}
|
||||
|
||||
for _, p := range p2 {
|
||||
if _, found := m[p.TranslationKey()]; !found {
|
||||
*pages = append(*pages, p)
|
||||
}
|
||||
}
|
||||
|
||||
SortByDefault(*pages)
|
||||
}
|
||||
|
||||
out, _ := spc.getP("pages.MergeByLanguage", merge, p1, p2)
|
||||
|
||||
return out
|
||||
}
|
||||
|
||||
// MergeByLanguageInterface is the generic version of MergeByLanguage. It
|
||||
// is here just so it can be called from the tpl package.
|
||||
func (p1 Pages) MergeByLanguageInterface(in interface{}) (interface{}, error) {
|
||||
if in == nil {
|
||||
return p1, nil
|
||||
}
|
||||
p2, ok := in.(Pages)
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("%T cannot be merged by language", in)
|
||||
}
|
||||
return p1.MergeByLanguage(p2), nil
|
||||
}
|
Reference in New Issue
Block a user