Better example for PageInner in heading render hook

[chrillek]

Currently, the example for using .PageInner in the description of the heading render hook talks about including one page in another. To me, that looks not related to rendering a header at all. If I'm wrong (quite possible), some elaboration on how that would be useful in the context of rendering a header might be helpful. Otherwise, perhaps another example would illustrate the use of .PageInner in this context better.

[jmooring]

Some things to keep in mind:

1. Every render hook can call Page or PageInner
2. The PageInner method in only relevant when including one page within another via an "include" shortcode that calls Page.RenderShortcodes.
3. The PageInner method falls back to the value of Page if not relevant, and always returns a value, which means you can always use it instead of Page if you want to.

Providing an example for every render hook of when/why to use PageInner seems like overkill to me.

But to your question, consider this contrived heading render hook:

<h{{ .Level }} id="{{ .Anchor }}" {{- with .Attributes.class }} class="{{ . }}" {{- end }}>
  {{- printf "%s (%s)" .Text .Page.Title -}}
</h{{ .Level }}>

Now consider this content:

content/posts/post-1

---
title: Post 1
---

## Foo

{{% include "/posts/post-2" %}}

content/posts/post-2

---
title: Post 2
---

## Bar

When rendered, Post 1 looks like this:

That's obviously wrong. It should look like this:

And that means the heading render hook must call PageInner instead of Page.

<h{{ .Level }} id="{{ .Anchor }}" {{- with .Attributes.class }} class="{{ . }}" {{- end }}>
  {{- printf "%s (%s)" .Text .PageInner.Title -}}
</h{{ .Level }}>