mirror of
https://github.com/gohugoio/hugo.git
synced 2024-07-02 15:20:28 +00:00
597e418cb0
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
113 lines
2.8 KiB
Go
113 lines
2.8 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 (
|
|
"sync"
|
|
|
|
"github.com/bep/gitmap"
|
|
"github.com/gohugoio/hugo/common/maps"
|
|
"github.com/gohugoio/hugo/compare"
|
|
"github.com/gohugoio/hugo/lazy"
|
|
"github.com/gohugoio/hugo/navigation"
|
|
"github.com/gohugoio/hugo/output"
|
|
"github.com/gohugoio/hugo/resources/page"
|
|
"github.com/gohugoio/hugo/resources/resource"
|
|
)
|
|
|
|
type pageCommon struct {
|
|
s *Site
|
|
m *pageMeta
|
|
|
|
// Laziliy initialized dependencies.
|
|
init *lazy.Init
|
|
|
|
// All of these represents the common parts of a page.Page
|
|
maps.Scratcher
|
|
navigation.PageMenusProvider
|
|
page.AuthorProvider
|
|
page.PageRenderProvider
|
|
page.AlternativeOutputFormatsProvider
|
|
page.ChildCareProvider
|
|
page.FileProvider
|
|
page.GetPageProvider
|
|
page.GitInfoProvider
|
|
page.InSectionPositioner
|
|
page.OutputFormatsProvider
|
|
page.PageMetaProvider
|
|
page.Positioner
|
|
page.RawContentProvider
|
|
page.RelatedKeywordsProvider
|
|
page.RefProvider
|
|
page.ShortcodeInfoProvider
|
|
page.SitesProvider
|
|
page.DeprecatedWarningPageMethods
|
|
page.TranslationsProvider
|
|
page.TreeProvider
|
|
resource.LanguageProvider
|
|
resource.ResourceDataProvider
|
|
resource.ResourceMetaProvider
|
|
resource.ResourceParamsProvider
|
|
resource.ResourceTypesProvider
|
|
resource.TranslationKeyProvider
|
|
compare.Eqer
|
|
|
|
// Describes how paths and URLs for this page and its descendants
|
|
// should look like.
|
|
targetPathDescriptor page.TargetPathDescriptor
|
|
|
|
layoutDescriptor output.LayoutDescriptor
|
|
layoutDescriptorInit sync.Once
|
|
|
|
// The parsed page content.
|
|
pageContent
|
|
|
|
// Set if feature enabled and this is in a Git repo.
|
|
gitInfo *gitmap.GitInfo
|
|
|
|
// Positional navigation
|
|
posNextPrev *nextPrev
|
|
posNextPrevSection *nextPrev
|
|
|
|
// Menus
|
|
pageMenus *pageMenus
|
|
|
|
// Internal use
|
|
page.InternalDependencies
|
|
|
|
// The children. Regular pages will have none.
|
|
pages page.Pages
|
|
pagesInit sync.Once
|
|
|
|
// Any bundled resources
|
|
resources resource.Resources
|
|
resourcesInit sync.Once
|
|
|
|
translations page.Pages
|
|
allTranslations page.Pages
|
|
|
|
// Calculated an cached translation mapping key
|
|
translationKey string
|
|
translationKeyInit sync.Once
|
|
|
|
// Will only be set for sections and regular pages.
|
|
parent *pageState
|
|
|
|
// Will only be set for section pages and the home page.
|
|
subSections page.Pages
|
|
|
|
// Set in fast render mode to force render a given page.
|
|
forceRender bool
|
|
}
|