github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-14 20:37:55 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/content/en/variables/page.md
Bjørn Erik Pedersen 74309fe569 Squashed 'docs/' changes from e5e98b950..084804447 
084804447 Update shortcode-templates.md
c01b02434 Correct misspelling of 'default'
52a831cca Added missing parenthesis
59e8e660a Fix spelling typos
29ad53c9c Yes, HTML is a valid content format
c6b193c6f Update shortcode-templates.md
1f2846e6d Fix typo in output format README
5882f7a4c Fix typo
a90a00bb0 Update multilingual.md
62bf0f184 Documentation for Open Graph & Twitter Cards
f4d624da3 Document "images", "videos", etc. in front-matter
6a85b5df1 Document anchorize and Resources.Content
04c8a5b0e Fix minor typo in 0.49.2 release note
dbe77e948 Release 0.49.2
ea6c9658e Merge branch 'temp492'
85c45b725 Merge branch 'release-0.49.2'
7ad1fba29 releaser: Prepare repository for 0.50-DEV
b25bcc3f2 releaser: Add release notes to /docs for release of 0.49.2
78b751b91 releaser: Bump versions for release of 0.49.2
e3f09762c Release 0.49.1
bd5b94558 Merge branch 'temp491'
0007e0661 Merge branch 'release-0.49.1'
74d2f3a6f releaser: Prepare repository for 0.50-DEV
bbee7e9d3 releaser: Add release notes to /docs for release of 0.49.1
ae40c89c7 releaser: Bump versions for release of 0.49.1
11079fb48 Add draft statement to FAQ
069b9472f Addin Hokus CMS to frontends list.
6e8850670 Add MediaType docs
f3ca6209a Add `languageName` to configuration
fd1cde5ea tpl: Add a delimiter parameter to lang.NumFmt
c620ff78a Update doc to use proper variable
7317c339a add tools->hugo-elasticsearch description to docs
d758ef94a hugolib: Introduce Page.NextPage and Page.PrevPage
9c93ac031 Update installing.md
7c0b5b7f5 Use ISO 639-1 code for examples
9a9e40ba8 Fix spelling
9a6216c18 Hugo 0.49
55aa91185 Merge branch 'temp49'
e0a36421e releaser: Prepare repository for 0.50-DEV
c07b3b385 releaser: Add release notes to /docs for release of 0.49
c1175a12a releaser: Bump versions for release of 0.49
2966f6254 docs: Document directory based archetypes
73dcd02ed Add showcase archetype folder
0a55ad11b docs: Regenerate CLI docs
e09866c2d docs: Document group
ef986358a Merge commit '807c551922707fc5ae0eb26e8f01638c0c63fdb3'
681f14fc9 tpl/collections: Allow first function to return an empty slice
f6dcc93bc docs: Add docs for append
aae528ca3 Merge commit '13e64d72763bf8d6d92d4cdfc15ed45ee9debfab'
02b62294c tpl/strings: Add strings.FirstUpper
bf3e61ba3 hugolib: Do not FirstUpper taxonomy titles

git-subtree-dir: docs
git-subtree-split: 084804447402ab99b51bf49f0da809bee8c16339
2018-10-29 09:19:20 +01:00

11 KiB
Raw Blame History

title linktitle description date publishdate lastmod categories keywords draft menu weight sections_weight aliases toc
Page Variables Page-level variables are defined in a content file's front matter, derived from the content's file location, or extracted from the content body itself. 2017-02-01 2017-02-01 2017-02-01
variables and params
pages
false
docs
title parent weight
variables defined by a page variables 20
20 20
true

The following is a list of page-level variables. Many of these will be defined in the front matter, derived from file location, or extracted from the content itself.

{{% note ".Scratch" %}} See .Scratch for page-scoped, writable variables. {{% /note %}}

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.)
.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.
.Dir
the path of the folder containing this content file. The path is relative to the content folder.
.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.
.FuzzyWordCount
the approximate number of words in the content.
.Hugo
see Hugo Variables.
.IsHome
true in the context of the homepage.
.IsNode
always false for regular content pages.
.IsPage
always true for regular content pages.
.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 taxonomyTerm. 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.
.Lang
language taken from the language extension notation.
.Language
a language object that points to the language's definition in the site config.
.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 (deprecated)
In older Hugo versions this pointer went the wrong direction. Please use .PrevPage instead.
.NextPage
Pointer to the next regular page (sorted by Hugo's default sort). Example: {{if .NextPage}}{{.NextPage.Permalink}}{{end}}.
.NextInSection
Pointer to the next regular page within the same section. Pages are sorted by Hugo's default sort. Example: {{if .NextInSection}}{{.NextInSection.Permalink}}{{end}}.
.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.
.PlainWords
the Page content stripped of HTML as a []string using Go's strings.Fields to split .Plain into a slice.
.Prev (deprecated)
In older Hugo versions this pointer went the wrong direction. Please use .NextPage instead.
.PrevPage
Pointer to the previous regular page (sorted by Hugo's default sort). Example: {{if .PrevPage}}{{.PrevPage.Permalink}}{{end}}.
.PrevInSection
Pointer to the previous regular page within the same section. Pages are sorted by Hugo's default sort. Example: {{if .PrevInSection}}{{.PrevInSection.Permalink}}{{end}}.
.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.
.RSSLink
link to the taxonomies' RSS link.
.RawContent
raw markdown content without the front matter. Useful with remarkjs.com
.ReadingTime
the estimated time, in minutes, it takes to read the content.
.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.
.Summary
a generated summary of the content for easily showing a snippet in a summary view. The breakpoint can be set manually by inserting <!--more--> at the appropriate place in the content page. 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.
.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., post).
.URL
the URL for the page relative to the web root. Note that a url set directly in front matter overrides the default relative URL for the rendered page.
.UniqueID
the MD5-checksum of the content file's path.
.Weight
assigned weight (in the front matter) to this content, used in sorting.
.WordCount
the number of words in the content.

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

{{< readfile file="/content/en/readfiles/pages-vs-site-pages.md" markdown="true" >}}

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.

---
title: My First Post
date: 2017-02-20T15:26:23-06:00
categories: [one]
tags: [two,three,four]

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

  • .Params.tags
  • .Params.categories

{{% note "Casing of Params" %}} Page-level .Params are only accessible in lowercase. {{% /note %}}

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 in /content/review/book01.md:

---
...
affiliatelink: "http://www.my-book-link.here"
recommendedby: "My Mother"
...
---

These fields would then be accessible to the /themes/yourtheme/layouts/review/single.html template through .Params.affiliatelink and .Params.recommendedby, respectively.

Two common situations where this type of front matter field could be introduced is as a value of a certain attribute like href="" or by itself to be displayed as text to the website's visitors.

{{< code file="/themes/yourtheme/layouts/review/single.html" >}}

Buy this book

It was recommended by {{ .Params.recommendedby }}.

{{< /code >}}

This template would render as follows, assuming you've set uglyURLs to false in your site config:

{{< output file="yourbaseurl/review/book01/index.html" >}}

Buy this book

It was recommended by my Mother.

{{< /output >}}

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

The .Param Method

In Hugo, you can declare params in individual pages and globally for your entire website. A common use case is to have a general value for the site param 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 config).

Access Nested Fields in Front Matter

When front matter contains nested fields like the following:

---
author:
  given_name: John
  family_name: Feminella
  display_name: John Feminella
---

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

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

If your front matter contains a top-level key that is ambiguous with a nested key, as in the following case:

---
favorites.flavor: vanilla
favorites:
  flavor: chocolate
---

The top-level key will be preferred. Therefore, the following method, when applied to the previous example, will print vanilla and not chocolate:

{{ $.Param "favorites.flavor" }}
=> vanilla