diff --git a/content/functions/haschildren.md b/content/functions/haschildren.md index 8974af144..415819a52 100644 --- a/content/functions/haschildren.md +++ b/content/functions/haschildren.md @@ -15,7 +15,7 @@ workson: [menus] hugoversion: relatedfuncs: [] deprecated: false -draft: false +draft: true aliases: [] needsexamples: true --- diff --git a/content/functions/hasmenucurrent.md b/content/functions/hasmenucurrent.md index 90e7ff20f..834f6f177 100644 --- a/content/functions/hasmenucurrent.md +++ b/content/functions/hasmenucurrent.md @@ -15,7 +15,7 @@ hugoversion: relatedfuncs: [] deprecated: false toc: false -draft: false +draft: true aliases: [] needsexamples: true --- diff --git a/content/functions/ismenucurrent.md b/content/functions/ismenucurrent.md index e764d8512..5f5a002db 100644 --- a/content/functions/ismenucurrent.md +++ b/content/functions/ismenucurrent.md @@ -14,8 +14,9 @@ workson: [menus] hugoversion: relatedfuncs: [] deprecated: false -draft: false +draft: true aliases: [] +needsexample: true --- Used in [menu templates](/templates/menu-templates/). diff --git a/content/functions/now.md b/content/functions/now.md index 9ef12d205..dd92fd646 100644 --- a/content/functions/now.md +++ b/content/functions/now.md @@ -5,7 +5,7 @@ description: Returns the current local time as a [`time.Time`] godocref: https://godoc.org/time#Time date: 2017-02-01 publishdate: 2017-02-01 -lastmod: 2017-02-01 +lastmod: 2017-04-30 categories: [functions] tags: [dates,time] ns: @@ -23,7 +23,7 @@ needsexamples: true For example, building your site on June 24, 2017 with the following templating: ```html -
+
© {{ now.Format "2006"}}
``` @@ -31,12 +31,12 @@ For example, building your site on June 24, 2017 with the following templating: Which will produce the following: ```html -
+
© 2017
``` -The above example also uses the [`.Format` function](/functions/format), which page includes a full listing of date formatting using Golang's layout string. +The above example uses the [`.Format` function](/functions/format), which page includes a full listing of date formatting using Golang's layout string. {{% note %}} Older Hugo themes may use the deprecated `.Now` (uppercase). Be sure to use the lowercase `.now` in your templating. diff --git a/content/functions/param.md b/content/functions/param.md index 03d12f197..edadc7972 100644 --- a/content/functions/param.md +++ b/content/functions/param.md @@ -5,31 +5,36 @@ description: Calls page or site variables into your template. godocref: date: 2017-02-01 publishdate: 2017-02-01 -lastmod: 2017-02-01 -tags: [] +lastmod: 2017-04-30 +tags: ["front matter"] categories: [functions] toc: ns: signature: ["Param KEY"] workson: [] hugoversion: -relatedfuncs: [] +relatedfuncs: [default] deprecated: false draft: false aliases: [] -wip: true --- In Hugo, you can declare [site-wide params][sitevars] (i.e. in your [configuration][]), as well as params for [individual pages][pagevars]. A common use case is to have a general value for the site and a more specific value for some of the pages (e.g., an image). -You can use the `.Param` method to call these values into your template: +You can use the `.Param` method to call these values into your template. The following will first look for an `image` param in a specific content's [front matter][]. If not found, Hugo will look for an `image` param in your site's configuration: ``` $.Param "image" ``` +{{% note %}} +The `Param` method may not consider empty strings in a content's front matter as "not found." If you are setting preconfigured front matter fields to empty strings using Hugo's archetypes, it may be best to use the [`default` function](/functions/default/) instead of `Param`. See the [related issue on GitHub](https://github.com/spf13/hugo/issues/3366). +{{% /note %}} + + [configuration]: /getting-started/configuration/ +[front matter]: /content-management/front-matter/ [pagevars]: /variables/page/ [sitevars]: /variables/site/ diff --git a/content/functions/plainify.md b/content/functions/plainify.md index 2264b6e7a..f0ceb5fdd 100644 --- a/content/functions/plainify.md +++ b/content/functions/plainify.md @@ -5,14 +5,14 @@ description: Strips any HTML and returns the plain text version of the provided godocref: date: 2017-02-01 publishdate: 2017-02-01 -lastmod: 2017-02-01 +lastmod: 2017-04-30 categories: [functions] tags: [strings] ns: signature: ["plainify INPUT"] workson: [] hugoversion: -relatedfuncs: [jsonify] +relatedfuncs: [jsonify,] deprecated: false aliases: [] --- @@ -23,7 +23,7 @@ aliases: [] {{ "BatMan" | plainify }} → "BatMan" ``` -See also the [`.PlainWords`, `.Plain`, and `.RawContent` page variables][pagevars]. +See also the `.PlainWords`, `.Plain`, and `.RawContent` [page variables][pagevars]. [pagevars]: /variables/page/ diff --git a/content/functions/readfile.md b/content/functions/readfile.md index c3d641c69..d3f64da2b 100644 --- a/content/functions/readfile.md +++ b/content/functions/readfile.md @@ -5,7 +5,7 @@ description: Reads a file from disk relative to the current project working dire godocref: date: 2017-02-01 publishdate: 2017-02-01 -lastmod: 2017-02-01 +lastmod: 2017-04-30 categories: [functions] tags: [files] ns: @@ -21,7 +21,7 @@ aliases: [] So, if you have a file with the name `README.txt` in the root of your project with the content `Hugo Rocks!`: -``` +```html {{readFile "README.txt"}} → "Hugo Rocks!" ``` diff --git a/content/functions/safeURL.md b/content/functions/safeURL.md index 7e2ef61f2..89fd24277 100644 --- a/content/functions/safeURL.md +++ b/content/functions/safeURL.md @@ -35,7 +35,8 @@ The following is an example of a sidebar partial that may be used in conjunction {{% code file="layouts/partials/bad-url-sidebar-menu.html" copy="false" %}} ```html -