mirror of
https://github.com/tiennm99/hugoDocs.git
synced 2026-09-13 18:19:10 +00:00
90 lines
3.6 KiB
Markdown
90 lines
3.6 KiB
Markdown
---
|
||
title: Introduction to Lists in Hugo
|
||
linktitle: Hugo Lists
|
||
description: Lists have a specific meaning and usage in Hugo. If you want to know how to render your site homepage, section homepage, taxonomy list, or taxonomy terms list, start here.
|
||
date: 2017-02-01
|
||
publishdate: 2017-02-01
|
||
lastmod: 2017-02-01
|
||
categories: [templates]
|
||
tags: [lists,sections,rss,taxonomies,terms]
|
||
weight: 22
|
||
draft: false
|
||
aliases: [/templates/list/,/layout/indexes/]
|
||
toc: true
|
||
wip: true
|
||
---
|
||
|
||
## What is a List Page Template?
|
||
|
||
A list page template is a template used to render multiple pieces of content in a single HTML page (with the exception of the homepage, which has a [dedicated template][homepage]).
|
||
|
||
Hugo uses the term *list* in its truest sense; i.e. a sequential arrangement of material, especially in alphabetical or numerical order. Hugo uses list templates on any output HTML page where content is traditionally listed:
|
||
|
||
* [Taxonomy terms pages][taxterms]
|
||
* [Taxonomy list pages][taxlists]
|
||
* [Section list pages][sectiontemps]
|
||
* [RSS][rss]
|
||
|
||
The idea of a list page comes from the [hierarchical mental model of the web][mentalmodel] and is best demonstrated visually:
|
||
|
||
|
||
|
||
## List Defaults
|
||
|
||
### Default Templates
|
||
|
||
Since section lists and taxonomy lists (N.B., *not* [taxonomy terms lists][taxterms]) are both *lists* with regards to their templates, both have the same terminating default of `_default/list.html`---or `themes/<THEME>/layouts/_default/list.html` in the case of a themed project---in their *lookup orders*. In addition, both [section lists][sectiontemplates] and [taxonomy lists][taxonomies] have their own default list templates in `_default`:
|
||
|
||
#### Default Section Templates
|
||
|
||
1. `layouts/section/<SECTIONNAME>.html`
|
||
2. `layouts/section/list.html`
|
||
3. `layouts/_default/section.html`
|
||
4. `layouts/_default/list.html`
|
||
|
||
|
||
### Taxonomy RSS
|
||
|
||
A Taxonomy’s RSS will be rendered at /`PLURAL`/`TERM`/index.xml (e.g. http://spf13.com/topics/golang/index.xml)
|
||
|
||
*Hugo ships with its own [RSS 2.0][] template. In most cases this will
|
||
be sufficient, and an RSS template will not need to be provided by the
|
||
user.*
|
||
|
||
Hugo provides the ability for you to define any RSS type you wish, and
|
||
can have different RSS files for each section and taxonomy.
|
||
|
||
* /layouts/taxonomy/`SINGULAR`.rss.xml
|
||
* /layouts/\_default/rss.xml
|
||
* /themes/`THEME`/layouts/taxonomy/`SINGULAR`.rss.xml
|
||
* /themes/`THEME`/layouts/\_default/rss.xml
|
||
|
||
## Variables
|
||
|
||
A list page is a `Page` and have all the [page variables](/templates/variables/)
|
||
and [site variables](/templates/variables/) available to use in the templates.
|
||
|
||
Taxonomy pages will additionally have:
|
||
|
||
**.Data.`Singular`** The taxonomy itself.<br>
|
||
|
||
|
||
|
||
{{% note %}}
|
||
If `where` or `first` receives invalid input or a field name that doesn’t exist, it will return an error and stop site generation. `where` and `first` also work on taxonomy list templates *and* taxonomy terms templates. (See [Taxonomy Templates](/templates/taxonomy-templates/).)
|
||
{{% /note %}}
|
||
|
||
|
||
[directorystructure]: /getting-started/directory-structure/
|
||
[homepage]: /templates/homepage/
|
||
[homepage]: /templates/homepage/
|
||
[limitkeyword]: https://www.techonthenet.com/sql/select_limit.php
|
||
[mentalmodel]: http://webstyleguide.com/wsg3/3-information-architecture/3-site-structure.html
|
||
[partials]: /templates/partials/
|
||
[RSS 2.0]: http://cyber.law.harvard.edu/rss/rss.html "RSS 2.0 Specification"
|
||
[rss]: /templates/rss-templates/
|
||
[sections]: /content-management/sections/
|
||
[sectiontemps]: /templates/section-templates
|
||
[taxlists]: /templates/taxonomy-templates/#taxonomy-list-templates/
|
||
[taxterms]: /templates/taxonomy-templates/#taxonomy-terms-templates/
|