BridgeRequestTemplate.md

Bridge request

<!-- This is a bridge request. Start by adding a descriptive title (i.e. Bridge request for GitHub). Use the "Preview" button to see a preview of your request. Make sure your request is complete before submitting! -->

General information

<!-- Please describe what you expect from the bridge. Whenever possible provide sample links and screenshots (you can just paste them here) to express your expectations and help others understand your request. If possible, mark relevant areas in your screenshot. Use the following questions for reference: -->

• Host URI for the bridge (i.e. https://github.com):

• Which information would you like to see?

• How should the information be displayed/formatted?

• Which of the following parameters do you expect?

  • Title
  • URI (link to the original article)
  • Author
  • Timestamp
  • Content (the content of the article)
  • Enclosures (pictures, videos, etc...)
  • Categories (categories, tags, etc...)

Options

<!--Select options from the list below. Add your own option if one is missing:-->

• Limit number of returned items
  • Default limit: 5
• Load full articles
  • Cache articles (articles are stored in a local cache on first request): yes
  • Cache timeout (max = 24 hours): 24 hours
• Balance requests (RSS-Bridge uses cached versions to reduce bandwith usage)
  • Timeout (default = 5 minutes, max = 24 hours): 5 minutes

<!--Be aware that some options might not be available for your specific request due to technical limitations!-->

<!--

Additional notes

Keep in mind that opening a request does not guarantee the bridge being implemented! That depends entirely on the interest and time of others to make the bridge for you.

You can also implement your own bridge (with support of the community if needed). Find more information in the RSS-Bridge Wiki developer section. -->

1. We can drop the primary Feed format question I think. Seeing as all bridges must work in all formats, don't see how it will be of help
2. A lot of the content in the template that is "guiding text" (for eg - entire Additional notes section) can be kept inside a HTML comment (<!-- \n\n ... -->) so that while it gets read by the creator, it does not get duplicated needlessly on all issues.

Might be a bit more helpful to ask users to upload "annotated screenshots". Maybe something like:

If possible, mark the relevant areas in your screenshot from where you expect the relevant content to be scraped.

Thanks for the feedback!

We can drop the primary Feed format question I think. Seeing as all bridges must work in all formats, don't see how it will be of help

Good point, I think you are right. The whole purpose of RSS-Bridge is to make it available in any of the available formats anyway.

A lot of the content in the template that is "guiding text" (for eg - entire Additional notes section) can be kept inside a HTML comment (<!-- \n\n ... -->) so that while it gets read by the creator, it does not get duplicated needlessly on all issues.

😮 I never thought that was possible, thanks so much for the advice! 💯
I made it so the comment blocks are visible in the Gist (using \<!-- instead of <!--). The final version must be corrected accordingly.

Might be a bit more helpful to ask users to upload "annotated screenshots". Maybe something like:

If possible, mark the relevant areas in your screenshot from where you expect the relevant content to be scraped.

Added to the Gist. I slightly adjusted the wording and made it a bit shorter, hope it still conveys the intention.