mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
a6e635ca7d
fcc3ed651 Remove some expired new-in a9c5981f5 Fix cascade example 82bb250fa Add some lines about permalinks tokens in front matter 328fe564e Remove some outdated new-in fb140b153 Hide showcase menu entry 42d9d1c79 Update image formats from which EXIF data can be extracted 09ad56b6e netlify: Hugo 0.130.0 1d503f846 Merge branch 'tempv0.130.0' e2458074d math: Add trigonometric functions and some angle helper functions 392afc8f9 Disable the showcase section for now 0300750f2 Improve example of image render hook 60a9306af Improve description of the .Site.RegularPages method 8d759175d Fix typos 55daa4554 Update XxHash.md 397c81cb7 Add namespace for hash functions 70fe8d2f0 netlify: Bump Hugo 0.129.0 5a9771aff Merge branch 'tempv0.129.0' f9146575b Fix typo e6e1fea49 Fix typo in Hugo docs | functions | partial 732d10ec4 source: Expose GitInfo Body 34c97e639 netlify: Hugo 0.128.2 3270587e9 Fix typo 727c5396e netlify: Hugo 0.128.1 80b6ae99c Update GitHub Pages workflow file example 027134102 Update GitHub Pages workflow file example 2600a8a2e Miscellaneous edits 3fdd5819b Update Build.md 7764005c3 Improve example of render hook directory structure 5e3941d82 Fix typos 748bf065f Restructure templates section fafbf6566 Update Defer.md 012162e0d Document changes to template functions in v0.128.0 0990ce35b quick-reference: Update emojis 6677a30ef Update Goldmark configuration documentation 4449d530d Document new pagination config 0af8be439 Update Defer.md 56348196d netlify: Hugo 0.128.0 d67b6d82e Update content/en/functions/templates/Defer.md 23d996b3d Update content/en/functions/templates/Defer.md 7f7fb2f27 Document templates.Defer 5ada1e9d5 Fix docs merge (remove shortcode) d27ee6156 Merge branch 'tempv0.128.0' 5d7317c84 Fix typo 7c18ee546 Update theme 83bfea63b Update theme b274b3238 Merge commit '8b9803425e63e1b1801f8d5d676e96368d706722' ff34a035a deploy: Add stripIndexHtml target option d9e964bdb markup/goldmark: Add the Hugo Goldmark Extras "delete" extension ac5bd16d2 deps: Upgrade github.com/alecthomas/chroma v2.13.0 => v2.14.0 25377171b config: Remove extraneous BuildConfig setting 0d2044f6d docs: Regen docshelper a2548dac9 markup/goldmark: Support extras extension 9d0c86ee8 commands: Add gen chromastyles --lineNumbersTableStyle flag git-subtree-dir: docs git-subtree-split: fcc3ed651a1b6431303c2f88f20fa38531c52b3d
115 lines
2.9 KiB
Markdown
115 lines
2.9 KiB
Markdown
---
|
|
title: Term templates
|
|
description: Create a term template to render a list of pages associated with the current term.
|
|
categories: [templates]
|
|
keywords: []
|
|
menu:
|
|
docs:
|
|
parent: templates
|
|
weight: 100
|
|
weight: 100
|
|
toc: true
|
|
---
|
|
|
|
The [term] template below inherits the site's shell from the [base template], and renders a list of pages associated with the current term.
|
|
|
|
[term]: /getting-started/glossary/#term
|
|
[base template]: /templates/types/
|
|
|
|
{{< code file=layouts/_default/term.html >}}
|
|
{{ define "main" }}
|
|
<h1>{{ .Title }}</h1>
|
|
{{ .Content }}
|
|
{{ range .Pages }}
|
|
<h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
|
|
{{ end }}
|
|
{{ end }}
|
|
{{< /code >}}
|
|
|
|
Review the [template lookup order] to select a template path that provides the desired level of specificity.
|
|
|
|
[template lookup order]: /templates/lookup-order/#taxonomy-templates
|
|
|
|
In the example above, the term will be capitalized if its respective page is not backed by a file. You can disable this in your site configuration:
|
|
|
|
{{< code-toggle file=hugo >}}
|
|
capitalizeListTitles = false
|
|
{{< /code-toggle >}}
|
|
|
|
## Data object
|
|
|
|
Use these methods on the `Data` object within a term template.
|
|
|
|
Singular
|
|
: (`string`) Returns the singular name of the taxonomy.
|
|
|
|
```go-html-template
|
|
{{ .Data.Singular }} → tag
|
|
```
|
|
|
|
Plural
|
|
: (`string`) Returns the plural name of the taxonomy.
|
|
|
|
```go-html-template
|
|
{{ .Data.Plural }} → tags
|
|
```
|
|
|
|
Term
|
|
: (`string`) Returns the name of the term.
|
|
|
|
```go-html-template
|
|
{{ .Data.Term }} → fiction
|
|
```
|
|
|
|
## Display metadata
|
|
|
|
Display metadata about each term by creating a corresponding branch bundle in the content directory.
|
|
|
|
For example, create an "authors" taxonomy:
|
|
|
|
{{< code-toggle file=hugo >}}
|
|
[taxonomies]
|
|
author = 'authors'
|
|
{{< /code-toggle >}}
|
|
|
|
Then create content with one [branch bundle] for each term:
|
|
|
|
[branch bundle]: /getting-started/glossary/#branch-bundle
|
|
|
|
```text
|
|
content/
|
|
└── authors/
|
|
├── jsmith/
|
|
│ ├── _index.md
|
|
│ └── portrait.jpg
|
|
└── rjones/
|
|
├── _index.md
|
|
└── portrait.jpg
|
|
```
|
|
|
|
Then add front matter to each term page:
|
|
|
|
{{< code-toggle file=content/authors/jsmith/_index.md fm=true >}}
|
|
title = "John Smith"
|
|
affiliation = "University of Chicago"
|
|
{{< /code-toggle >}}
|
|
|
|
Then create a term template specific to the "authors" taxonomy:
|
|
|
|
{{< code file=layouts/authors/term.html >}}
|
|
{{ define "main" }}
|
|
<h1>{{ .Title }}</h1>
|
|
<p>Affiliation: {{ .Params.affiliation }}</p>
|
|
{{ with .Resources.Get "portrait.jpg" }}
|
|
{{ with .Fill "100x100" }}
|
|
<img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="portrait">
|
|
{{ end }}
|
|
{{ end }}
|
|
{{ .Content }}
|
|
{{ range .Pages }}
|
|
<h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
|
|
{{ end }}
|
|
{{ end }}
|
|
{{< /code >}}
|
|
|
|
In the example above we display the author with their affiliation and portrait, then a list of associated content.
|