github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-14 20:37:55 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/en/news/0.40-relnotes/index.md

6.4 KiB
Raw Blame History

date: 2018-04-23 title: "Hugo 0.40: The Revival of the Shortcodes" description: "Hugo 0.40: Shortcodes with .Content (almost) always available, processed in order of appearance, several new template funcs …" categories: ["Releases"]

Hugo 0.40 is The Revival of the Shortcodes. Shortcodes is one of the prime features in Hugo. Really useful, but it has had some known shortcomings. @bep has been really busy the last week to address those.

In summary:

  • .Content for a page retrieved in a query in a shortcode is now almost always available. Note that shortcodes can include content that can include shortcodes that can include content... It is possible to bite your tail. See more below.
  • Shortcodes are now processed and rendered in their order of appearance.
  • Related to the above, we have now added a zero-based .Ordinal to the shortcode.

The first bullet above resolves some surprising behaviour when reading other pages' content from shortcodes. Before this release, that behaviour was undefined. Note that this has never been an issue from regular templates.

It will still not be possible to get the current shortcode's page's rendered content. That would have impressed Einstein.

The new and well defined rules are:

  • .Page.Content from a shortcode will be empty. The related .Page.Truncated .Page.Summary, .Page.WordCount, .Page.ReadingTime, .Page.Plain and .Page.PlainWords will also have empty values.
  • For other pages (retrieved via .Page.Site.GetPage, .Site.Pages etc.) the .Content is there to use as you please as long as you don't have infinite content recursion in your shortcode/content setup. See below.
  • .Page.TableOfContents is good to go (but does not support shortcodes in headlines; this is unchanged)

If you get into a situation of infinite recursion, the .Content will be empty. Run hugo -v for more information.

This release represents 19 contributions by 3 contributors to the main Hugo code base.

Many have also been busy writing and fixing the documentation in hugoDocs, which has received 13 contributions by 6 contributors. A special thanks to @kaushalmodi, @anthonyfok, @bep, and @regisphilibert for their work on the documentation site.

Hugo now has:

Notes

  • We have added a timeout configuration setting. This is currently only used to time out the .Content creation, to bail out of recursive recursions. Run hugo -v to see potential warnings about this. The timeout is set default to 10000 (10 seconds).

Enhancements

Templates

Other