Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
kelson42 opened this issue Oct 9, 2022 · 17 comments · Fixed by #882
Closed

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

kelson42 opened this issue Oct 9, 2022 · 17 comments · Fixed by #882

Comments

@kelson42
Copy link
Collaborator

kelson42 commented Oct 9, 2022

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
Copy link

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

@mgautierfr
Copy link
Member

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
Copy link
Collaborator Author

kelson42 commented Jan 17, 2023

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
Copy link
Member

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
Copy link
Collaborator

juuz0 commented Feb 5, 2023

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.
  1. 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
Copy link
Collaborator Author

kelson42 commented Feb 5, 2023

@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
Copy link
Member

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

@kelson42
Copy link
Collaborator Author

kelson42 commented Feb 5, 2023

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
Copy link
Collaborator Author

kelson42 commented Feb 5, 2023

  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
Copy link
Collaborator

juuz0 commented Feb 5, 2023

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
Copy link
Collaborator Author

kelson42 commented Feb 5, 2023

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

@juuz0
Copy link
Collaborator

juuz0 commented Feb 5, 2023

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

@kelson42
Copy link
Collaborator Author

kelson42 commented Feb 5, 2023

@juuz0 Yes, it's OK

@Popolechien

This comment was marked as off-topic.

@kelson42

This comment was marked as off-topic.

@Popolechien

This comment was marked as off-topic.

@kelson42

This comment was marked as off-topic.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants