summaries.md (5388B)
1 ---
2 title: Content Summaries
3 linktitle: Summaries
4 description: Hugo generates summaries of your content.
5 date: 2017-01-10
6 publishdate: 2017-01-10
7 lastmod: 2017-01-10
8 categories: [content management]
9 keywords: [summaries,abstracts,read more]
10 menu:
11 docs:
12 parent: "content-management"
13 weight: 90
14 weight: 90 #rem
15 draft: false
16 aliases: [/content/summaries/,/content-management/content-summaries/]
17 toc: true
18 ---
19
20 With the use of the `.Summary` [page variable][pagevariables], Hugo generates summaries of content to use as a short version in summary views.
21
22 ## Summary Splitting Options
23
24 * Automatic Summary Split
25 * Manual Summary Split
26 * Front Matter Summary
27
28 It is natural to accompany the summary with links to the original content, and a common design pattern is to see this link in the form of a "Read More ..." button. See the `.RelPermalink`, `.Permalink`, and `.Truncated` [page variables][pagevariables].
29
30 ### Automatic Summary Splitting
31
32 By default, Hugo automatically takes the first 70 words of your content as its summary and stores it into the `.Summary` page variable for use in your templates. You may customize the summary length by setting `summaryLength` in your [site configuration](/getting-started/configuration/).
33
34 {{% note %}}
35 You can customize how HTML tags in the summary are loaded using functions such as `plainify` and `safeHTML`.
36 {{% /note %}}
37
38 {{% note %}}
39 The Hugo-defined summaries are set to use word count calculated by splitting the text by one or more consecutive whitespace characters. If you are creating content in a `CJK` language and want to use Hugo's automatic summary splitting, set `hasCJKLanguage` to `true` in your [site configuration](/getting-started/configuration/).
40 {{% /note %}}
41
42 ### Manual Summary Splitting
43
44 Alternatively, you may add the <code><!--more--></code> summary divider where you want to split the article.
45
46 For [Org mode content][org], use `# more` where you want to split the article.
47
48 Content that comes before the summary divider will be used as that content's summary and stored in the `.Summary` page variable with all HTML formatting intact.
49
50 {{% note "Summary Divider"%}}
51 The concept of a *summary divider* is not unique to Hugo. It is also called the "more tag" or "excerpt separator" in other literature.
52 {{% /note %}}
53
54 Pros
55 : Freedom, precision, and improved rendering. All HTML tags and formatting are preserved.
56
57 Cons
58 : Extra work for content authors, since they need to remember to type <code><!--more--></code> (or `# more` for [org content][org]) in each content file. This can be automated by adding the summary divider below the front matter of an [archetype](/content-management/archetypes/).
59
60 {{% warning "Be Precise with the Summary Divider" %}}
61 Be careful to enter <code><!--more--></code> exactly; i.e., all lowercase and with no whitespace.
62 {{% /warning %}}
63
64 ### Front Matter Summary
65
66 You might want your summary to be something other than the text that starts the article. In this case you can provide a separate summary in the `summary` variable of the article front matter.
67
68 Pros
69 : Complete freedom of text independent of the content of the article. Markup can be used within the summary.
70
71 Cons
72 : Extra work for content authors as they need to write an entirely separate piece of text as the summary of the article.
73
74 ## Summary Selection Order
75
76 Because there are multiple ways in which a summary can be specified it is useful to understand the order of selection Hugo follows when deciding on the text to be returned by `.Summary`. It is as follows:
77
78 1. If there is a <code><!--more--></code> summary divider present in the article the text up to the divider will be provided as per the manual summary split method
79 2. If there is a `summary` variable in the article front matter the value of the variable will be provided as per the front matter summary method
80 3. The text at the start of the article will be provided as per the automatic summary split method
81
82 {{% warning "Competing selections" %}}
83 Hugo uses the _first_ of the above steps that returns text. So if, for example, your article has both `summary` variable in its front matter and a <code><!--more--></code> summary divider Hugo will use the manual summary split method.
84 {{% /warning %}}
85
86 ## Example: First 10 Articles with Summaries
87
88 You can show content summaries with the following code. You could use the following snippet, for example, in a [section template][].
89
90 {{< code file="page-list-with-summaries.html" >}}
91 {{ range first 10 .Pages }}
92 <article>
93 <!-- this <div> includes the title summary -->
94 <div>
95 <h2><a href="{{ .RelPermalink }}">{{ .Title }}</a></h2>
96 {{ .Summary }}
97 </div>
98 {{ if .Truncated }}
99 <!-- This <div> includes a read more link, but only if the summary is truncated... -->
100 <div>
101 <a href="{{ .RelPermalink }}">Read More…</a>
102 </div>
103 {{ end }}
104 </article>
105 {{ end }}
106 {{< /code >}}
107
108 Note how the `.Truncated` boolean variable value may be used to hide the "Read More..." link when the content is not truncated; i.e., when the summary contains the entire article.
109
110 [org]: /content-management/formats/
111 [pagevariables]: /variables/page/
112 [section template]: /templates/section-templates/