github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-12-01 22:51:30 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/templates/taxonomy-templates.md
Bjørn Erik Pedersen 1c18f3fc49 Merge commit '50ec65fbe1a48475d3320775dab2c47389c02114'
2017-07-31 09:21:24 +02:00

12 KiB
Raw Blame History

title description date publishdate lastmod categories menu weight sections_weight draft aliases toc
Taxonomy Templates Taxonomy templating includes taxonomy list pages, taxonomy terms pages, and using taxonomies in your single page templates. 2017-02-01 2017-02-01 2017-02-01
templates
docs
parent weight
templates 50
50 50 false
/taxonomies/displaying/
/templates/terms/
/indexes/displaying/
/taxonomies/templates/
/indexes/ordering/
/templates/taxonomies/
/templates/taxonomy/
true

Hugo includes support for user-defined groupings of content called taxonomies. Taxonomies are classifications that demonstrate logical relationships between content. See Taxonomies under Content Management if you are unfamiliar with how Hugo leverages this powerful feature.

Hugo provides multiple ways to use taxonomies throughout your project templates:

Taxonomy List Templates

Taxonomy list page templates are lists and therefore have all the variables and methods available to list pages.

Taxonomy List Template Lookup Order

A taxonomy will be rendered at /PLURAL/TERM/ (e.g., http://spf13.com/topics/golang/) according to the following lookup order:

  1. /layouts/taxonomy/<SINGULAR>.html
  2. /layouts/_default/taxonomy.html
  3. /layouts/_default/list.html
  4. /themes/<THEME>/layouts/taxonomy/<SINGULAR>.html
  5. /themes/<THEME>/layouts/_default/taxonomy.html
  6. /themes/<THEME>/layouts/_default/list.html

Taxonomy Terms Template

Taxonomy Terms Templates Lookup Order

A taxonomy terms page will be rendered at example.com/<PLURALTAXONOMYNAME>/ (e.g., http://spf13.com/topics/) according to the following lookup order:

  1. /layouts/taxonomy/<SINGULAR>.terms.html
  2. /layouts/_default/terms.html
  3. /themes/<THEME>/layouts/taxonomy/<SINGULAR>.terms.html
  4. /themes/<THEME>/layouts/_default/terms.html

{{% warning "The Taxonomy Terms Template has a Unique Lookup Order" %}} If Hugo does not find a terms template in layout/ or /themes/<THEME>/layouts/, Hugo will not render a taxonomy terms page. {{% /warning %}}

Hugo makes a set of values and methods available on the various Taxonomy structures.

Taxonomy Methods

A Taxonomy is a map[string]WeightedPages.

.Get(term)
Returns the WeightedPages for a term.
.Count(term)
The number of pieces of content assigned to this term.
.Alphabetical
Returns an OrderedTaxonomy (slice) ordered by Term.
.ByCount
Returns an OrderedTaxonomy (slice) ordered by number of entries.

OrderedTaxonomy

Since Maps are unordered, an OrderedTaxonomy is a special structure that has a defined order.

[]struct {
    Name          string
    WeightedPages WeightedPages
}

Each element of the slice has:

.Term
The Term used.
.WeightedPages
A slice of Weighted Pages.
.Count
The number of pieces of content assigned to this term.
.Pages
All Pages assigned to this term. All list methods are available to this.

WeightedPages

WeightedPages is simply a slice of WeightedPage.

type WeightedPages []WeightedPage
.Count(term)
The number of pieces of content assigned to this term.
.Pages
Returns a slice of pages, which then can be ordered using any of the list methods.

Order Taxonomies

Taxonomies can be ordered by either alphabetical key or by the number of content pieces assigned to that key.

Order Alphabetically Example

<ul>
  {{ $data := .Data }}
  {{ range $key, $value := .Data.Taxonomy.Alphabetical }}
  <li><a href="{{ $.Site.LanguagePrefix }}/{{ $data.Plural }}/{{ $value.Name | urlize }}"> {{ $value.Name }} </a> {{ $value.Count }} </li>
  {{ end }}
</ul>

Order by Popularity Example

<ul>
  {{ $data := .Data }}
  {{ range $key, $value := .Data.Taxonomy.ByCount }}
  <li><a href="{{ $.Site.LanguagePrefix }}/{{ $data.Plural }}/{{ $value.Name | urlize }}"> {{ $value.Name }} </a> {{ $value.Count }} </li>
  {{ end }}
</ul>

Order Content within Taxonomies

Hugo uses both date and weight to order content within taxonomies.

Each piece of content in Hugo can optionally be assigned a date. It can also be assigned a weight for each taxonomy it is assigned to.

When iterating over content within taxonomies, the default sort is the same as that used for section and list pages first by weight then by date. This means that if the weights for two pieces of content are the same, than the more recent content will be displayed first. The default weight for any piece of content is 0.

Assign Weight

Content can be assigned weight for each taxonomy that it's assigned to.

+++
tags = [ "a", "b", "c" ]
tags_weight = 22
categories = ["d"]
title = "foo"
categories_weight = 44
+++
Front Matter with weighted tags and categories

The convention is taxonomyname_weight.

In the above example, this piece of content has a weight of 22 which applies to the sorting when rendering the pages assigned to the "a", "b" and "c" values of the 'tag' taxonomy.

It has also been assigned the weight of 44 when rendering the 'd' category.

With this the same piece of content can appear in different positions in different taxonomies.

Currently taxonomies only support the default ordering of content which is weight -> date.

There are two different templates that the use of taxonomies will require you to provide.

Both templates are covered in detail in the templates section.

A list template is any template that will be used to render multiple pieces of content in a single html page. This template will be used to generate all the automatically created taxonomy pages.

A taxonomy terms template is a template used to generate the list of terms for a given template.

There are four common ways you can display the data in your taxonomies in addition to the automatic taxonomy pages created by hugo using the list templates:

  1. For a given piece of content, you can list the terms attached
  2. For a given piece of content, you can list other content with the same term
  3. You can list all terms for a taxonomy
  4. You can list all taxonomies (with their terms)

Display a Single Piece of Content's Taxonomies

Within your content templates, you may wish to display the taxonomies that piece of content is assigned to.

Because we are leveraging the front matter system to define taxonomies for content, the taxonomies assigned to each content piece are located in the usual place (i.e., .Params.<TAXONOMYPLURAL>).

Example: List Tags in a Single Page Template

<ul id="tags">
  {{ range .Params.tags }}
    <li><a href="{{ "/tags/" | relLangURL }}{{ . | urlize }}">{{ . }}</a> </li>
  {{ end }}
</ul>

If you want to list taxonomies inline, you will have to take care of optional plural endings in the title (if multiple taxonomies), as well as commas. Let's say we have a taxonomy "directors" such as directors: [ "Joel Coen", "Ethan Coen" ] in the TOML-format front matter.

To list such taxonomies, use the following:

Example: Comma-delimit Tags in a Single Page Template

{{ if .Params.directors }}
  <strong>Director{{ if gt (len .Params.directors) 1 }}s{{ end }}:</strong>
  {{ range $index, $director := .Params.directors }}{{ if gt $index 0 }}, {{ end }}<a href="{{ "directors/" | relURL }}{{ . | urlize }}">{{ . }}</a>{{ end }}
{{ end }}

Alternatively, you may use the delimit template function as a shortcut if the taxonomies should just be listed with a separator. See {{< gh 2143 >}} on GitHub for discussion.

List Content with the Same Taxonomy Term

If you are using a taxonomy for something like a series of posts, you can list individual pages associated with the same taxonomy. This is also a quick and dirty method for showing related content:

Example: Showing Content in Same Series

<ul>
  {{ range .Site.Taxonomies.series.golang }}
    <li><a href="{{ .Page.RelPermalink }}">{{ .Page.Title }}</a></li>
  {{ end }}
</ul>

List All content in a Given taxonomy

This would be very useful in a sidebar as “featured content”. You could even have different sections of “featured content” by assigning different terms to the content.

Example: Grouping "Featured" Content

<section id="menu">
    <ul>
        {{ range $key, $taxonomy := .Site.Taxonomies.featured }}
        <li> {{ $key }} </li>
        <ul>
            {{ range $taxonomy.Pages }}
            <li hugo-nav="{{ .RelPermalink}}"><a href="{{ .Permalink}}"> {{ .LinkTitle }} </a> </li>
            {{ end }}
        </ul>
        {{ end }}
    </ul>
</section>

Render a Site's Taxonomies

If you wish to display the list of all keys for your site's taxonomy, you can retrieve them from the .Site variable available on every page.

This may take the form of a tag cloud, a menu, or simply a list.

The following example displays all terms in a site's tags taxonomy:

Example: List All Site Tags

<ul id="all-tags">
  {{ range $name, $taxonomy := .Site.Taxonomies.tags }}
    <li><a href="{{ "/tags/" | relLangURL }}{{ $name | urlize }}">{{ $name }}</a></li>
  {{ end }}
</ul>

Example: List All Taxonomies, Terms, and Assigned Content

This example will list all taxonomies and their terms, as well as all the content assigned to each of the terms.

{{< code file="layouts/partials/all-taxonomies.html" download="all-taxonomies.html" download="all-taxonomies.html" >}}

    {{ range $taxonomyname, $taxonomy := .Site.Taxonomies }}
  • {{ $taxonomyname }}
      {{ range $key, $value := $taxonomy }}
    • {{ $key }}
        • {{ range $value.Pages }}
      • {{ .LinkTitle }}
        • {{ end }}
      {{ end }}
    • {{ end }}
{{< /code >}}

.Site.GetPage for Taxonomies

Because taxonomies are lists, the .GetPage function can be used to get all the pages associated with a particular taxonomy term using a terse syntax. The following ranges over the full list of tags on your site and links to each of the individual taxonomy pages for each term without having to use the more fragile URL construction of the "List All Site Tags" example above:

{{< code file="links-to-all-tags" >}}

    {{ range ($.Site.GetPage "taxonomyTerm" "tags").Pages }}
  • {{ .Title}}
    • {{ end }}
{{< /code >}}