Add page template function

[bep]

We have several issues discussing something like this (re partials and .Render), but I haven't found a way (or at least not a reasonably simple way) to implement it ...

... until now.

This function will return the top level data context (the Page) when called from anywhere (shortcodes, partials, render hooks, view templates).

So you would do:

partials/mypartial:

{{ render.Context.Title }}

Will print the entry Page's title.

My explanation above may not be perfect, but this is plenty useful -- the hard part is getting the name right.

/cc @regisphilibert @jmooring etc.

[bep]

Since this "context" is always a Page, maybe we could just call it ... page, which would be analogue to the server global.

So, in the top level single.html etc. template, these will be the same:

{{ .Title }}
{{ page.Title }}

[jmooring]

The issue I remember with .Render is #8182 (comment), where it would be convenient to do something like:

{{ .Render "summary" (dict "page" .Page "myVar" "foo") }}

It doesn't seem like the proposed page function would address this particular case (myVar isn't on .Page). Please comment.

Also, what is the difference between page.Title and $.Title? It seems like both return the top level data context.

[bep]

OK, I may have forgot what the ".Render problem" was ... but I suspect I'm talking about "another one".

Also, what is the difference between page.Title and $.Title? It seems like both return the top level data context.

So,

{{ $.Title }}
{{ page.Title }}

The above would only be the same in the entry template (e.g. single.html). The $ does not travel into partials and template constructs.

[jmooring]

Does that mean I would be able to call a partial without passing the page context?

layouts/_default/single.html

{{ partial "render-some-page-stuff" }}

layouts/partials/render-some-page-stuff.html

Title: {{ page.Title }}<br>
Date: {{ page.Date }}<br>

[regisphilibert]

We have site which is a invoking the page's .Site method throughout.

So it would make sense that this is called page.

I think this is great, the more simple the context passed to a partial is — and now we'll never need to pass the page — the better.

I don't foresee any problems. Except making sure users understand the fact that any template be it a partial a ".Render" or a returning partial are bound to a page and even though it has no consequence it might create confusion when using partialCached where your partial might end up with the same page. But that's just logical and only concerns users using the new feature.

[bep]

Does that mean I would be able to call a partial without passing the page context?

Yes. But it's important to note that this is not only partials, and it would work in any nested situations, which is where I find the most pains in the current situation -- partial calling partial calling partial calling partial.

[bep]

partialCached where your partial might end up with the same page.

That is true, but that is also a "problem" you would have today.

[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.