aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/content/en/methods/page/Truncated.md
blob: e6051f0cd4a274713bc9cdc8e93634384a7088c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
---
title: Truncated
description: Reports whether the content length exceeds the summary length.
categories: []
keywords: []
action:
  related:
    - methods/page/Summary
  returnType: bool
  signatures: [PAGE.Truncated]
---

There are three ways to define the [content summary]:

1. Let Hugo create the summary based on the first 70 words. You can change the number of words by setting the `summaryLength` in your site configuration.
2. Manually split the content with a `<--more-->` tag in markdown. Everything before the tag is included in the summary.
3. Create a `summary` field in front matter.

{{% note %}}
The `Truncated` method returns `false` if you define the summary in front matter.
{{% /note %}}

The `Truncated` method returns `true` if the content length exceeds the summary length. This is useful for rendering a "read more" link:

```go-html-template
{{ range .Pages }}
  <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
  {{ .Summary }}
  {{ if .Truncated }}
    <a href="{{ .RelPermalink }}">Read more...</a>
  {{ end }}
{{ end }}
```

[content summary]: /content-management/summaries