Content Warning Module

[DrewBrasher]

I would like to create a module that would add a content warning (CW) feature. People use this type of feature a lot on platforms like Discord and Mastodon to hide content that some people might not want to see until they select that they want to see it. I think a feature like this would be especially useful in a blog site.

I'm trying to think about the best way to implement something like this so if anyone has any ideas let me know.

Some things I'm considering are:

• When you enable the feature, should that add the option to put a CW on every content type or should there be a settings page where you specify which content types have the option for a CW?
• I think it would be good if entire content items could have a CW but also a way to just hide sections of text. Discord does this when you enclose the text in double pipes (||). Maybe this could be a shortcode in the OC module.
• Maybe there should be a way for users to turn off CW for themselves if they don't care about that and don't want to have to click to see content.

[Piedone]

Late to the party but I just noticed this topic.

Are we talking about something like an NSFW warning?

I'd handle this on the client side: e.g. add a blur overlay onto the content item's div with a button to show the content (and that'd also save it to local storage that you already set that particular item to show).

Otherwise, I'd do this as a content part with an editor checkbox to add a CW to the whole item. Otherwise, perhaps a shortcode to use it for just selected pieces of text/body would work?

[DrewBrasher]

Yes, I'm talking about something that could be used for NSFW warning as well as other things like movie spoilers and trigger warnings.

I think doing both the content part and the short code would be good because sometimes just a small piece for text needs a CW and sometimes the whole content might need it.

One thing I need to look into more is how to handle when people are using accessibility features like a screen reader. In that case I think it should read the warning and wait to for some kind of confirmation before reading the content. I'm not sure how this is handled on other platforms that use content warnings.

[ns8482e]

This can be achieved by creating a Part with ContentPicker field. Logic could be similar to FormPart where when a Part is attached, a ContentDriver will add a wrapper shape around the content. In wrapper you could render selected content item from content picker and show/hide/blur the original content using css/js

[DrewBrasher]

Thanks! Adding a wrapper shape sounds like a good way to do it. I will take a look at the FormPart.

[DrewBrasher]

Here is an article that describes the kind of behavior I would like to implement including accessibility consideration:
https://www.aaron-gustafson.com/notebook/considering-content-warnings-in-html/

and here is the codepen from that article: https://codepen.io/aarongustafson/pen/QWZpqPe

[DrewBrasher]

Are only certain attributes allowed to be rendered in a shortcode? I'm trying to add a data- attribute to the output and it just gets stripped out. Here is how I'm trying to add it:

    public ValueTask<string> EvaluateAsync(string identifier, Arguments arguments, string content, Context context)
    {
        var warning = arguments.NamedOrDefault("warning");
        content = $"<span data-content-warning=\"{warning}\">{content}</span>";
        return new ValueTask<string>(content);
    }

But if I use the shortcode like this:

I loved when [content_warning 'Star Trek Discovery spoiler'] this one thing happened [/content_warning].

it outputs this html:

I loved when <span> this one thing happened </span>.

[Piedone]

While I don't know the solution from the top of my head, I'd suggest you debug and play with a shortcode provider built into OC, with the OC source, and see what you can find out.

[DrewBrasher]

I stepped through the Orchard Source code using the asset_url shortcode and found that the reason it was not getting rendered was because the markdown part of the blog post was set to sanitize html. I unchecked that and it works.

[hishamco]

As expected

[Piedone]

Sanitization should probably happen after shortcodes are rendered though, since the point of shortcodes is to provide alternative dynamic behavior that you otherwise can't achieve with a restricted editor.