search

fossar / selfoss

multipurpose rss reader, live stream, mashup, aggregation web application
https://selfoss.aditu.de
GNU General Public License v3.0
2.36k stars 343 forks source link

Document what each spout does #1225

Open jtojnar opened 4 years ago

jtojnar commented 4 years ago

It is not clear from the name and even I had to consult the source code to be able to tell.

I explained it a bit here:

  • Images are same as regular RSS, only they add a thumbnail (taken either from RSS enclosures or the linked web page when there are no enclosures).
  • Enclosures are RSS extension for adding multimedia files to the feed. If there are enclosures, they will be added to the end of the content. Only image enclosures are currently supported.
  • Instapaper is supposed to do context extraction using an online service that got shut down. We ought to remove it but will need to add a migration script first.

And also here:

  • Enclosures are RSS feature to embed multimedia into feed items: https://m.wikipedia.org/wiki/RSS_enclosure. The spout will insert the image enclosures after the content.
  • RSS Feed Images is just a normal RSS spout that will also set the first enclosure thumbnail in the item or image from the item content as the entry’s thumbnail.
  • Instapaper is the same thing as FullTextRSS only proprietary third party service instead of local library.

and here:

FullTextRSS spout replaces the content from feed items by a content extracted from the URL using a library called Graby. The extraction is rule based so it is possible it is not perfect for some websites. You can also save custom rules to data/fulltextrss/custom. I will add the descriptions to the docs.