Fix surprise OutputFormat.Rel overwriting
authorPaul Gottschling <paul.gottschling@gmail.com>
Mon, 3 Jan 2022 16:17:51 +0000 (11:17 -0500)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Tue, 4 Jan 2022 09:38:38 +0000 (10:38 +0100)
commitd3c4fdb8ffdc8845c7da54a5580758a33934dc6f
tree0994f2aa6334a6f92b12049f25365e6193fe50e5
parentd632dd7d74a1b338df97babfc7a1915c0c8814de
Fix surprise OutputFormat.Rel overwriting

In page.NewOutputFormat, we take an output.Format f and use it to
create a page.OutputFormat. If the format is canonical, we assign
the final OutputFormat's Rel to "canonical" rather than using
f.Rel. However, this leads to unexpected behavior for custom
output formats, where a user can define a "rel" for a format
via the config file.

For example, the standard for "humans.txt" files requires using
rel="author" in HTML "link" elements. Meanwhile, humans.txt is
usually the only format used for its content. As a result, for
Hugo configurations that define a humans.txt custom output format,
Hugo will render "link" elements to content in this format with
rel="canonical," rather than "author" as required by the standard.

This commit changes page.NewOutputFormat to check whether a given
format is user defined and, if so, skips assigning Rel to
"canonical," even if isCanonical is true.

Fixes #8030
hugolib/site_output_test.go
resources/page/page_outputformat.go