Add the [params] concept to front matter

[bep]

Note that this is

• Mostly about documentation.
• We will never (or if we do, we should get some way of converting old) break the "old way" of doing it.

We had a similar situation in language.params, where we allowed custom params at the top level. Now we warn about that and we will eventually remove that option.

So, from a documentation standpoint (API spec) this is problematic because it's hard to define which fields that makes up the API when "field A, B, C are Hugo configuration, all the rest are params".

So this proposal suggest that we from a documentation standpoint encourages front matter on the form:

title: Hello World
date: 2020-01-01
params:
  color: blue

And just to make this clear, this would also continue to work:

title: Hello World
date: 2020-01-01
color: blue

The "world" is a little more complicated than the above, but let us keep it simple for now.

/cc @jmooring

[jmooring]

Makes sense to me.

I have seen things like this in the wild

{{ .Page.Params.date }}
{{ .Page.Params.draft }}
{{ .Page.Params.iscjklanguage }}
{{ .Page.Params.lastmod }}
{{ .Page.Params.linktitle }}
{{ .Page.Params.publishdate }}
{{ .Page.Params.title }}
{{ .Page.Params.type }}

So, to be backwards compatible, predefined fields (in the root of front matter) need to be available under .Page.Params, but obviously not documented.

Taxonomy terms

Which would be the correct way?

title = 'How to change a lightbulb'
date = 2023-06-01T09:53:36-07:00
tags = ['tag a','tag b']

or

title = 'How to change a lightbulb'
date = 2023-06-01T09:53:36-07:00
[params]
  tags = ['tag a','tag b']

or

title = 'How to change a lightbulb'
date = 2023-06-01T09:53:36-07:00
[taxonomies]
  tags = ['tag a','tag b']

[jmooring]

Another thing to watch out for. If you define the summary in front matter, and then use the .Summary method in a template, it returns the rendered summary, not the raw field value.

To get the raw field value, you currently have to use .Params.Summary or .Params.summary. A .RawSummary method on page would resolve this, but we need to be aware of breaking existing sites.

[bep]

I'm marking this as closed for now, I'll create another issue(s) for following up work.

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