mirror of https://github.com/gohugoio/hugo
79 lines
2.2 KiB
Markdown
79 lines
2.2 KiB
Markdown
---
|
||
title: Alphabetical
|
||
description: Returns an ordered taxonomy, sorted alphabetically by term.
|
||
categories: []
|
||
keywords: []
|
||
action:
|
||
related:
|
||
- methods/taxonomy/ByCount
|
||
returnType: page.OrderedTaxonomy
|
||
signatures: [TAXONOMY.Alphabetical]
|
||
toc: true
|
||
---
|
||
|
||
The `Alphabetical` method on a `Taxonomy` object returns an [ordered taxonomy], sorted alphabetically by [term].
|
||
|
||
While a `Taxonomy` object is a [map], an ordered taxonomy is a [slice], where each element is an object that contains the term and a slice of its [weighted pages].
|
||
|
||
{{% include "methods/taxonomy/_common/get-a-taxonomy-object.md" %}}
|
||
|
||
## Get the ordered taxonomy
|
||
|
||
Now that we have captured the “genres” Taxonomy object, let’s get the ordered taxonomy sorted alphabetically by term:
|
||
|
||
```go-html-template
|
||
{{ $taxonomyObject.Alphabetical }}
|
||
```
|
||
|
||
To reverse the sort order:
|
||
|
||
```go-html-template
|
||
{{ $taxonomyObject.Alphabetical.Reverse }}
|
||
```
|
||
|
||
To inspect the data structure:
|
||
|
||
```go-html-template
|
||
<pre>{{ debug.Dump $taxonomyObject.Alphabetical }}</pre>
|
||
```
|
||
|
||
{{% include "methods/taxonomy/_common/ordered-taxonomy-element-methods.md" %}}
|
||
|
||
## Example
|
||
|
||
With this template:
|
||
|
||
```go-html-template
|
||
{{ range $taxonomyObject.Alphabetical }}
|
||
<h2><a href="{{ .Page.RelPermalink }}">{{ .Page.LinkTitle }}</a> ({{ .Count }})</h2>
|
||
<ul>
|
||
{{ range .Pages.ByTitle }}
|
||
<li><a href="{{ .RelPermalink }}">{{ .Title }}</a></li>
|
||
{{ end }}
|
||
</ul>
|
||
{{ end }}
|
||
```
|
||
|
||
Hugo renders:
|
||
|
||
```html
|
||
<h2><a href="/genres/romance/">romance</a> (2)</h2>
|
||
<ul>
|
||
<li><a href="/books/jamaica-inn/">Jamaica inn</a></li>
|
||
<li><a href="/books/pride-and-prejudice/">Pride and prejudice</a></li>
|
||
</ul>
|
||
<h2><a href="/genres/suspense/">suspense</a> (3)</h2>
|
||
<ul>
|
||
<li><a href="/books/and-then-there-were-none/">And then there were none</a></li>
|
||
<li><a href="/books/death-on-the-nile/">Death on the nile</a></li>
|
||
<li><a href="/books/jamaica-inn/">Jamaica inn</a></li>
|
||
</ul>
|
||
```
|
||
|
||
[ordered taxonomy]: /getting-started/glossary/#ordered-taxonomy
|
||
[term]: /getting-started/glossary/#term
|
||
[map]: /getting-started/glossary/#map
|
||
[slice]: /getting-started/glossary/#slice
|
||
[term]: /getting-started/glossary/#term
|
||
[weighted pages]: /getting-started/glossary/#weighted-page
|