Clarify the various next/prev methods

This commit is contained in:
Joe Mooring authored and GitHub committed 2024-08-23 07:05:33 -07:00
1 parent b5505d22af
commit bdf3ffc73f
12 files changed
+263 -322

No files matched your search

+2 -38
View File
@@ -1,6 +1,6 @@
---
title: Next
description: Returns the next page in a global page collection, relative to the given page.
description: Returns the next page in a site's collection of regular pages, relative to the current page.
categories: []
keywords: []
action:
@@ -12,42 +12,6 @@ action:
- methods/pages/Prev
returnType: page.Page
signatures: [PAGE.Next]
toc: true
---
The behavior of the `Prev` and `Next` methods on a `Page` object is probably the reverse of what you expect.
With this content structure:
```text
content/
├── pages/
│ ├── _index.md
│ ├── page-1.md <-- front matter: weight = 10
│ ├── page-2.md <-- front matter: weight = 20
│ └── page-3.md <-- front matter: weight = 30
└── _index.md
```
When you visit page-2:
- The `Prev` method points to page-3
- The `Next` method points to page-1
{{% note %}}
Use the opposite label in your navigation links as shown in the example below.
{{% /note %}}
```go-html-template
{{ with .Next }}
<a href="{{ .RelPermalink }}">Prev</a>
{{ end }}
{{ with .Prev }}
<a href="{{ .RelPermalink }}">Next</a>
{{ end }}
```
## Compare to Pages methods
{{% include "methods/_common/next-prev-on-page-vs-next-prev-on-pages.md" %}}
{{% include "methods/page/_common/next-and-prev.md" %}}