TheCloud/hugoDocs
1
0
Fork 0
mirror of https://github.com/gohugoio/hugoDocs.git synced 2025-09-19 05:24:56 -04:00
Code Issues Packages Projects Releases Wiki Activity

Improve taxonomy template examples

Browse Source
This commit is contained in:
Joe Mooring 2023-07-06 16:44:28 -07:00 committed by GitHub
parent 4e743ec360
commit 128cbe1e58
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 72 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

149
content/en/templates/taxonomy-templates.md
View File

@ -101,12 +101,12 @@ If you need to display custom metadata for each taxonomy term, you will need to
```go-html-template ```go-html-template
<ul> <ul>
{{ range .Pages }} {{ range .Pages }}
<li> <li>
<a href="{{ .Permalink }}">{{ .Title }}</a> <a href="{{ .Permalink }}">{{ .Title }}</a>
{{ .Params.wikipedia }} {{ .Params.wikipedia }}
</li> </li>
{{ end }} {{ end }}
</ul> </ul>
``` ```
@ -120,9 +120,9 @@ Taxonomies can be ordered by either alphabetical key or by the number of content
```go-html-template ```go-html-template
<ul> <ul>
{{ range .Data.Terms.Alphabetical }} {{ range .Data.Terms.Alphabetical }}
<li><a href="{{ .Page.Permalink }}">{{ .Page.Title }}</a> {{ .Count }}</li> <li><a href="{{ .Page.Permalink }}">{{ .Page.Title }}</a> {{ .Count }}</li>
{{ end }} {{ end }}
</ul> </ul>
``` ```
@ -186,42 +186,38 @@ using the [list templates](/templates/lists/):
3. You can list all terms for a taxonomy 3. You can list all terms for a taxonomy
4. You can list all taxonomies (with their terms) 4. You can list all taxonomies (with their terms)
## Display a Single Piece of Content's Taxonomies ## List Terms Assigned to a Page
Within your content templates, you may wish to display the taxonomies that piece of content is assigned to. List the terms assigned to a page using the `.Page.GetTerms` method.
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>`). To render an unordered list:
### Example: List Tags in a Single Page Template
```go-html-template ```go-html-template
<ul> {{ $taxonomy := "tags" }}
{{ range (.GetTerms "tags") }} {{ with .GetTerms $taxonomy }}
<li><a href="{{ .Permalink }}">{{ .LinkTitle }}</a></li> <p>{{ (site.GetPage $taxonomy).LinkTitle }}:</p>
<ul>
{{ range . }}
<li><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></li>
{{ end }} {{ end }}
</ul> </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
```go-html-template
{{ $taxo := "directors" }} <!-- Use the plural form here -->
{{ with .Param $taxo }}
<strong>Director{{ if gt (len .) 1 }}s{{ end }}:</strong>
{{ range $index, $director := . }}
{{- if gt $index 0 }}, {{ end -}}
{{ with $.Site.GetPage (printf "/%s/%s" $taxo $director) -}}
<a href="{{ .Permalink }}">{{ $director }}</a>
{{- end -}}
{{- end -}}
{{ end }} {{ end }}
``` ```
Alternatively, you may use the [delimit template function][delimit] as a shortcut if the taxonomies should just be listed with a separator. See {{< gh 2143 >}} on GitHub for discussion. To render a comma-delimited list:
```go-html-template
{{ $taxonomy := "tags" }}
{{ with .GetTerms $taxonomy }}
<p>
{{ (site.GetPage $taxonomy).LinkTitle }}:
{{ range $k, $_ := . -}}
{{ if $k }}, {{ end }}
<a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a>
{{- end }}
</p>
{{ end }}
```
## List Content with the Same Taxonomy Term ## List Content with the Same Taxonomy Term
@ -231,9 +227,9 @@ If you are using a taxonomy for something like a series of posts, you can list i
```go-html-template ```go-html-template
<ul> <ul>
{{ range .Site.Taxonomies.series.golang }} {{ range .Site.Taxonomies.series.golang }}
<li><a href="{{ .Page.RelPermalink }}">{{ .Page.Title }}</a></li> <li><a href="{{ .Page.RelPermalink }}">{{ .Page.Title }}</a></li>
{{ end }} {{ end }}
</ul> </ul>
``` ```
@ -245,16 +241,16 @@ This would be very useful in a sidebar as “featured content”. You could even
```go-html-template ```go-html-template
<section id="menu"> <section id="menu">
<ul> <ul>
{{ range $key, $taxonomy := .Site.Taxonomies.featured }} {{ range $key, $taxonomy := .Site.Taxonomies.featured }}
<li>{{ $key }}</li> <li>{{ $key }}</li>
<ul> <ul>
{{ range $taxonomy.Pages }} {{ range $taxonomy.Pages }}
<li hugo-nav="{{ .RelPermalink }}"><a href="{{ .Permalink }}">{{ .LinkTitle }}</a></li> <li hugo-nav="{{ .RelPermalink }}"><a href="{{ .Permalink }}">{{ .LinkTitle }}</a></li>
{{ end }}
</ul>
{{ end }} {{ end }}
</ul> </ul>
{{ end }}
</ul>
</section> </section>
``` ```
@ -270,9 +266,9 @@ The following example displays all terms in a site's tags taxonomy:
```go-html-template ```go-html-template
<ul> <ul>
{{ range .Site.Taxonomies.tags }} {{ range .Site.Taxonomies.tags }}
<li><a href="{{ .Page.Permalink }}">{{ .Page.Title }}</a> {{ .Count }}</li> <li><a href="{{ .Page.Permalink }}">{{ .Page.Title }}</a> {{ .Count }}</li>
{{ end }} {{ end }}
</ul> </ul>
``` ```
@ -281,28 +277,27 @@ The following example displays all terms in a site's tags taxonomy:
This example will list all taxonomies and their terms, as well as all the content assigned to each of the terms. 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" >}} {{< code file="layouts/partials/all-taxonomies.html" >}}
<section> <ul>
<ul id="all-taxonomies"> {{ range $taxonomy, $terms := site.Taxonomies }}
{{ range $taxonomy_term, $taxonomy := .Site.Taxonomies }} <li>
{{ with $.Site.GetPage (printf "/%s" $taxonomy_term) }} {{ with site.GetPage $taxonomy }}
<li><a href="{{ .Permalink }}">{{ $taxonomy_term }}</a> <a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a>
<ul> {{ end }}
{{ range $key, $value := $taxonomy }} <ul>
<li>{{ $key }}</li> {{ range $term, $weightedPages := $terms }}
<ul> <li>
{{ range $value.Pages }} <a href="{{ .Page.RelPermalink }}">{{ .Page.LinkTitle }}</a>
<li hugo-nav="{{ .RelPermalink }}"> <ul>
<a href="{{ .Permalink }}">{{ .LinkTitle }}</a> {{ range $weightedPages }}
</li> <li><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></li>
{{ end }} {{ end }}
</ul> </ul>
{{ end }} </li>
</ul>
</li>
{{ end }}
{{ end }} {{ end }}
</ul> </ul>
</section> </li>
{{ end }}
</ul>
{{< /code >}} {{< /code >}}
## `.Site.GetPage` for Taxonomies ## `.Site.GetPage` for Taxonomies
@ -312,11 +307,11 @@ Because taxonomies are lists, the [`.GetPage` function][getpage] can be used to
{{< code file="links-to-all-tags.html" >}} {{< code file="links-to-all-tags.html" >}}
{{ $taxo := "tags" }} {{ $taxo := "tags" }}
<ul class="{{ $taxo }}"> <ul class="{{ $taxo }}">
{{ with ($.Site.GetPage (printf "/%s" $taxo)) }} {{ with ($.Site.GetPage (printf "/%s" $taxo)) }}
{{ range .Pages }} {{ range .Pages }}
<li><a href="{{ .Permalink }}">{{ .Title }}</a></li> <li><a href="{{ .Permalink }}">{{ .Title }}</a></li>
{{ end }}
{{ end }} {{ end }}
{{ end }}
</ul> </ul>
{{< /code >}} {{< /code >}}