mirror of
https://github.com/gohugoio/hugo.git
synced 2024-07-08 01:56:15 +00:00
5fd1e74903
``` git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash ``` Closes #11925
72 lines
2 KiB
Markdown
72 lines
2 KiB
Markdown
---
|
||
title: NextInSection
|
||
description: Returns the next page within a section, relative to the given page.
|
||
categories: []
|
||
keywords: []
|
||
action:
|
||
related:
|
||
- methods/page/PrevInSection
|
||
- methods/page/Next
|
||
- methods/page/Prev
|
||
- methods/pages/Next
|
||
- methods/pages/Prev
|
||
returnType: page.Page
|
||
signatures: [PAGE.NextInSection]
|
||
---
|
||
|
||
The behavior of the `PrevInSection` and `NextInSection` methods on a `Page` object is probably the reverse of what you expect.
|
||
|
||
With this content structure:
|
||
|
||
```text
|
||
content/
|
||
├── books/
|
||
│ ├── _index.md
|
||
│ ├── book-1.md
|
||
│ ├── book-2.md
|
||
│ └── book-3.md
|
||
├── films/
|
||
│ ├── _index.md
|
||
│ ├── film-1.md
|
||
│ ├── film-2.md
|
||
│ └── film-3.md
|
||
└── _index.md
|
||
```
|
||
|
||
When you visit book-2:
|
||
|
||
- The `PrevInSection` method points to book-3
|
||
- The `NextInSection` method points to book-1
|
||
|
||
{{% note %}}
|
||
Use the opposite label in your navigation links as shown in the example below.
|
||
{{% /note %}}
|
||
|
||
```go-html-template
|
||
{{ with .NextInSection }}
|
||
<a href="{{ .RelPermalink }}">Previous in section</a>
|
||
{{ end }}
|
||
|
||
{{ with .PrevInSection }}
|
||
<a href="{{ .RelPermalink }}">Next in section</a>
|
||
{{ end }}
|
||
```
|
||
|
||
{{% note %}}
|
||
The navigation sort order may be different than the page collection sort order.
|
||
{{% /note %}}
|
||
|
||
With the `PrevInSection` and `NextInSection` methods, the navigation sort order is fixed, using Hugo’s default sort order. In order of precedence:
|
||
|
||
1. Page [weight]
|
||
2. Page [date] (descending)
|
||
3. Page [linkTitle], falling back to page [title]
|
||
4. Page file path if the page is backed by a file
|
||
|
||
For example, with a page collection sorted by title, the navigation sort order will use Hugo’s default sort order. This is probably not what you want or expect. For this reason, the Next and Prev methods on a Pages object are generally a better choice.
|
||
|
||
[date]: /methods/page/date
|
||
[weight]: /methods/page/weight
|
||
[linkTitle]: /methods/page/linktitle
|
||
[title]: /methods/page/title
|