Exisistence of Shortcode Parameters

dkebler · April 1, 2017, 8:51pm

these work fine in that they are site or page parameters
{{ if .Site.Params.myparameter }} {{ end }}
{{ with .Site.Params.myparameter }} {{ end }}

but…can’t get similar syntax to work for shortcode parameters.

example of things that DON’T work

{{ if .Get "size" }} only do if exists  {{ end }}
{{ if isset (.Get "size") }} only do if exists  {{ end }}
this one gives error "wrong number of args for isset: want 2 got 1"
{{ if isset .Get "size" }} only do if exists  {{ end }}
wrong number of args for Get: want 1 got 0
{{ with .Get "size"  }} only do if exists  {{ end }}
nor
with  (.Get "size")  in the above.

Am I having a syntax issue or a scoping issue. I don’t know the error messages I get from Hugo are not helping.
What is the proper way to test for existence of shortcode parameters?
Must I use scratch like this?? https://discuss.gohugo.io/t/solved-setting-a-variable-to-one-of-two-values-in-a-shortcode/4444/6

dkebler · April 1, 2017, 9:25pm

ok this works

{{ $.Scratch.Set "size" (.Get "size") }}
{{ $size := $.Scratch.Get "size" }}
{{ if $size }}
<div class="">
  <p>What was in "size" if of course it exists {{ $size }}</p>
</div>
{{ end }}

so is this my only option?? Some explanation would be helpful @bep or @moorereason thx

bep · April 1, 2017, 10:04pm

Both with and if should work fine in your case. The built-in figure shortcode is battle-tested in this area:

github.com

gohugoio/hugo/blob/master/tpl/tplimpl/template_embedded.go

// Copyright 2017-present The Hugo Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package tplimpl

func (t *templateHandler) embedShortcodes() {
	t.addInternalShortcode("ref.html", `{{ if len .Params | eq 2 }}{{ ref .Page (.Get 0) (.Get 1) }}{{ else }}{{ ref .Page (.Get 0) }}{{ end }}`)
	t.addInternalShortcode("relref.html", `{{ if len .Params | eq 2 }}{{ relref .Page (.Get 0) (.Get 1) }}{{ else }}{{ relref .Page (.Get 0) }}{{ end }}`)
	t.addInternalShortcode("highlight.html", `{{ if len .Params | eq 2 }}{{ highlight (trim .Inner "\n\r") (.Get 0) (.Get 1) }}{{ else }}{{ highlight (trim .Inner "\n\r") (.Get 0) "" }}{{ end }}`)
	t.addInternalShortcode("test.html", `This is a simple Test`)

This file has been truncated. show original

dkebler · April 1, 2017, 10:43pm

Indeed it’s as I I thought! thx @bep for confirmation

Ok so It’s working now…! {{ with .Get “icon” }}

<a
{{ if eq (.Get "display") "tab" }}target="_blank"{{ end }}
{{ if eq (.Get "display") "modal" }}rel="modal:open"{{ end }}
{{ if eq (.Get "type") "btn" }}class="box box--btn btn btn--{{ .Get "size" | default "regular" }}"{{ end }}
href="{{ .Get "url" }}">
{{ with .Get "icon" }}<i class="btn__icon fa fa-{{ . }}"></i>{{ end }}
{{ if eq (.Get "type") "btn" }}<div class="btn__text">{{ .Get "text" }}</div>
{{ else }}
{{ .Get "text" }}
{{ end }}
</a>

shrug…I have had nothing but trouble today getting what should work to work. I have to keep stopping the server and restarting and refreshing the browser to see my changes to the shortcode which hasn’t been the case. I’m sure it’s related to why this is not being compiled consistently. Time to reboot my machine maybe.

vincedo · April 26, 2017, 1:55pm

How would you test the presence of a positional parameter?

In my case, I have a shortcode with 2 positional parameters. The first one is required, and the second one is optional. I can’t find a way to test whether the second parameter is defined or not.

None of this works:

{{ if isset .Get 1 }}<h4>{{ .Get 1 | markdownify }}</h4>{{ end }}
{{ with (.Get 1) }}<h4>{{ .Get 1 | markdownify }}</h4>{{ end }}

rdwatters · April 26, 2017, 2:20pm

Remember that with binds the context, so replace your with statement with {{ . | markdownify }} and LMK if that works…

vincedo · April 26, 2017, 3:13pm

Right. I forgot about that, thanks.

Unfortunately it still doesn’t work. The following message appears in the HTML at the location of the .Get 1 param :

error: index out of range for positional param at position 1

rdwatters · April 26, 2017, 4:06pm

Can you point me to a bit more of your templating? I need some more context.

vincedo · April 26, 2017, 4:26pm

Sure.

Here’s the template for my shortcode (in MYTHEME/layouts/shortcodes/alert.html) :

<!-- NB. This version produces the "index out of range" error -->
<div class="alert alert-{{ .Get 0 }}" role="alert">
  {{ with (.Get 1) }}<h4 class="alert-heading">{{ . | markdownify }}</h4>{{ end }}
  {{ .Inner }}
</div>

And this is how I invoke the shortcode :

<!-- NB. Removing "Some title" triggers the index out of range error -->
{{% alert warning "Some title" %}}
Some content
{{% /alert %}}

rdwatters · April 26, 2017, 4:30pm

Can you do me a favor and see what happens if you put the “warning” in quotes…

I appreciates this isn’t the best debugging approach, btw, but I’m not really at my computer and just sporadically trying to throw out some ideas here…

vincedo · April 26, 2017, 4:32pm

No problem at all. And thanks for your help btw.

The “warning” in quotes makes no difference. The error is still here.

rdwatters · April 26, 2017, 4:43pm

Hmmm. Odd. How about the following?

<div class="alert alert-{{ .Get 0 }}" role="alert">
  {{ if ne (.Get 1) "" }}<h4 class="alert-heading">{{ .Get 1 | markdownify }}</h4>{{ end }}
  {{ .Inner }}
</div>

Again, not tested and just spitballing…

rdwatters · April 26, 2017, 4:44pm

Also, if you are adding and removing shortcodes with the live server, please try and kill and then restart the server. Oh, and what version of Hugo are you using when you run hugo version…

vincedo · April 26, 2017, 4:53pm

Same error with {{ if ne (.Get 1) "" }}. From the error message it looks like I can’t access index 1 of .Get so it kind of makes sense that the code above triggers the error.

What I don’t get is why this fails: {{ if isset .Get 1 }}

I’m using Hugo v0.20.

rdwatters · April 26, 2017, 5:39pm

So let me ask some more basic questions:

You are definitely calling these inside your content files, correct?
Are you sure that every time you call the shortcode, you’re doing so in a uniform manner?
What version of Hugo are you using?
Did you try my recommendation to kill the server and start it again in the event that you are creating these in development?

Something is going on at the templating level. As bep mentions above, the with statements are well battle tested for the embedded templates:

github.com

gohugoio/hugo/blob/master/tpl/tplimpl/template_embedded.go

// Copyright 2017-present The Hugo Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package tplimpl

func (t *templateHandler) embedShortcodes() {
	t.addInternalShortcode("ref.html", `{{ if len .Params | eq 2 }}{{ ref .Page (.Get 0) (.Get 1) }}{{ else }}{{ ref .Page (.Get 0) }}{{ end }}`)
	t.addInternalShortcode("relref.html", `{{ if len .Params | eq 2 }}{{ relref .Page (.Get 0) (.Get 1) }}{{ else }}{{ relref .Page (.Get 0) }}{{ end }}`)
	t.addInternalShortcode("highlight.html", `{{ if len .Params | eq 2 }}{{ highlight (trim .Inner "\n\r") (.Get 0) (.Get 1) }}{{ else }}{{ highlight (trim .Inner "\n\r") (.Get 0) "" }}{{ end }}`)
	t.addInternalShortcode("test.html", `This is a simple Test`)

This file has been truncated. show original

Can you point me to a repo? I get the feeling maybe you are calling one of these shortcodes differently in one of your content files…

vincedo · April 26, 2017, 7:52pm

1. You are definitely calling these inside your content files, correct?

Yes.

2. Are you sure that every time you call the shortcode, you’re doing so in a uniform manner?

Yes. I’m calling it exactly the way the way I showed you in here.

3. What version of Hugo are you using?

v0.20

4. Did you try my recommendation to kill the server and start it again in the event that you are creating these in development?

Yes, after each variation I tried.

The code sample you provided used named parameters, not positional ones. I’m thinking I need to use named parameters too to get it to work. Anyways, thanks a lot for your time and your help.

Topic		Replies	Views
How to check if a param exists and equals a certain value? support	3	1758	March 27, 2019
Testing for optional shortocde parameters - isset and with errors support	12	4060	July 3, 2021
Shortcode parameter in if statement [solved] support	3	1661	September 23, 2017
[SOLVED] Setting a variable to one of two values in a shortcode support	6	1302	November 3, 2016
Issue with shortcode param lengths	2	712	April 6, 2018

Exisistence of Shortcode Parameters

Related topics