From ae58f009fba5f56a973fba7a9b389d8ef42838b7 Mon Sep 17 00:00:00 2001
From: Nikhil Tanwar <2002nikhiltanwar@gmail.com>
Date: Sun, 19 Mar 2023 09:09:08 +0530
Subject: [PATCH] Feed tooltip based on filters
The feed logo tooltip text is now based on filters.
If no filters are set, it shows "All entries"
---
static/skin/i18n/en.json | 3 ++-
static/skin/i18n/qqq.json | 5 +++--
static/skin/i18n/test.json | 3 ++-
static/skin/index.js | 29 ++++++++++++++++++++++++-----
test/server.cpp | 4 ++--
5 files changed, 33 insertions(+), 11 deletions(-)
diff --git a/static/skin/i18n/en.json b/static/skin/i18n/en.json
index 5eddb752c..acf2b0131 100644
--- a/static/skin/i18n/en.json
+++ b/static/skin/i18n/en.json
@@ -43,7 +43,8 @@
, "magnet-alt-text": "download magnet"
, "torrent-download-link-text": "Torrent file"
, "torrent-download-alt-text": "download torrent"
- , "library-opds-feed": "Library OPDS Feed"
+ , "library-opds-feed-all-entries": "Library OPDS Feed - All entries"
, "filter-by-tag": "Filter by tag \"{{TAG}}\""
, "stop-filtering-by-tag": "Stop filtering by tag \"{{TAG}}\""
+ , "library-opds-feed-parameterised": "Library OPDS Feed - entries matching {{#LANG}}\nLanguage: {{LANG}} {{/LANG}}{{#CATEGORY}}\nCategory: {{CATEGORY}} {{/CATEGORY}}{{#TAG}}\nTag: {{TAG}} {{/TAG}}{{#Q}}\nQuery: {{Q}} {{/Q}}"
}
diff --git a/static/skin/i18n/qqq.json b/static/skin/i18n/qqq.json
index 89a108ddf..8d2acf869 100644
--- a/static/skin/i18n/qqq.json
+++ b/static/skin/i18n/qqq.json
@@ -45,7 +45,8 @@
"magnet-alt-text": "Hint for the icon of a magnet link",
"torrent-download-link-text": "Link text for downloading the torrent file",
"torrent-download-alt-text": "Hint for the icon of torrent download",
- "library-opds-feed": "Hint for the library OPDS feed link",
"filter-by-tag": "Hint for a link that would load results filtered by a single tag",
- "stop-filtering-by-tag": "Tooltip for the button that cancels filtering by tag"
+ "stop-filtering-by-tag": "Tooltip for the button that cancels filtering by tag",
+ "library-opds-feed-all-entries": "Hint for the library OPDS feed for all entries",
+ "library-opds-feed-parameterised": "Hint for the library OPDS feed for filtered entries"
}
diff --git a/static/skin/i18n/test.json b/static/skin/i18n/test.json
index cc4a2acef..b2e02e6b4 100644
--- a/static/skin/i18n/test.json
+++ b/static/skin/i18n/test.json
@@ -32,7 +32,8 @@
, "magnet-alt-text": "download [I18N TESTING] magnet"
, "torrent-download-link-text": "Torrent [I18N TESTING] file"
, "torrent-download-alt-text": "download [I18N TESTING] torrent"
- , "library-opds-feed": "Library [I18N] OPDS [TESTING] Feed"
+ , "library-opds-feed-all-entries": "[I18N] Library [TESTING] OPDS Feed - All entries [I18N TESTING]"
, "filter-by-tag": "Filter [I18N] by [TESTING] tag \"{{TAG}}\""
, "stop-filtering-by-tag": "[I18N] Stop filtering [TESTING] by tag \"{{TAG}}\""
+ , "library-opds-feed-parameterised": "[I18N] Library OPDS Feed - [TESTING] entries matching {{#LANG}}\nLanguage: {{LANG}} {{/LANG}}{{#CATEGORY}}\nCategory: {{CATEGORY}} {{/CATEGORY}}{{#TAG}}\nTag: {{TAG}} {{/TAG}}{{#Q}}\nQuery: {{Q}} {{/Q}}"
}
diff --git a/static/skin/index.js b/static/skin/index.js
index 0a6d140e2..1f3bd448b 100644
--- a/static/skin/index.js
+++ b/static/skin/index.js
@@ -39,6 +39,7 @@
const feedLink = `${root}/catalog/v2/entries?${filteredParams.toString()}`;
document.querySelector('#headFeedLink').href = feedLink;
document.querySelector('#feedLink').href = feedLink;
+ setFeedToolTip();
}
function changeUILanguage() {
@@ -496,6 +497,28 @@
window.addEventListener('hashchange', () => resetAndFilter());
+ function setFeedToolTip() {
+ const feedLogoElem = document.getElementById('feedLogo');
+ const libraryOpdsFeedHint = opdsFeedHintByParams();
+ for (const attr of ["alt", "aria-label", "title"] ) {
+ feedLogoElem.setAttribute(attr, libraryOpdsFeedHint);
+ }
+ }
+
+ function opdsFeedHintByParams() {
+ const paramObj = {};
+ const inputParams = new FragmentParams(window.location.hash);
+ for (const [key, value] of inputParams) {
+ if ( value != '' ) {
+ paramObj[key.toUpperCase()] = value;
+ }
+ }
+ if (!paramObj.LANG && !paramObj.CATEGORY && !paramObj.TAG && !paramObj.Q) {
+ return $t('library-opds-feed-all-entries');
+ }
+ return $t('library-opds-feed-parameterised', paramObj);
+ }
+
function updateUIText() {
footer.innerHTML = $t("powered-by-kiwix-html");
const searchText = $t("search");
@@ -503,11 +526,7 @@
document.getElementById('searchButton').value = searchText;
document.getElementById('categoryFilter').children[0].innerHTML = $t("book-filtering-all-categories");
document.getElementById('languageFilter').children[0].innerHTML = $t("book-filtering-all-languages");
- const feedLogoElem = document.getElementById('feedLogo');
- const libraryOpdsFeedHint = $t("library-opds-feed");
- for (const attr of ["alt", "aria-label", "title"] ) {
- feedLogoElem.setAttribute(attr, libraryOpdsFeedHint);
- }
+ setFeedToolTip();
}
async function onload() {
diff --git a/test/server.cpp b/test/server.cpp
index 786533fff..59a6b23dc 100644
--- a/test/server.cpp
+++ b/test/server.cpp
@@ -63,7 +63,7 @@ const ResourceCollection resources200Compressible{
{ DYNAMIC_CONTENT, "/ROOT%23%3F/skin/index.css" },
{ STATIC_CONTENT, "/ROOT%23%3F/skin/index.css?cacheid=e4d76d16" },
{ DYNAMIC_CONTENT, "/ROOT%23%3F/skin/index.js" },
- { STATIC_CONTENT, "/ROOT%23%3F/skin/index.js?cacheid=cafa3d61" },
+ { STATIC_CONTENT, "/ROOT%23%3F/skin/index.js?cacheid=78cfd6a2" },
{ DYNAMIC_CONTENT, "/ROOT%23%3F/skin/iso6391To3.js" },
{ STATIC_CONTENT, "/ROOT%23%3F/skin/iso6391To3.js?cacheid=ecde2bb3" },
{ DYNAMIC_CONTENT, "/ROOT%23%3F/skin/isotope.pkgd.min.js" },
@@ -284,7 +284,7 @@ R"EXPECTEDRESULT( href="/ROOT%23%3F/skin/index.css?cacheid=e4d76d16"
-
+