FriendsOfFlarum Synopsis

FriendsOfFlarum

FriendsOfFlarum Synopsis

A Flarum extension which adds summary excerpts to the discussion list.

Features

As well as displaying an excerpt as a summary (with configurable length):

All display strings are translatable
Toggle between displaying plain or rich content in the summary (admin)
Choose from using either the first or latest post in the summary (admin)
User preference to show/hide summaries
User preference to enable summaries on mobile

Screenshots

Admin settings

Rich content in summary

User settings

Installation

composer require fof/synopsis

Updating

composer require fof/synopsis
php flarum migrate
php flarum cache:clear

Support

Please consider supporting my extension development and maintenance work.
Buy me a coffee

This is a direct replacement to ianm/synopsis

RelicSystem

For those curious, if you install fof/synopsis with ianm/synopsis installed, it will simply remove the old and add the new. I’m unsure if settings carry over. I doubt it, considering you will then need to enable fof/synopsis.

IanM

RelicSystem yep, by using the replace key in composer.json, this causes composer to remove the old one for you. Settings are migrated from the old to the new upon enabling the new version 😉

RelicSystem

IanM Settings are migrated from the old to the new upon enabling the new version

I stand corrected, thank you appreciate the info.

endlessedits

Synopsis is working beautifully, inserting the rich content (images) into the summaries -- but it is not working for YouTube videos. For embedded videos Synopsis is inserting a relatively large blank white space only. The video embeds are otherwise working perfectly in the discussions.

I have tried dramatically increasing the summary excerpt length, but it doesn't help. I can live with the blank spaces in the summaries, because I don't want to turn off the video embeds. But it would be awesome to have a way to get them to work or to insert a graphic placeholder of some sort to fill the blank space.

Anyone else experiencing this?

endlessedits

@clarkwinkelmann If I used your Rich Embeds extension https://discuss.flarum.org/d/30516-rich-embeds, would it solve the above problem with YouTube not showing up in Synopsis?

clarkwinkelmann

endlessedits I have never tried.

I'd guess probably not, because my extension transforms anchor tags into embeds using javascript on the post component. If the content is rendered somewhere else that isn't the post, links should show up as regular links. Even if the javascript does run, the embed content might not have been preloaded if the posts were loaded through a different API endpoint. Maybe that's actually a desirable outcome for you.

endlessedits

clarkwinkelmann

Thanks for the explanation regarding why your rich embeds extension won't provide a silver bullet solution for my issue. I can't say I fully understand the details of why, but I get the concept of different APIs working on different content streams.

As a non-developer, having tried every conceivable combination of all the variations provided by the multiple relevant extensions for embedding and synopsizing, here is my suggestion:

Since Synopsis is now part of FoF, and embedding links is very popular, and YouTube is probably one of the more popular embeds, if it could be considered to add "fixing" YouTube embeds working in Synopsis, it would be great.

On my site, the present situation with Synopsis and media embeds leaves a half-page of blank space for every YouTube embed that gets "picked up" by Synopsis. The solution I've found -- turning off YouTube embeds entirely for the whole site -- eliminates them in all regular posts, which is a really bad outcome for any site, but for mine (a music site) is it horrible.

Stezkoy

Hi, translate this version: https://weblate.rob006.net/projects/flarum/ianm-synopsis/ ? Or wait from FoF?

rob006

Stezkoy This extension is now available to translate at https://weblate.rob006.net/projects/flarum/fof-synopsis/
Old translations were migrated from ianm-synopsis.

KBExit

Is there anyway we can have this set to always on for both mobile and desktop applications? I downloaded the default user settings extension thinking it'll hard set it, but there's no value there.

clarkwinkelmann

⚠️ Security update

Version 1.0.0 (and the ianm/synopsis package before it) contains an HTML injection vulnerability in the plain content mode. You should update immediately.

A second issue with the rich content HTML truncation could also lead to security issues, though I have not been able to create an exploit for it.

If you cannot update immediately, you should disable the extension.

These problems were discovered through internal code review.

Version 1.0.1

Fix HTML injection in plain content mode
Implement proper HTML truncating in rich content mode

If you use rich content mode, the excerpt length now counts the number of printed characters and ignores the length of invisible HTML tags and attributes. This means the excerpt will probably be longer than before and actually reflect the value of the setting.

For extension developers, the signature of the javascript component Excerpt::getContent() had to be changed. It must now return a plain text or Vnode, and is no longer parsed as HTML. If you were returning an HTML string, the HTML will now be printed as text and no longer injected as HTML.