Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

{{ .Summary }} includes unwanted text in certain circumstances #1503

Closed
madranet opened this issue Oct 17, 2015 · 19 comments
Closed

{{ .Summary }} includes unwanted text in certain circumstances #1503

madranet opened this issue Oct 17, 2015 · 19 comments

Comments

@madranet
Copy link

When using {{ .Summary }} within a template, traditional markdown image tags [and their associated title and alt attributes] are ignored when the summary is created. So in a post beginning with:

![Beam me up Scotty!](/images/kirk.jpg "The Captain")

Lorem ipsum dolor sit amet, consectetur adipiscing elit...[etc]

The summary is correctly rendered as:

Lorem ipsum dolor sit amet, consectetur adipiscing elit...[etc]

However, if the {{% figure %}} shortcode is used to add images:

{{% figure src="/images/kirk.jpg" alt="Beam me up Scotty!" title="The Captain" %}}

Lorem ipsum dolor sit amet, consectetur adipiscing elit...[etc]

Then the title attribute is also included in the generated summary:

The Captain Lorem ipsum dolor sit amet, consectetur adipiscing elit...[etc]

This is also the case when caption is used:

{{% figure src="/images/kirk.jpg" alt="Beam me up Scotty!" caption="The Captain" %}}

Lorem ipsum dolor sit amet, consectetur adipiscing elit...[etc]

also produces:

The Captain Lorem ipsum dolor sit amet, consectetur adipiscing elit...[etc]

Interestingly, when both title and caption are used, only the content of the caption attribute is included in the generated summary.

Also, if a post begins with a list, this is included in the generated summary as well:

* Blah Blah
* Waffle Waffle
* Drone Drone

Lorem ipsum dolor sit amet, consectetur adipiscing elit...[etc]

Generates the following summary:

Blah Blah Waffle Waffle Drone Drone Lorem ipsum dolor sit amet, consectetur adipiscing elit.

The same happens when a post begins with ## mardown headers ##. The content of these is also included in the generated summary.

All of the above make summaries generated by {{ .Summary }} quite messy, when posts do not start with a paragraph of text.

SUGGESTION: {{ .Summary }} should begin summarising from the first encountered <p> tag and should strip out any content between non text-markup tags.

@mattwoolnough
Copy link

+1. Code blocks turn out quite poorly also. Not formatted in any way. Strip the code blocks out as suggested, or just stop the summary at the start of the code.

@erichiller
Copy link

+1 Agreed- this seems the perfect solutions -- @mattwoolnough "Strip the code blocks out as suggested, or just stop the summary at the start of the code."

@qw3ry
Copy link

qw3ry commented Sep 1, 2016

I have a similar issue: My page is starting with a header:
# some title
and this header is included in .Summary, but only if I use the <!--more--> somewhere in the text.

This problem makes the "<!--more-->-feature" quite useless for me as the resulting web page looks awful.

@madranet
Copy link
Author

madranet commented Jan 3, 2017

Disappointed to see this still hasn't been addressed as of version 0,18

$ hugo version
Hugo Static Site Generator v0.18.1 BuildDate: 2016-12-29T17:12:41Z

2017-01-03_14-05-19

@ghost
Copy link

ghost commented Feb 6, 2017

I for one appreciate the simplicity of the automatic summary split. Its constraints have moved me to improve my layouts by refactoring items from the content more aptly expressed in front matter.

@stale
Copy link

stale bot commented Dec 6, 2017

This issue has been automatically marked as stale because it has not had recent activity. The resources of the Hugo team are limited, and so we are asking for your help.
If this is a bug and you can still reproduce this error on the master branch, please reply with all of the information you have about it in order to keep the issue open.
If this is a feature request, and you feel that it is still relevant and valuable, please tell us why.
This issue will automatically be closed in the near future if no further activity occurs. Thank you for all your contributions.

@stale stale bot added the Stale label Dec 6, 2017
@stale stale bot closed this as completed Dec 27, 2017
@kleinschmidt
Copy link

kleinschmidt commented Oct 12, 2018

This is still an issue: including a fenced code block in the summary is, IMHO, lunacy. Perhaps an option to only include the first <p> would help?

@ghost
Copy link

ghost commented Nov 26, 2019

Is this issue not a point of concern anymore? It's been more than 4 years since this issue was opened. The summary looks messed up no matter which theme I use if I start my blog post with a title or other elements other than <p>.

@jtooker
Copy link

jtooker commented Apr 2, 2020

I agree with @pointfourone. The "automatic" summary works well at removing images and tables, but it leaves headers in. If it ignored headers too (or if there was a site configuration variable to omit them), I think it would work quite well for me. Without it, I'm forced to copy the first paragraph or so into my front matter.

@madranet
Copy link
Author

madranet commented Apr 3, 2020

I agree with @pointfourone. The "automatic" summary works well at removing images

Summary doesn't remove images in all circumstances. See my original issue posting at the top of the thread.

@khayyamsaleem
Copy link
Contributor

Could there be a solution where you could use something like a "summary-ignore" shortcode to mark off content that you want to exclude from a summary?

@khayyamsaleem
Copy link
Contributor

envisioning something like:

{{% summary-ignore %}}
{{% figure src="/images/kirk.jpg" alt="Beam me up Scotty!" caption="The Captain" %}}
{{% /summary-ignore %}}

Lorem ipsum dolor sit amet, consectetur adipiscing elit...[etc]

@musm
Copy link

musm commented Aug 9, 2020

Encountering the same problem here

@AngelCrawford
Copy link

Same Problem. Hoped I could do a workaround with the "replaceRE" Function and Regex, but it didn't worked >.<

@AngelCrawford
Copy link

As a workaround, I now create my own Summary-Split with a comment.

{{ $summarySplits := split .Content "<!--start-summary-->" }}
{{ if ge (len $summarySplits) 2 }}
    <!-- If content has the comment "start-summary", start there -->
    {{ index $summarySplits 1 | plainify | truncate 270 }}
{{ else }}
    {{ .Summary| markdownify | truncate 270 " [...]" }}
{{ end }}

In my index.md, where the content is at, I add the comment at my first <p>-Tag.

bep added a commit that referenced this issue Nov 17, 2022
32cb8785e Fix page weights in content management section (#1896)
11977b96f Make relURL and related functions consistent (#1895)
f12180207 Clarify github deployment (#1894)
958877789 Remove remaining references to Highlight.js (#1893)
fc487d263 Minor edit to taxonomy page
3b6a224b2 Update theme
b28553b62 Change "flavor" to "edition" when referring to builds (#1892)
660e7581c Replaced sudo in OpenBSD with doas (#1891)
e3fcdea10 fix a few minor grammatical issues on Firebase docs (#1889)
e4c8b30eb update Static Web Apps docs (#1890)
da2197c9e Update hosting-on-firebase.md (#1347)
5f2a0c271 Adding deployment guide for Azure Static Web Apps (#1456)
5aaf570cd add Azure Static Web App config to 404 template
35fc54362 add Azure Static Web App config to 404 template
d48f67ba1 Update 01-flavors.md
11debae8d Cleaned Use of ref and relref section, added refs of index.md and _in… (#1744)
b77604078 docs: Add link to menu entry variables (#1827)
0fa8a6bf0 Misc copy edits (#1887)
c27b545ac Improve explanation of safeHTMLAttr's function (#1503)
b04a4b32e Make CLI command summaries meaningful (#1886)
dbf00a81f Fix a typo in diagrams documentation (#1885)
11f884327 docs: Clarify how to remove draft/future/expired content (#1831)
6dc9e9860 Improve complement function (#1884)
56448a51a Remove erroneous sourcemap desc (#1883)
a0d0d2829 Merge branch 'divinerites-patch-1'
10f20cb5e Add a plausible-hugo theme component
9f1413eb5 Minor edits to showcase example
7d78420db fix broken link to Isso Comments
925cb291f Make directory tree consistent with other examples
300fff092 Add link to security policy from getenv.md (#1746)
7b4c517a6 Fix docs menu weights
ce35775e0 Update faq.md (#1763)
f3fb791a4 Remove dated new-in flags (#1879)
b6c634629 Remove deprecated templating langs (#1880)
1b25ca34f Update the findRE and replaceRE functions (#1881)
28757ec73 Add Alora Labs website to showcase (#1494)
e3c4bc4e7 Remove unimplemented "ugly" property
86afd84ff Update editors.md (#1878)
44c093911 Add urlquery function docs (#1633)
16a8c3548 Update links to installation page (#1876)
9e357f078 Add missing sections to BSD installation page (#1875)
1b1291634 Promote "Installation" to a section
9dd51235b Add detail to description of .Plain page variable (#1870)
d333d0287 Minor markdown linting fix and URL updates (#1873)
d57c8aa50 Remove extraneous apostrophe (#1871)
8c25cfc5c Update index.md
09fea41e0 Add lang to fenced code block
35b904798 Add small documentation about .Site.Social.twitter variable (#1854)
672042f89 Consolidate site configuration
dfd4dd873 Add help.ampio.com showcase. (#1863)
e8d0e7bdf Include link to internal templates code (#1794)
7db6f0c01 Add example to split function (#1867)
be87dba80 Clarify split function docs (#1792)
a079193f1 Fix typo on data templates page
b234c70ee Fix data templates page (#1855)
074232b45 Update front-matter.md (#1856)
711c8fa80 Added missing default value (#1862)
034762882 Fixed some grammar issues and typos (#1865)
764574a4d Fix spelling error
2698f2d44 update URLs to prevent redirects (#1864)
68f05fdc8 Fenced code blocks should have a language specified (#1861)
24393315b GitHub Workflows security hardening (#1859)
3eeee13bf Markdown formatting: Add Fenced code block languages (#1858)
e152cdf1f netlify: Hugo 0.105.0
4c7fc9f7e Merge branch 'tempv0.105.0'
d16710afc Change anchor reference to use relref function calls (#1853)
f52af8e4a tpl/encoding: Add noHTMLEscape option to jsonify
eca0046c4 Update hosting-on-keycdn docs (#1852)
ffbe17a48 Add note for rsync deploy command (#1415)
c482133f1 docs: Update quick start to clarify the need of extended version (#1828)
1e3b33804 use correct URL for Google Search console verification (#1851)
dac034f63 Markdown and formatting fixes (#1850)
43f177e3c Fix LiveReload in quick-start (#1739)
f78deaa5f Add link for ''Hugo Shortcode Syntax Highlighting' VS Code extension (#1765)
08087ecd7 Remove some hidden pages (#1848)
b6cb5ae48 Markdown linting fixes (#1846)
527ec5941 Update hugo.md (#1742)
83e8f2168 Clarify that a shortcode with .Inner must be closed (#1785)
4193f4445 Add Super Linter GitHub Action (#1845)
fd91bfe1a Formatting and grammar fixes (#1844)
ab5a49c49 Create codeql-analysis GitHub Action (#1812)
63b3e082e Add tutorial on using fusejs to search examples (#1756)
54c253ab0 Note that Google Universal Analytics are deprecated (#1770)
385fa77c6 Update articles.toml (#1840)
5e336bd26 Replace awkward wording (ESL?) (#1842)
2446ad349 Added Introduction to Hugo tutorial/video series (#1736)
7b21b2e76 Don't use self-closing generator tag
ef73712ff Image processing. available methods: add method 'Colors' (#1837)
018f83bbe [comment platform] - add new alternative (#1751)
5636c208b Grammar and spelling fixes (#1836)
3f2e26f77 Change link of repojacking vulnerable link - JekyllToHugo (#1834)
301379fc3 fix: use shorter image URL to make it easier to read (#1835)
de5fa7b30 Update search.md to include Pagefind (#1826)
e9d72bcda Breadcrumb example: add basic accessibility (#1832)
6cffff87a netlify: Hugo 0.104.3
892360f61 Update output-formats.md
09a7a46ae Remove my defunct and little used migrator (#1824)
347434cca netlify: Hugo 0.104.2
f8c721162 Update postcss.md
c2baf7155 netlify: Hugo 0.104.1
05d1192cd Update diagrams.md (#1823)
3c43a8bbe netlify: Hugo 0.104.0
57973b334 Merge branch 'tempv0.104.0'
da775a36d docs: Regen docs helper
ae48b5901 docs: Regenerate CLI docs
af4a823b1 resources/images: Add $image.Colors
8e3f9ca64 Remove outdated IE conditional comments example (#1821)
d1a84701b fix typo in template introduction (#1820)
c0c7339e0 Update internal.md
17aefc515 Remove the recommendation about where to put the GA tempalte
263297236 Adjust GA template instructions
1cc265d99 Update the GA template usage section
e11968338 config/security: Allow proxy variables in subcommands
9218ab993 netlify: Hugo 0.103.1
0b0e890d1 Update markdownify and RenderString documentation (#1818)
50f5d4776 Fix internal link (#1817)
6beb443c5 netlify: Hugo 0.103.0
14b5af248 Merge branch 'tempv0.103.0'
548e7aa62 server: Add 404 support
3a20aa0ba Update theme

git-subtree-dir: docs
git-subtree-split: 32cb8785ea74d5b82f2e2bea79d059cab497902a
@willfaught
Copy link

I'm seeing shortcode syntax appearing in .Summary:

Basic Code: {{< paige/vimeo "644036051" >}} Result: Video parameter Code: {{< paige/vimeo video="644036051" >}} Result: All parameters Code:

@frankenstein91
Copy link

envisioning something like:

{{% summary-ignore %}}
{{% figure src="/images/kirk.jpg" alt="Beam me up Scotty!" caption="The Captain" %}}
{{% /summary-ignore %}}

Lorem ipsum dolor sit amet, consectetur adipiscing elit...[etc]

would love it

frankenstein91 added a commit to frankenstein91/DO3EET-webseite that referenced this issue May 5, 2024
@bep bep added this to the v0.131.0 milestone Jul 30, 2024
@bep bep modified the milestones: v0.131.0, v0.133.0 Aug 9, 2024
@bep bep modified the milestones: v0.133.0, Unscheduled Aug 29, 2024
@jmooring
Copy link
Member

jmooring commented Sep 19, 2024

As of v0.134.0 this is no longer relevant.

See:

As a general note, the "automatic" summary does not magically summarize content. Instead, it renders the first N rendered paragraphs depending on the summaryLength value in your site configuration.

If your content begins with something other than text, it probably makes more sense to use one of the other summary methods:

Also note that v0.134.0 and later include a ContentWithoutSummary matho on Page.

Copy link

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 11, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests