mirror of
https://github.com/gohugoio/hugo.git
synced 2026-09-02 19:52:38 +00:00
Bjørn Erik Pedersen
2c0d1ccdcd
73f355ceUpdate theme83ff50c2Use example.com in examples71292134Add alias news > release-notes2e15f642Update theme8eef09d2Add Pygments configuration572b9e75Clean up the code shortcode usea1b2fd3bRemove the code fence language codes1473b1d9Remove redundant textb92c2042Update theme8f439c28Edit contributing section in README8bcf8a19Add contributing section to README4c44ee1cFix broken content file2bdc7710Clarify .Data.Pages sorting in lists.md092271c2Use infinitive mood for main titlesb9b8abefUpdate theme to reflect change to home page contentb897b71bChange copy to use sentence casefd675ee5Enable RSS feed for sections060a5e27Correct movie title in taxonomies.md6a5ca96aUpdate displayed site name for Hub22f4b7a4Add example of starting up the local serverd9612cb3Update themea8c3988aUpdate theme4198189dUpdate theme12d6b016Update theme2b1c4197Update themeb6d90a1eFix News release titlescfe751dbAdd some build info to README git-subtree-dir: docs git-subtree-split:73f355ce0d
85 lines
2.8 KiB
Markdown
85 lines
2.8 KiB
Markdown
---
|
|
title: index
|
|
linktitle: index
|
|
description: Looks up the index(es) or key(s) of the data structure passed into it.
|
|
godocref: https://golang.org/pkg/text/template/#hdr-Functions
|
|
date: 2017-02-01
|
|
publishdate: 2017-02-01
|
|
lastmod: 2017-02-01
|
|
categories: [functions]
|
|
menu:
|
|
docs:
|
|
parent: "functions"
|
|
#tags: []
|
|
signature: ["index COLLECTION INDEX", "index COLLECTION KEY"]
|
|
workson: []
|
|
hugoversion:
|
|
relatedfuncs: []
|
|
deprecated: false
|
|
aliases: [/functions/index/]
|
|
needsexample: true
|
|
---
|
|
|
|
From the Godocs:
|
|
|
|
> Returns the result of indexing its first argument by the following arguments. Thus "index x 1 2 3" is, in Go syntax, x[1][2][3]. Each indexed item must be a map, slice, or array.
|
|
|
|
In Go templates, you can't access array, slice, or map elements directly the same way you would in Go. For example, `$.Site.Data.authors[.Params.authorkey]` isn't supported syntax.
|
|
|
|
Instead, you have to use `index`, a function that handles the lookup for you.
|
|
|
|
## Example: Load Data from a Path Based on Front Matter Params
|
|
|
|
Assume you want to add a `location = ""` field to your front matter for every article written in `content/vacations/`. You want to use this field to populate information about the location at the bottom of the article in your `single.html` template. You also have a directory in `data/locations/` that looks like the following:
|
|
|
|
```
|
|
.
|
|
└── data
|
|
└── locations
|
|
├── abilene.toml
|
|
├── chicago.toml
|
|
├── oslo.toml
|
|
└── provo.toml
|
|
```
|
|
|
|
Here is an example of the data inside `data/locations/oslo.toml`:
|
|
|
|
```
|
|
website = "https://www.oslo.kommune.no"
|
|
pop_city = 658390
|
|
pop_metro = 1717900
|
|
```
|
|
|
|
The example we will use will be an article on Oslo, which front matter should set to exactly the same name as the corresponding file name in `data/locations/`:
|
|
|
|
```
|
|
title = "My Norwegian Vacation"
|
|
location = "oslo"
|
|
```
|
|
|
|
The content of `oslo.toml` can be accessed from your template using the following node path: `.Site.Data.locations.oslo`. However, the specific file you need is going to change according to the front matter.
|
|
|
|
This is where the `index` function is needed. `index` takes 2 parameters in this use case:
|
|
|
|
1. The node path
|
|
2. A string corresponding to the desired data; e.g.—
|
|
|
|
```
|
|
{{ index .Site.Data.locations “oslo” }}
|
|
```
|
|
|
|
The variable for `.Params.location` is a string and can therefore replace `oslo` in the example above:
|
|
|
|
```
|
|
{{ index .Site.Data.authors .Params.author }}
|
|
=> map[website:https://www.oslo.kommune.no pop_city:658390 pop_metro:1717900]
|
|
```
|
|
|
|
Now the call will return the specific file according to the location specified in the content's front matter, but you will likely want to write specific properties to the template. You can do this by continuing down the node path via dot notation (`.`):
|
|
|
|
```
|
|
{{ (index .Site.Data.locations .Params.location).pop_city }}
|
|
=> 658390
|
|
```
|
|
|