diff options
Diffstat (limited to 'docs/content/en/content-management/summaries.md')
| -rw-r--r-- | docs/content/en/content-management/summaries.md | 28 |
1 files changed, 15 insertions, 13 deletions
diff --git a/docs/content/en/content-management/summaries.md b/docs/content/en/content-management/summaries.md index 74c5623cb..2ff1fec34 100644 --- a/docs/content/en/content-management/summaries.md +++ b/docs/content/en/content-management/summaries.md @@ -8,11 +8,13 @@ menu: docs: parent: content-management weight: 160 -toc: true weight: 160 +toc: true aliases: [/content/summaries/,/content-management/content-summaries/] --- +<!--more--> + With the use of the `.Summary` [page variable][pagevariables], Hugo generates summaries of content to use as a short version in summary views. ## Summary splitting options @@ -37,7 +39,7 @@ The Hugo-defined summaries are set to use word count calculated by splitting the ### Manual summary splitting -Alternatively, you may add the <code><!--more--></code> summary divider where you want to split the article. +Alternatively, you may add the `<!--more-->` summary divider where you want to split the article. For [Org mode content][org], use `# more` where you want to split the article. @@ -48,42 +50,42 @@ The concept of a *summary divider* is not unique to Hugo. It is also called the {{% /note %}} Pros -: Freedom, precision, and improved rendering. All HTML tags and formatting are preserved. +: Freedom, precision, and improved rendering. All HTML tags and formatting are preserved. Cons -: 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/). +: Extra work for content authors, since they need to remember to type `<!--more-->` (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/). -{{% warning "Be Precise with the Summary Divider" %}} -Be careful to enter <code><!--more--></code> exactly; i.e., all lowercase and with no whitespace. +{{% note %}} +Be careful to enter `<!--more-->` exactly; i.e., all lowercase and with no whitespace. {{% /note %}} ### Front matter summary -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. +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. Pros -: Complete freedom of text independent of the content of the article. Markup can be used within the summary. +: Complete freedom of text independent of the content of the article. Markup can be used within the summary. Cons : Extra work for content authors as they need to write an entirely separate piece of text as the summary of the article. ## Summary selection order -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: +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: -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 +1. If there is a `<!--more-->`> summary divider present in the article the text up to the divider will be provided as per the manual summary split method 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 3. The text at the start of the article will be provided as per the automatic summary split method -{{% warning "Competing selections" %}} -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. +{{% note %}} +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 `<!--more-->` summary divider Hugo will use the manual summary split method. {{% /note %}} ## Example: first 10 articles with summaries You can show content summaries with the following code. You could use the following snippet, for example, in a [section template]. -{{< code file="page-list-with-summaries.html" >}} +{{< code file=page-list-with-summaries.html >}} {{ range first 10 .Pages }} <article> <!-- this <div> includes the title summary --> |