diff options
author | Bjørn Erik Pedersen <[email protected]> | 2019-01-02 12:33:26 +0100 |
---|---|---|
committer | Bjørn Erik Pedersen <[email protected]> | 2019-03-23 18:51:22 +0100 |
commit | 597e418cb02883418f2cebb41400e8e61413f651 (patch) | |
tree | 177ad9c540b2583b6dab138c9f0490d28989c7f7 /output | |
parent | 44f5c1c14cb1f42cc5f01739c289e9cfc83602af (diff) | |
download | hugo-597e418cb02883418f2cebb41400e8e61413f651.tar.gz hugo-597e418cb02883418f2cebb41400e8e61413f651.zip |
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
Diffstat (limited to 'output')
-rw-r--r-- | output/outputFormat.go | 35 | ||||
-rw-r--r-- | output/outputFormat_test.go | 5 |
2 files changed, 27 insertions, 13 deletions
diff --git a/output/outputFormat.go b/output/outputFormat.go index 9b1f83854..5a794e340 100644 --- a/output/outputFormat.go +++ b/output/outputFormat.go @@ -1,4 +1,4 @@ -// Copyright 2017-present The Hugo Authors. All rights reserved. +// 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. @@ -69,17 +69,27 @@ type Format struct { // Note that we use the term "alternative" and not "alternate" here, as it // does not necessarily replace the other format, it is an alternative representation. NotAlternative bool `json:"notAlternative"` + + // Setting this will make this output format control the value of + // .Permalink and .RelPermalink for a rendered Page. + // If not set, these values will point to the main (first) output format + // configured. That is probably the behaviour you want in most situations, + // as you probably don't want to link back to the RSS version of a page, as an + // example. AMP would, however, be a good example of an output format where this + // behaviour is wanted. + Permalinkable bool } // An ordered list of built-in output formats. var ( AMPFormat = Format{ - Name: "AMP", - MediaType: media.HTMLType, - BaseName: "index", - Path: "amp", - Rel: "amphtml", - IsHTML: true, + Name: "AMP", + MediaType: media.HTMLType, + BaseName: "index", + Path: "amp", + Rel: "amphtml", + IsHTML: true, + Permalinkable: true, // See https://www.ampproject.org/learn/overview/ } @@ -109,11 +119,12 @@ var ( } HTMLFormat = Format{ - Name: "HTML", - MediaType: media.HTMLType, - BaseName: "index", - Rel: "canonical", - IsHTML: true, + Name: "HTML", + MediaType: media.HTMLType, + BaseName: "index", + Rel: "canonical", + IsHTML: true, + Permalinkable: true, } JSONFormat = Format{ diff --git a/output/outputFormat_test.go b/output/outputFormat_test.go index 410fd74ba..6bd4dda5b 100644 --- a/output/outputFormat_test.go +++ b/output/outputFormat_test.go @@ -1,4 +1,4 @@ -// Copyright 2017-present The Hugo Authors. All rights reserved. +// 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. @@ -42,6 +42,7 @@ func TestDefaultTypes(t *testing.T) { require.Empty(t, CSVFormat.Protocol) require.True(t, CSVFormat.IsPlainText) require.False(t, CSVFormat.IsHTML) + require.False(t, CSVFormat.Permalinkable) require.Equal(t, "HTML", HTMLFormat.Name) require.Equal(t, media.HTMLType, HTMLFormat.MediaType) @@ -49,6 +50,7 @@ func TestDefaultTypes(t *testing.T) { require.Empty(t, HTMLFormat.Protocol) require.False(t, HTMLFormat.IsPlainText) require.True(t, HTMLFormat.IsHTML) + require.True(t, AMPFormat.Permalinkable) require.Equal(t, "AMP", AMPFormat.Name) require.Equal(t, media.HTMLType, AMPFormat.MediaType) @@ -56,6 +58,7 @@ func TestDefaultTypes(t *testing.T) { require.Empty(t, AMPFormat.Protocol) require.False(t, AMPFormat.IsPlainText) require.True(t, AMPFormat.IsHTML) + require.True(t, AMPFormat.Permalinkable) require.Equal(t, "RSS", RSSFormat.Name) require.Equal(t, media.RSSType, RSSFormat.MediaType) |