[nodebb-plugin-ns-spoiler] NS Spoiler

[exodo]

@Nicolas said:

@exodo It should work with 0.7 also. I didn't test, but at a glance I don't see issues why it will not work.

Confirmed to work on 0.7 like a charm

[산도]

I have a problem when URL is in the spoiler.
Is this bug or is there way to fix it?
Thank you

[Nicolas]

I have checked with both types of URLs, seems everything is OK with URLs in spoiler:

[frissdiegurke]

@산도 Looks like you've missed a whitespace between the URL and closing :::.
I guess this is needed in order to work properly, that it's half-way working should be considered a bug.
(everything just concluded of his/her screenshot didn't test anything)

[jdk1811]

I am actually having a similar issue. I am guessing it's messing up with youtube plugin.

:::
--some tex1t--
youtube link
--some text2--
:::

If I do this, spoiler button and some text1 disappears,

and youtube, some_text2 does not get into the spoiler and shows up

[phl]

I really love the plugin, installed it and it works fine for me!

However, when writing an announcment for my forum that spoilers are now supported I realised that I couldn't show the usage by wrapping the spoiler into a code block.
The spoiler was rendered anyway.

[Nicolas]

Feature from Markdown plugin with Auto-links, can treat ::: sequence as part of URL. Of course if you will write them together.
Thus It will create copy of the spoiler tag.

[Nicolas]

Also here is an example with iframe:

If another plugins don't break spoiler tag :::, everything should work fine.

I'm glad that there is a feedback. Maybe we will find, that solutions with colons don't work in real world

[exodo]

Seems to break post with item lists

[Nicolas]

Show code (markdown) and screenshot, will see is any solution for it

[exodo]

@Nicolas

just add some posts with

:::
- 1
- 2
:::

::: 
- ok
- good
:::

and thrad will be broken

seems to affect to profile pages also

[Nicolas]

@exodo thanks.

I think such construction will work well:

:::
Some text goes here

• ok
• good

:::

Code:

::: 
Some text goes here

- ok
- good

:::

You could use for now, until solution will be provided.
I think main problem here, list is relies on empty space around it.

[exodo]

@Nicolas
thank you, i dont use lists much but breaking the thread makes imposible to edit or open editor without console tricks so its important bug

also i noticed this

[Nicolas]

Ye, they are rendered in preview.
They should be excluded in the same way as images, I think.

https://github.com/NodeBB/NodeBB/issues/3896

[Nicolas]

Ok, it works well with lists, but extra space around list is very important...
Actually, if you don't have extra space (blank line) around list items, It also doesn't look good in composer preview. But yes, if you omit blank lines list with dashes (-) break layout. So some safe checks should be added to prevent such cases.

[Nicolas]

Version 1.1.1

Summary: safer to use

• Additional handler for Markdown Plugin: unwrap lists. It's a safe check, so html will still be valid
• Additional paragraph handlers for Markdown Plugin: shift spoiler tag (start or end) around artificial multilines
• Extra paragraph wrapper around spoiler tag now be removed

Performance of the plugin will be much-much higher, if Core devs provide some solution here

https://github.com/NodeBB/NodeBB/issues/3897

[exodo]

Working good thank you

[phl]

@Nicolas
After a user created a longer posting with multiple spoilers, the forum stopped working properly for me (unresponsive buttons / missing pop-up menus).

I played around with the posting that was made and figured out some problems related to the spoiler plugin.

First, using a list before a spoiler containing a list breaks the spoiler.
Here's the code:

- asd
- asd
- asd

::: 
This is a spoiler containing a list:

- asd
- asd
- asd

::: 

producing the output

• asd
• asd
• asd

This is a spoiler containing a list:

• asd
• asd
• asd

[empty spoiler tag]

This part on its own does not yet break anything but just creates a badly formatted posting.

Second (probably somewhat related), different kinds of lists inside the same spoiler will break the next spoiler following.

Example code:

::: 
- asd
- asd
- asd

1) asd
2) asd
3) asd
::: 

::: 
- asd
- asd
- asd
::: 

results in

[spoiler containing the part between the first spoiler tags]

• asd
• asd
• asd
  [empty spoiler]

Again, this problem alone does not result in a broken nodebb but just in malformatted output.

Finally, I reduced the problem to a situation when both of the above examples are combined.

A posting like this

::: 
1) asd
2) asd
3) asd

- asd
::: 

- asd

:::
1) asd
2) asd
3) asd
::: 

will break nodebb. The problematic thread / posting becomes impossible to delete without deactivating plugins because the moderation tools cannot be displayed.

[Nicolas]

@phl thanks for extended info. Indeed, there is a problem with Markdown Plugin.
For example, lists parsing will always try to concatenate ::: blocks. I already added several additional rules to address some list issues.
But, It looks for me now a bit problematic, to have a dozen rules, just to handle parsing result from another plugin.

There is a related issue, https://github.com/NodeBB/NodeBB/issues/3897
As you can see, It's closed, and there is no alternative solution/proposition.

I'm sure, that, if you have blank lines around ::: everything should be fine. But there is no way for now, to ask users to have blank lines around spoiler tags.

Initially I thought about 2 pass parsing. 1 pass - add blank lines around spoiler tokens ::: before Markdown plugin, and 2 pass - apply spoiler rules. But, plugin hooks doesn't support 2 same hooks with different priorities.

[Nicolas]

Version 2.0.0

New version is available. Summary: compatibility is changed, now It's only NodeBB v1

• Add Redactor WYSIWYG support
• Add installation support for NodeBB v1

P.S.
Started to think about an implementation of true spoiler, where data should be fetched from the server.