fix: shortcode in inline elements

[amtanq]

Fixes Issue: #2565

BTS

Step 1: Minimum reproducible example (to break shortcodes)

<a href="{{ basic() }}">{{ basic() }}</a>

Step 2: Investigating code which references @@ZOLA_SC_PLACEHOLDER@@

• markdown.rs (renders markdown, point of interest)
• mod.rs
• parser.rs

Step 3: Investigating shortcode.render call in markdown.rs

• for samples which are rendered correctly the shortcode.render was invoked for each shortcode
• for samples which render @@ZOLA_SC_PLACEHOLDER@@, shortcode.render was NOT invoked
• source of shortcodes: html_shortcodes list (which had the shortcode references even if they were not rendered)

Step 4: Investigating missing shortcodes

• !$range.contains(&shortcode.span.start) skips shortcodes which are not in the range
• Understanding range and shortcode.span
• Understanding parsed content (cmark markdown parser)
  • iterator(event, range) where range -> range in the markdown source

Step 5: Investigating ranges

content: <pre>•  <a href="@@ZOLA_SC_PLACEHOLDER@@">@@ZOLA_SC_PLACEHOLDER@@</a>•</pre>••<a href="@@ZOLA_SC_PLACEHOLDER@@">@@ZOLA_SC_PLACEHOLDER@@</a>
note: • represents newline (replaced for easy offset calculation)
parse_tree:
  Start(HtmlBlock) 0..77
  Html(Borrowed(<pre>•)) 0..6
    Html(Borrowed(  <a href="@@ZOLA_SC_PLACEHOLDER@@">@@ZOLA_SC_PLACEHOLDER@@</a>•)) 6..70
  Html(Borrowed(</pre>•)) 70..77
  End(HtmlBlock) 0..77
  Start(Paragraph) 78..140
    InlineHtml(Borrowed(<a href="@@ZOLA_SC_PLACEHOLDER@@">)) 78..112
    Text(Borrowed(@@ZOLA_SC_PLACEHOLDER@@)) 112..135
    InlineHtml(Borrowed(</a>)) 135..139
  End(Paragraph) 78..140
shortcodes:
  17..40
  42..65
  87..110
  112..135
logs:
  Start(HtmlBlock) 0..77
  Html(Borrowed(<pre>•)) 0..6
  Html(Borrowed(  <a href="@@ZOLA_SC_PLACEHOLDER@@">@@ZOLA_SC_PLACEHOLDER@@</a>•)) 6..70
    html_render_shortcodes: Borrowed(  <a href="@@ZOLA_SC_PLACEHOLDER@@">@@ZOLA_SC_PLACEHOLDER@@</a>•) 6..70
      render_compare 17..40 6..70
      render_compare 42..65 40..70
      render_compare 87..110 65..70 [break]
      html: [Start(HtmlBlock), Html(Borrowed(<pre>•)), Html(Boxed(  <a href=")), Html(Boxed(<h4>Basic shortcode</h4>•)), Html(Boxed(">)), Html(Boxed(<h4>Basic shortcode</h4>•)), Html(Boxed(</a>•))]
  Html(Borrowed(</pre>•)) 70..77
  End(HtmlBlock) 0..77
  Start(Paragraph) 78..140
  InlineHtml(Borrowed(<a href="@@ZOLA_SC_PLACEHOLDER@@">)) 78..112
  ^^^^^^^^^^ ISSUE: render_shortcodes not called (issue propogates to next offsets)
  Text(Borrowed(@@ZOLA_SC_PLACEHOLDER@@)) 112..135
    text_render_shortcodes: Borrowed(@@ZOLA_SC_PLACEHOLDER@@) 112..135
      render_compare 87..110 112..135 [break]
      html: [Start(HtmlBlock), Html(Borrowed(<pre>•)), Html(Boxed(  <a href=")), Html(Boxed(<h4>Basic shortcode</h4>•)), Html(Boxed(">)), Html(Boxed(<h4>Basic shortcode</h4>•)), Html(Boxed(</a>•)), Html(Borrowed(</pre>•)), End(HtmlBlock), Start(Paragraph), InlineHtml(Borrowed(<a href="@@ZOLA_SC_PLACEHOLDER@@">)), Text(Boxed(@@ZOLA_SC_PLACEHOLDER@@))]
  InlineHtml(Borrowed(</a>)) 135..139
  End(Paragraph) 78..140

Step 6: Adding a test for the issue

• can_use_shortcodes_in_inline_elements in components/markdown/tests/shortcodes.rs

Step 7: Fixing the issue by accounting for InlineHtml

logs:
  Start(HtmlBlock) 0..77
  Html(Borrowed(<pre>•)) 0..6
  Html(Borrowed(  <a href="@@ZOLA_SC_PLACEHOLDER@@">@@ZOLA_SC_PLACEHOLDER@@</a>•)) 6..70
    html_render_shortcodes: Borrowed(  <a href="@@ZOLA_SC_PLACEHOLDER@@">@@ZOLA_SC_PLACEHOLDER@@</a>•) 6..70
      render_compare 17..40 6..70
      render_compare 42..65 40..70
      render_compare 87..110 65..70 [break]
      html: [Start(HtmlBlock), Html(Borrowed(<pre>•)), Html(Boxed(  <a href=")), Html(Boxed(<h4>Basic shortcode</h4>•)), Html(Boxed(">)), Html(Boxed(<h4>Basic shortcode</h4>•)), Html(Boxed(</a>•))]
  Html(Borrowed(</pre>•)) 70..77
  End(HtmlBlock) 0..77
  Start(Paragraph) 78..140
  InlineHtml(Borrowed(<a href="@@ZOLA_SC_PLACEHOLDER@@">)) 78..112
    html_render_shortcodes: Borrowed(<a href="@@ZOLA_SC_PLACEHOLDER@@">) 78..112
      render_compare 87..110 78..112
      render_compare 112..135 110..112 [break]
      html: [Start(HtmlBlock), Html(Borrowed(<pre>•)), Html(Boxed(  <a href=")), Html(Boxed(<h4>Basic shortcode</h4>•)), Html(Boxed(">)), Html(Boxed(<h4>Basic shortcode</h4>•)), Html(Boxed(</a>•)), Html(Borrowed(</pre>•)), End(HtmlBlock), Start(Paragraph), Html(Boxed(<a href=")), Html(Boxed(<h4>Basic shortcode</h4>•)), Html(Boxed(">))]
  Text(Borrowed(@@ZOLA_SC_PLACEHOLDER@@)) 112..135
    text_render_shortcodes: Borrowed(@@ZOLA_SC_PLACEHOLDER@@) 112..135
      render_compare 112..135 112..135
      html: [Start(HtmlBlock), Html(Borrowed(<pre>•)), Html(Boxed(  <a href=")), Html(Boxed(<h4>Basic shortcode</h4>•)), Html(Boxed(">)), Html(Boxed(<h4>Basic shortcode</h4>•)), Html(Boxed(</a>•)), Html(Borrowed(</pre>•)), End(HtmlBlock), Start(Paragraph), Html(Boxed(<a href=")), Html(Boxed(<h4>Basic shortcode</h4>•)), Html(Boxed(">)), Html(Boxed(<h4>Basic shortcode</h4>•))]
  InlineHtml(Borrowed(</a>)) 135..139
  End(Paragraph) 78..140

[Keats]

Sadly it's not that easy. There is #2581 which solves both (I did miss it solved the shortcode issue sorry :() but I still don't know whether the continue reading in inline html makes sense.
To keep the fix simple, it should probably be a separate branch that doesn't contain the continue reading stuff and we can decide later if we want the full #2581

[clarfonthey]

You're more the welcome to copy my code and remove the continue-reading bit, FWIW. (Aimed at both amtanq/Keats if either of you want to do it first.)

Otherwise, I'll get around to it at some point.

[amtanq]

Since you have more context on it, would appreciate if you can pick this whenever you get time. LMK if you're okay with it, else would be happy to continue myself too!

[amtanq]

Closing in favor of #2606
Thanks @clarfonthey