shithub: hugo

Info  •  Files  •  Log  •  Branches

Add index reference to go template primer doc page

Related to @bjornerik 's answer in this discussion: http://discuss.gohugo.io/t/inserting-data-from-data-file-into-content-file-newbie-question/1002/3 ... I figured I'd make myself useful and add the reference to the index function, on the go template primer page.

Also, I moved the reference links to the bottom.

A general comment: as good as these docs are, the primer at this point makes some assumptions about audience knowledge, so some might find it lacking. Once I understand better, I might make some more clarifying edits.

--- a/docs/content/templates/go-templates.md

+++ b/docs/content/templates/go-templates.md

@@ -144,6 +144,10 @@

         {{ $element }}

     {{ end }}

+The `index` function is a [Go][] built-in, and you can read about it [here][gostdlibpkgtexttemplate]. `index`:

+

+> ...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.

+

 ### Conditionals

 `if`, `else`, `with`, `or` & `and` provide the framework for handling conditional

@@ -383,10 +387,6 @@

 </nav>

 ```

-

-[go]: http://golang.org/

-[gohtmltemplate]: http://golang.org/pkg/html/template/

-

 # Template example: Show only upcoming events

 Go allows you to do more than what's shown here.  Using Hugo's

@@ -406,3 +406,7 @@

         </li>

       {{ end }}

     {{ end }}

+

+[go]: http://golang.org/

+[gohtmltemplate]: http://golang.org/pkg/html/template/

+[gostdlibpkgtexttemplate]: http://golang.org/pkg/text/template/