Macro: how to have a field with content with new lines

Help / Discuss
1

Hi.

I wrote a small macro for spoilers. The only thing missing is that the spoiler content can’t have new lines. It’s plain text in the end. Wiki syntax is working.

I guess it’s a question of the parameter type. Currently I don’t have any type configured. It should look like a textarea.

Any hints? Regards, Simpel

2

Hi @Simpel,

Is your macro doing something close to https://extensions.xwiki.org/xwiki/bin/view/Extension/Spoiler%20Macro?

3

A bit. Ours looks like:
image

Its pure html <details> due to accessibility. I try to check the extension you mentioned.

4

Ok. I did test it. It’s not accessible by keyboard. So no, nothing for us.

The ShowHide macro lacks the same.

This is the code for our “spoiler” macro:

{{velocity}}
#set ($title = $xcontext.macro.params.title)
#set ($content = $xcontext.macro.params.content)
#if($title && $content)
  {{html clean="false" wiki="true"}}
  <style>
  .spoiler {
    margin-bottom: 10px;
  }
  details[open] > summary {
    margin-bottom: 10px;
  }
  summary {
    display: list-item;
    cursor: pointer;
  }
  summary:focus {
    box-shadow: none !important;
  }
  </style>
  <details class="spoiler">
    <summary>$title</summary>
    $content
  </details>
  {{/html}}
#end
{{/velocity}}
5

You should use {{wikimacrocontent/}} and {{wikimacroparameter name="title" /}} to display the content/title. This ensures that the content is rendered correctly and that it is not vulnerable to XWiki syntax injection and XSS (see our security guide on how to escape content). You could take the expand macro as an example, this should fulfil your requirements I think.

1 Like
6

Two problems with that solution.

First the list item marker of the summary isn’t inline any more. That could be fixed with:

summary > p {
    display: inline;
}

But second more important: I can’t use any styling for the content. Any suggestion?

Simpel

7

Maybe you didn’t configure the macro content type properly (i.e., as WIKI)?

Regarding the title, I think there is a bug in the wiki macro renderer that doesn’t remove the wrapping paragraph when then parameter doesn’t support XWiki syntax. It might better when you specify the parameter type as WIKI, but I’m also not sure if the “inline” detection works in that mix of HTML and XWiki syntax. If you don’t want to support formatting, you could also just use the same code as the expand macro, i.e., $services.rendering.escape($escapetool.xml("${wikimacro.parameters.title}"), 'xwiki/2.1').

8

Ha. I did set content type to WIKI but didn’t recognize, that in your proposal “content” isn’t a parameter any more. It’s working now.

The css for the summary is working so I don’t care anymore.
Thanks.

PS: Full code for others:

{{velocity}}
  {{html clean="false" wiki="true"}}
  <style>
  .spoiler {
    margin-bottom: 10px;
  }
  details[open] > summary {
    margin-bottom: 10px;
  }
  summary {
    display: list-item;
    cursor: pointer;
  }
  summary:focus {
    box-shadow: none !important;
  }
  summary > p {
    display: inline;
  }
  </style>
  <details class="spoiler">
    <summary>{{wikimacroparameter name="title" /}}</summary>
    {{wikimacrocontent/}}
  </details>
  {{/html}}
{{/velocity}}
9

I just run into issues solving this same problem. I had issues with the wikimacroparameter macro with the wiki type.

Instead of inline styling I used the XWiki.StyleSheetExtension. I supported leaving the details open or not on initial access. That is, an “Open” boolean parameter, as well as a “Summary”. Then the content of the macro was the content of the details element itself.

My css was extremely minimal:

.collapsibleSection p {
  margin-left: 1em;
}

.collapsibleSectionSummary {
  display: list-item;
}

The content of my macro is

{{velocity}}
#set ($discard = $xwiki.ssx.use('XWiki.Custom Macros.Collapsible Section Macro.WebHome'))
#set ($result = "")
#if($wikimacro.parameters.Open)
    #set ($result = $result+'<div><details open class="collapsibleSection">')
#else
    #set ($result = $result+'<div><details class="collapsibleSection">')
#end
#if($wikimacro.parameters.Summary)
  #set ($result = $result+'<summary class="collapsibleSectionSummary">')
  #set ($parsedSummary = $services.rendering.render($services.rendering.parse($wikimacro.parameters.Summary,$xwiki.getDefaultDocumentSyntax()), 'html/5.0').trim())
  #if($parsedSummary.startsWith('<p>') && $parsedSummary.endsWith('</p>'))
      #set($lengthMinus4 = $parsedSummary.length() - 4)
      #set($parsedSummary = $parsedSummary.substring(3, $lengthMinus4))
  #end
  #set ($result = $result+$parsedSummary)
  #set ($result = $result+'</summary>')
#else
  #set  ($result = $result+'<summary class="collapsibleSectionSummary" />')
#end
#set ($parsedContent = $services.rendering.render($services.rendering.parse($wikimacro.content,$xwiki.getDefaultDocumentSyntax()), 'html/5.0').trim())
#set  ($result = $result+$parsedContent)
#set  ($result = $result+'</details></div>')
{{html clean="false"}}
$result
{{/html}}
{{/velocity}}