diff options
Diffstat (limited to 'docs/content/en/methods/page')
| -rw-r--r-- | docs/content/en/methods/page/Next.md | 40 | ||||
| -rw-r--r-- | docs/content/en/methods/page/NextInSection.md | 60 | ||||
| -rw-r--r-- | docs/content/en/methods/page/Prev.md | 44 | ||||
| -rw-r--r-- | docs/content/en/methods/page/PrevInSection.md | 61 | ||||
| -rw-r--r-- | docs/content/en/methods/page/_common/next-and-prev.md | 60 | ||||
| -rw-r--r-- | docs/content/en/methods/page/_common/nextinsection-and-previnsection.md | 78 |
6 files changed, 148 insertions, 195 deletions
diff --git a/docs/content/en/methods/page/Next.md b/docs/content/en/methods/page/Next.md index 57fc1f2f8..ff0525700 100644 --- a/docs/content/en/methods/page/Next.md +++ b/docs/content/en/methods/page/Next.md @@ -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" %}} diff --git a/docs/content/en/methods/page/NextInSection.md b/docs/content/en/methods/page/NextInSection.md index 59a35d03d..640e9b44a 100644 --- a/docs/content/en/methods/page/NextInSection.md +++ b/docs/content/en/methods/page/NextInSection.md @@ -1,71 +1,15 @@ --- title: NextInSection -description: Returns the next page within a section, relative to the given page. +description: Returns the next regular page in 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/ +{{% include "methods/page/_common/nextinsection-and-previnsection.md" %}} diff --git a/docs/content/en/methods/page/Prev.md b/docs/content/en/methods/page/Prev.md index b1a503af5..d28b50265 100644 --- a/docs/content/en/methods/page/Prev.md +++ b/docs/content/en/methods/page/Prev.md @@ -1,53 +1,17 @@ --- title: Prev -description: Returns the previous page in a global page collection, relative to the given page. +description: Returns the previous page in a site's collection of regular pages, relative to the current page. categories: [] keywords: [] action: related: - methods/page/Next - - methods/page/PrevInSection - methods/page/NextInSection - - methods/pages/Prev + - methods/page/PrevInSection - methods/pages/Next + - methods/pages/Prev returnType: page.Page signatures: [PAGE.Prev] -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" %}} diff --git a/docs/content/en/methods/page/PrevInSection.md b/docs/content/en/methods/page/PrevInSection.md index e6daf66c4..aaafb367e 100644 --- a/docs/content/en/methods/page/PrevInSection.md +++ b/docs/content/en/methods/page/PrevInSection.md @@ -1,72 +1,15 @@ --- title: PrevInSection -description: Returns the previous page within a section, relative to the given page. +description: Returns the previous regular page in a section, relative to the given page. categories: [] keywords: [] action: related: - methods/page/NextInSection - - methods/page/Next - methods/pages/Next - - methods/page/Prev - methods/pages/Prev returnType: page.Page signatures: [PAGE.PrevInSection] --- - -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/ +{{% include "methods/page/_common/nextinsection-and-previnsection.md" %}} diff --git a/docs/content/en/methods/page/_common/next-and-prev.md b/docs/content/en/methods/page/_common/next-and-prev.md new file mode 100644 index 000000000..0d1436e11 --- /dev/null +++ b/docs/content/en/methods/page/_common/next-and-prev.md @@ -0,0 +1,60 @@ +--- +# Do not remove front matter. +--- + +Hugo determines the _next_ and _previous_ page by sorting the site's collection of regular pages according to this sorting hierarchy: + +Field|Precedence|Sort direction +:--|:--|:-- +[`weight`]|1|descending +[`date`]|2|descending +[`linkTitle`]|3|descending +[`path`]|4|descending + +[`date`]: /methods/page/date/ +[`weight`]: /methods/page/weight/ +[`linkTitle`]: /methods/page/linktitle/ +[`path`]: /methods/page/path/ + +The sorted page collection used to determine the _next_ and _previous_ page is independent of other page collections, which may lead to unexpected behavior. + +For example, 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 +``` + +And these templates: + +{{< code file=layouts/_default/list.html >}} +{{ range .Pages.ByWeight }} + <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2> +{{ end }} +{{< /code >}} + +{{< code file=layouts/_default/single.html >}} +{{ with .Prev }} + <a href="{{ .RelPermalink }}">Previous</a> +{{ end }} + +{{ with .Next }} + <a href="{{ .RelPermalink }}">Next</a> +{{ end }} +{{< /code >}} + +When you visit page-2: + +- The `Prev` method points to page-3 +- The `Next` method points to page-1 + +To reverse the meaning of _next_ and _previous_ you can change the sort direction in your [site configuration], or use the [`Next`] and [`Prev`] methods on a `Pages` object for more flexibility. + +[site configuration]: getting-started/configuration/#configure-page +[`Next`]: /methods/pages/prev +[`Prev`]: /methods/pages/prev diff --git a/docs/content/en/methods/page/_common/nextinsection-and-previnsection.md b/docs/content/en/methods/page/_common/nextinsection-and-previnsection.md new file mode 100644 index 000000000..6c558b69e --- /dev/null +++ b/docs/content/en/methods/page/_common/nextinsection-and-previnsection.md @@ -0,0 +1,78 @@ +--- +# Do not remove front matter. +--- + +Hugo determines the _next_ and _previous_ page by sorting the current section's regular pages according to this sorting hierarchy: + +Field|Precedence|Sort direction +:--|:--|:-- +[`weight`]|1|descending +[`date`]|2|descending +[`linkTitle`]|3|descending +[`path`]|4|descending + +[`date`]: /methods/page/date/ +[`weight`]: /methods/page/weight/ +[`linkTitle`]: /methods/page/linktitle/ +[`path`]: /methods/page/path/ + +The sorted page collection used to determine the _next_ and _previous_ page is independent of other page collections, which may lead to unexpected behavior. + +For example, 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 +``` + +And these templates: + +{{< code file=layouts/_default/list.html >}} +{{ range .Pages.ByWeight }} + <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2> +{{ end }} +{{< /code >}} + +{{< code file=layouts/_default/single.html >}} +{{ with .PrevInSection }} + <a href="{{ .RelPermalink }}">Previous</a> +{{ end }} + +{{ with .NextInSection }} + <a href="{{ .RelPermalink }}">Next</a> +{{ end }} +{{< /code >}} + +When you visit page-2: + +- The `PrevInSection` method points to page-3 +- The `NextInSection` method points to page-1 + +To reverse the meaning of _next_ and _previous_ you can change the sort direction in your [site configuration], or use the [`Next`] and [`Prev`] methods on a `Pages` object for more flexibility. + +[site configuration]: getting-started/configuration/#configure-page +[`Next`]: /methods/pages/prev +[`Prev`]: /methods/pages/prev + +## Example + +Code defensively by checking for page existence: + +```go-html-template +{{ with .PrevInSection }} + <a href="{{ .RelPermalink }}">Previous</a> +{{ end }} + +{{ with .NextInSection }} + <a href="{{ .RelPermalink }}">Next</a> +{{ end }} +``` + +## Alternative + +Use the [`Next`] and [`Prev`] methods on a `Pages` object for more flexibility. |