Add a way to identify a non-Page HTML etc. resource

[jmooring]

Reference: https://discourse.gohugo.io/t/shortcode-for-iframe-breaking-at-update-hugo-122-x-123-8/48904

Not sure if this is an enhancement or a bug.

The test below obviously passes with v0.122.0 because we blindly copied content page resources (.html, .htm, .adoc, .pdc, .org, .rst, .md) when publishing the site.

By design we are no longer copying content page resources, but I think site and theme authors should be able to publish them with Permalink, RelPermalink, and Publish.

Failing test:

func TestFoo(t *testing.T) {
	t.Parallel()

	files := `
-- hugo.toml --
baseURL = 'https://example.org/'
disableKinds = ['home','rss','section','sitemap','taxonomy','term']
-- content/p1/index.md --
---
title: p1
---
-- content/p1/a.html --
<p>a</p>
-- content/p1/b.html --
<p>b</p>
-- content/p1/c.html --
<p>c</p>
-- layouts/_default/single.html --
|{{ (.Resources.Get "a.html").RelPermalink -}}
|{{ (.Resources.Get "b.html").Permalink -}}
|{{ (.Resources.Get "c.html").Publish }}
`

	b := hugolib.Test(t, files)

	b.AssertFileContent("public/p1/index.html", "|/p1/a.html|https://example.org/p1/b.html|")
	b.AssertFileContent("public/p1/a.html", "<p>a</p>")
	b.AssertFileContent("public/p1/b.html", "<p>b</p>")
	b.AssertFileContent("public/p1/c.html", "<p>c</p>")
}

The workaround is a bit ugly:

{{ ((.Resources.Get "a.html").Content | resources.FromString "/p1/a.html").RelPermalink }}
{{ ((.Resources.Get "b.html").Content | resources.FromString "/p1/b.html").Permalink }}
{{ ((.Resources.Get "c.html").Content | resources.FromString "/p1/c.html").Publish }}

[bep]

• A content file inside a leaf bundle is a headless Page (no RelPermalink); this is how it have always behaved.
• A Page has no Publish method for good reason: A page can have shortcodes, can be rendered to multiple output formats, so the rendering/publishing needs to be coordinated.
• I have never seen this in the wild, and I suspect that the few that wants "the old" behaviour for HTML files inside bundles would be surprised if we somehow published these relative to the bundle permalink, so I'm not sure I want to spend time on that, either.

[jmooring]

Understood. Is there something cleaner than this to just dump the file (and return Permalink/RelPermalink)?

{{ ((.Resources.Get "a.html").Content | resources.FromString "/p1/a.html").RelPermalink }}

Or this?

{{ with .Resources.Get "a.html" }}
  {{ (.Content | resources.FromString .Path).RelPermalink }}
{{ end }}

[bep]

Is there something cleaner than this to just dump the file (and return Permalink/RelPermalink)?

... copy it into ... static?

[jmooring]

OP's use case needs to organize these with the page. I'm recommending second example above, or renaming the resource (e.g., a.txt instead of a.htm).

https://discourse.gohugo.io/t/shortcode-for-iframe-breaking-at-update-hugo-122-x-123-8/48904/9?u=jmooring

[bep]

I have reopened and relabeled this ... I don't know how to practically do this, but it would be a good idea if we had a way to say that a particular bundled (e.g. HTML) file should be handled as a regular simple resource with a mime type (as in: not a Page).

[jmooring]

Related to #9197.

[irkode]

just thinking out loud:

Using .Page.Resource with a page bundle

• a resource like image or text will show as type *resources.resourceAdapter and dump as Staler.

• whereas a page resource (.md/.html)* shows at type *hugolib.pageState and dumps as JSON PageObject

• in a page template the context (. or $) is shows a *hugolib.pageState

both have a ResourceType of page but you may only call .Permalink on the latter one

So at least within the templating there's a different experience incl. inconsistency for users. According to the Docs .Page.Resources returns resource.Resources but it's not exactly like that (at least for end users) cause a Resource has a Publish method.

looks like there is some Go magic interfacing behind ... and somehow obfuscating the details...

Summary:

maybe thinking a bit easy ;-)

If a page source file is processed by a Template its a "Page"
If a page source file is processed using Resource Methods its a "Page Resource" (not a Page)

If a Resource is published - the Content is copied verbatim to the target file

[Whoome]

This is essentially a critical issue for us, and has caused us to stop updating Hugo at 122. We have hundreds of html files that are treated as page resources (in our case, these are generated plotly graphs). And, then included in iframes for rendering. Changing the extension just doesn't work since then the files don't render.

Putting everything in the static folder is really not a good solution for us, since we are trying to keep the graphs local with the data they are relative to.

For us, even just turning off or controlling the extensions that are treated as pages would be enough, we don't have html files as content anywhere.

[jmooring]

@Whoome In case you aren't aware of this...

{{ range .Resources.Match "**.html" }}
  {{ $publishPath := urls.JoinPath $.RelPermalink .Name }}
  {{ (.Content | resources.FromString $publishPath).Publish }}
{{ end }}

Putting the above in a single.html file will publish the HTML files.

[Whoome]

No I wasn't aware of that. I just need to drop that anywhere in the theme?

[jmooring]

in a single.html file

Whichever one renders the pages with the HTML resources.

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.