hugo/content/en/variables/page.md at 87de22d7464e239c775fbd48ebce1665d5b1e80d

mirror of https://github.com/gohugoio/hugo.git synced 2024-11-14 20:37:55 -05:00

Bjørn Erik Pedersen 87de22d746 Squashed 'docs/' changes from 85befbb4d..c43daf45f

c43daf45f Update build-options.md
3ebbfedd4 Build options: Improve readability
5091bf6a0 Improve safeHTMLAttr explanation
b64cbce2e Fix description of collections.Apply
6ea264b9c netlify: Hugo 0.115.4
b42e7c542 Revert "config: Remove disableLiveReload"
35ce2290e Remove excess spaces in configuration docs
2edf761de Update listed titleCaseStyle default value
887f6fb97 config: Remove disableLiveReload
c9f49fb26 Fix typo
37d8569ac Remove tools associated with Atom
871d11b72 Fix URL in postprocess docs
bbb17d29f Update GitLab workflow
bc53ea5ce Use sentence-style capitalization for headings
7ca578786 netlify: Hugo 0.115.3
c5e010bd0 Merge branch 'tempv0.115.3'
c885604bf Remove starter kits page
4c0fe269e Update mention of Netlify CMS to Decap CMS
05067175c Consistently use file name instead of filename
763dd6404 Improve multilingual config example and descriptions
e5aa61ec5 Use lowercase when referring to front matter (#2132)
7ba3d0c72 docs: Refresh docs.json
de8bddedf Update description of timeout configuration value
e1245d9f8 netify: Hugo 0.115.2
153a36bdf Merge branch 'tempv0.115.2'
707cec754 Fix typo in figure example in shortcodes.md
128cbe1e5 Improve taxonomy template examples
4e743ec36 Improve highlight function example
f96fa6805 transpile sass: Fixes typo
e4a8a21f7 Compile Sass to CSS, not SCSS
c1538bd00 docs: Regenerate CLI docs
bd4e33436 Add titleCaseStyle none and firstupper
6ff93d478 Update quick-start.md
5c6653cb1 Update build config examples and explanation
1458d9a43 Remove the `url` parameter
6a1e92044 netlify: Hugo 0.115.1
a9d5d6f2f Merge branch 'tempv0.115.1'
4c4882384 docs: Regen docs helper
d1aa1c1f5 Add link to PowerShell vs Windows PowerShell documentation
6e3b70c21 Fix link to Git installation instructions
4f8a9ca38 Clarify resources.Copy arguments
ee86dd121 Update theme
dc7c305cf Update theme
60c23920b Clarify caching for resources.FromString (#2120)
5bf2fef6d netlify: Hugo 0.115.0
46bde87c5 Merge branch 'tempv0.115.0'
42cc48c16 Specify target path caching for resources.ExecuteAsTemplate (#2027)
a54bf4cd0 Correct the sample code of mermaid (#2119)
8c49b06fc docs: Update permalinks documentation
a4818d99b Page bundles: link to info about single vs. list page templates (#2116)
3fc7744d7 snap: Document removable media access
dbd08f58a Update theme
df5b88633 netlify: Hugo 0.114.1
6b859834a Fix typo
9ec92cf68 Improve Dart Sass example for Netlify
2d294ece9 Add Dart Sass installation and usage documentation
4c6b77d6c Fix placement of curly braces
897812a50 Update template-debugging.md to include a jsonify example
22bca519b Update GitHub Pages hosting instructions (#2109)
a964d93ce Document math functions new in v0.114.0 (#2108)
9f4cb040e netlify: Hugo 0.114.0
55b4d9221 Merge branch 'tempv0.114.0'
93c4dcf93 docs: Regen docshelper
96f03c77f docs: Regen CLI docs
8e22a228a Clarify resource media type variables (#2106)
2652da8d4 Update transform.Unmarshal.md (#2105)
92657177a Update theme
4601c1d65 Update theme
a216f3145 Merge commit '3c1deaf201a35de08d23cc58f8f03682cace3349'
eed8794f5 cache: Set default cache path based on $USER

git-subtree-dir: docs
git-subtree-split: c43daf45fdc36c254f4274a0815ea62d4d8c37e0

2023-07-29 11:15:54 +02:00

13 KiB

Raw Blame History

title

description

Page variables

.AlternativeOutputFormats: contains all alternative formats for a given page; this variable is especially useful link rel list in your site's <head>. (See Output Formats.)
.Aliases: aliases of this page
.Ancestors: get the ancestors of each page, simplify breadcrumb navigation implementation complexity
.BundleType: the bundle type: leaf, branch, or an empty string if the page is not a bundle.
.Content: the content itself, defined below the front matter.
.Data: the data specific to this type of page.
.Date: the date associated with the page; .Date pulls from the date field in a content's front matter. See also .ExpiryDate, .PublishDate, and .Lastmod.
.Description: the description for the page.
.Draft: a boolean, true if the content is marked as a draft in the front matter.
.ExpiryDate: the date on which the content is scheduled to expire; .ExpiryDate pulls from the expirydate field in a content's front matter. See also .PublishDate, .Date, and .Lastmod.
.File: filesystem-related data for this content file. See also File Variables.
.Fragments: Fragments returns the fragments for this page. See Page Fragments.
.FuzzyWordCount: the approximate number of words in the content.
.IsHome: true in the context of the homepage.
.IsNode: always false for regular content pages.
.IsPage: always true for regular content pages.
.IsSection: true if .Kind is section.
.IsTranslated: true if there are translations to display.
.Keywords: the meta keywords for the content.
.Kind: the page's kind. Possible return values are page, home, section, taxonomy, or term. Note that there are also RSS, sitemap, robotsTXT, and 404 kinds, but these are only available during the rendering of each of these respective page's kind and therefore not available in any of the Pages collections.
.Language: a language object that points to the language's definition in the site configuration. .Language.Lang gives you the language code.
.Lastmod: the date the content was last modified. .Lastmod pulls from the lastmod field in a content's front matter.

If lastmod is not set, and .GitInfo feature is disabled, the front matter date field will be used.
If lastmod is not set, and .GitInfo feature is enabled, .GitInfo.AuthorDate will be used instead.

See also .ExpiryDate, .Date, .PublishDate, and .GitInfo.

.LinkTitle: access when creating links to the content. If set, Hugo will use the linktitle from the front matter before title.
.Next: Points up to the next regular page (sorted by Hugo's default sort). Example: {{ with .Next }}{{ .Permalink }}{{ end }}. Calling .Next from the first page returns nil.
.NextInSection: Points up to the next regular page below the same top level section (e.g. in /blog)). Pages are sorted by Hugo's default sort. Example: {{ with .NextInSection }}{{ .Permalink }}{{ end }}. Calling .NextInSection from the first page returns nil.
.OutputFormats: contains all formats, including the current format, for a given page. Can be combined the with .Get function to grab a specific format. (See Output Formats.)
.Pages: a collection of associated pages. This value will be nil within the context of regular content pages. See .Pages.
.Permalink: the Permanent link for this page; see Permalinks
.Plain: the Page content stripped of HTML tags and presented as a string. You may need to pipe the result through the htmlUnescape function when rendering this value with the HTML output format.
.PlainWords: the slice of strings that results from splitting .Plain into words, as defined in Go's strings.Fields.
.Prev: Points down to the previous regular page (sorted by Hugo's default sort). Example: {{ if .Prev }}{{ .Prev.Permalink }}{{ end }}. Calling .Prev from the last page returns nil.
.PrevInSection: Points down to the previous regular page below the same top level section (e.g. /blog). Pages are sorted by Hugo's default sort. Example: {{ if .PrevInSection }}{{ .PrevInSection.Permalink }}{{ end }}. Calling .PrevInSection from the last page returns nil.
.PublishDate: the date on which the content was or will be published; .Publishdate pulls from the publishdate field in a content's front matter. See also .ExpiryDate, .Date, and .Lastmod.
.RawContent: raw markdown content without the front matter. Useful with remarkjs.com
.ReadingTime: the estimated time, in minutes, it takes to read the content.
.Resources: resources such as images and CSS that are associated with this page
.Ref: returns the permalink for a given reference (e.g., .Ref "sample.md"). .Ref does not handle in-page fragments correctly. See Cross References.
.RelPermalink: the relative permanent link for this page.
.RelRef: returns the relative permalink for a given reference (e.g., RelRef "sample.md"). .RelRef does not handle in-page fragments correctly. See Cross References.
.Site: see Site Variables.
.Sites: returns all sites (languages). A typical use case would be to link back to the main language: <a href="{{ .Sites.First.Home.RelPermalink }}">...</a>.
.Sites.First: returns the site for the first language. If this is not a multilingual setup, it will return itself.
.Summary: a generated summary of the content for easily showing a snippet in a summary view. The breakpoint can be set manually by inserting  at the appropriate place in the content page, or the summary can be written independent of the page text. See Content Summaries for more details.
.TableOfContents: the rendered table of contents for the page.
.Title: the title for this page.
.Translations: a list of translated versions of the current page. See Multilingual Mode for more information.
.TranslationKey: the key used to map language translations of the current page. See Multilingual Mode for more information.
.Truncated: a boolean, true if the .Summary is truncated. Useful for showing a "Read more..." link only when necessary. See Summaries for more information.
.Type: the content type of the content (e.g., posts).
.Weight: assigned weight (in the front matter) to this content, used in sorting.
.WordCount: the number of words in the content.

Writable page-scoped variables

.Scratch: returns a Scratch to store and manipulate data. In contrast to the .Store method, this scratch is reset on server rebuilds.
.Store: returns a Scratch to store and manipulate data. In contrast to the .Scratch method, this scratch is not reset on server rebuilds.

Section variables and methods

Also see Sections.

{{< readfile file="/content/en/readfiles/sectionvars.md" markdown="true" >}}

The `.Pages` variable

.Pages is an alias to .Data.Pages. It is conventional to use the aliased form .Pages.

`.Pages` compared to `.Site.Pages`

Page fragments

The .Fragments method returns a list of fragments for the current page.

.Headings: A recursive list of headings for the current page. Can be used to generate a table of contents.

{{< todo >}}add .Headings toc example{{< /todo >}}

.Identifiers: A sorted list of identifiers for the current page. Can be used to check if a page contains a specific identifier or if a page contains duplicate identifiers:

{{ if .Fragments.Identifiers.Contains "my-identifier" }}
    <p>Page contains identifier "my-identifier"</p>
{{ end }}

{{ if gt (.Fragments.Identifiers.Count "my-identifier")  1 }}
    <p>Page contains duplicate "my-identifier" fragments</p>
{{ end }}

.HeadingsMap: Holds a map of headings for the current page. Can be used to start the table of contents from a specific heading.

Also see the Go Doc for the return type.

Fragments in hooks and shortcodes

.Fragments are safe to call from render hooks, even on the page you're on (.Page.Fragments). For shortcodes we recommend that all .Fragments usage is nested inside the {{</**/>}} shortcode delimiter ({{%/**/%}} takes part in the ToC creation so it's easy to end up in a situation where you bite yourself in the tail).

The global page function

Hugo almost always passes a Page as the data context into the top level template (e.g. single.html) (the one exception is the multihost sitemap template). This means that you can access the current page with the . variable in the template.

But when you're deeply nested inside .Render, partial etc., accessing that Page object isn't always practical or possible.

For this reason, Hugo provides a global page function that you can use to access the current page from anywhere in any template.

{{ page.Title }}

There are one caveat with this, and this isn't new, but it's worth mentioning here: There are situations in Hugo where you may see a cached value, e.g. when using partialCached or in a shortcode.

Page-level params

Any other value defined in the front matter in a content file, including taxonomies, will be made available as part of the .Params variable.

{{< code-toggle file="content/example.md" fm=true copy=false >}} title: Example categories: [one] tags: [two,three,four] {{< /code-toggle >}}

With the above front matter, the tags and categories taxonomies are accessible via the following:

.Params.tags
.Params.categories

The .Params variable is particularly useful for the introduction of user-defined front matter fields in content files. For example, a Hugo website on book reviews could have the following front matter:

{{< code-toggle file="content/example.md" fm=true copy=false >}} title: Example affiliatelink: "http://www.my-book-link.here" recommendedby: "My Mother" {{< /code-toggle >}}

These fields would then be accessible to via .Params.affiliatelink and .Params.recommendedby.

<h3><a href="{{ .Params.affiliatelink }}">Buy this book</a></h3>
<p>It was recommended by {{ .Params.recommendedby }}.</p>

This template would render as follows:

<h3><a href="http://www.my-book-link.here">Buy this book</a></h3>
<p>It was recommended by my Mother.</p>

{{% note %}} See Archetypes for consistency of Params across pieces of content. {{% /note %}}

The `.Param` method

In Hugo, you can declare parameters in individual pages and globally for your entire website. A common use case is to have a general value for the site parameter and a more specific value for some of the pages (i.e., a header image):

{{ $.Param "header_image" }}

The .Param method provides a way to resolve a single value according to it's definition in a page parameter (i.e. in the content's front matter) or a site parameter (i.e., in your site configuration).

Access nested fields in front matter

When front matter contains nested fields like the following:

{{< code-toggle file="content/example.md" fm=true copy=false >}} title: Example author: given_name: John family_name: Feminella display_name: John Feminella {{< /code-toggle >}}

.Param can access these fields by concatenating the field names together with a dot:

{{ $.Param "author.display_name" }}

13 KiB Raw Blame History