kiwix / libkiwix

Common code base for all Kiwix ports
https://download.kiwix.org/release/libkiwix/
GNU General Public License v3.0
112 stars 55 forks source link

Add a feed link to kiwix-serve welcome page #832

Closed kelson42 closed 1 year ago

kelson42 commented 1 year ago

The feed link should have the same filter (URL) as the one currently running.

Read https://medium.com/samsung-internet-dev/add-rss-feeds-to-your-website-to-keep-your-core-readers-engaged-3179dca9c91e form more details.

This should help user to be kept informed about new release of their most wanted ZIM files.

s-pratik commented 1 year ago

Hi, I would like to contribute I am very new in this can anyone help me with how can I start

mgautierfr commented 1 year ago

The opds stream is itself a atom feed (as opds is based on atom). It should not be to complicated to "add" a feed, we should have only to add some declaration to "itself" in the opds stream (if not already done)

kelson42 commented 1 year ago

Here the ticket is about adding the OPDS feed link in the kiwix-serve HTML "welcome" page. What is visible for example at hhtps://library.kiwix.org.

mgautierfr commented 1 year ago

The source of the welcome page is a opds feed, so a atom feed. We just have to properly link to this feed from the welcome page.

juuz0 commented 1 year ago

The blog says there are 2 ways of advertising:

  1. Firstly for helping users see that there is an RSS feed available you should display the RSS feed icon on your website and have it link to the feed version of the current page.

  2. The other main method of advertising your RSS feed is by a machine readable HTML tag in the head of the HTML page. This isn’t visible to users but will inform the user’s Web browser and RSS client that there is an RSS version of that site.

Which one is preferred here?

kelson42 commented 1 year ago

@juuz0 This ticket does not request to advertise it. Although this might be a good idea, I have no opinion on this. Good browser (extensions) just display a feed icon in the URL bar if a feed is available in the HTML head node. This is only what is requested here.

Popolechien commented 1 year ago

I don't think we should assume users to be tech-savvy and install extensions by default. I would support discrete advertising.

kelson42 commented 1 year ago

I don't think we should assume users to be tech-savvy and install extensions by default. I would support discrete advertising.

Yes, just try the approach "one problem at a time".

kelson42 commented 1 year ago
  1. Firstly for helping users see that there is an RSS feed available you should display the RSS feed icon on your website and have it link to the feed version of the current page.

Now, that the feed is make available in the HTML head, lets talk about that. Maybe putting this small icon just beside the "Powered by Kiwix" would be a good approach?

juuz0 commented 1 year ago

A small icon beside "Powered by Kiwix" would look fine, though I think there's a small accessibility problem there. If there are a large number of ZIMs, "powered by Kiwix" would be far too down in the page (For example, at library.kiwix.org - we have to scroll through thousands of ZIMs to see the text).

Alternatively, the logo can be right-aligned to the page - in the same line as Filters. Untitled design Untitled design(1) Untitled design(2)

Although the designs were well thought out, at this moment juuz0 realised why Art wasn't his strongest subject at school...

kelson42 commented 1 year ago

@juuz0 You are right, the second design/screenshot looks good IMO

juuz0 commented 1 year ago

@kelson42 should i make modifications to the current PR then? or create a new issue -> new PR to link

kelson42 commented 1 year ago

@juuz0 Yes, it's OK

Popolechien commented 1 year ago

A small icon beside "Powered by Kiwix" would look fine, though I think there's a small accessibility problem there. If there are a large number of ZIMs, "powered by Kiwix" would be far too down in the page

This is very true and a question I've had for a long time: why isn't the selector frame frozen on top?

kelson42 commented 1 year ago

A small icon beside "Powered by Kiwix" would look fine, though I think there's a small accessibility problem there. If there are a large number of ZIMs, "powered by Kiwix" would be far too down in the page

This is very true and a question I've had for a long time: why isn't the selector frame frozen on top?

What do you mean with frozen? Which selector exactly?

Popolechien commented 1 year ago

This top section. And by frozen I refer to excel or google sheets, where you can block the top row on top and scrolling down only moves the rows below Capture d’écran 2023-02-06 à 10 31 48

kelson42 commented 1 year ago

@Popolechien Indeed! It's not frozen and this is strange. We should tacle this in an other ticket.