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

Search provider for external apps #3843

Open
ThreeDeeJay opened this issue May 14, 2024 · 4 comments
Open

Search provider for external apps #3843

ThreeDeeJay opened this issue May 14, 2024 · 4 comments
Assignees
Milestone

Comments

@ThreeDeeJay
Copy link

Follow-up from #920 (comment)

Is your feature request related to a problem? Please describe.

It would be nice to be able to search articles using external apps such as voice assistants by making the app searchable.

Describe the solution you'd like

Adding Kiwix as a search provider so that we could add it as a custom command for offline voice assistants like Saiy/Utter in Search mode (just show matches/results) and maybe also Search & Play mode (go directly to the first/closest match and/or immediately start reading aloud using Text-to-Speech, if enabled, for extra convenience/speed which may even work when the display is off or device is locked)

Describe alternatives you've considered

Searching manually via the Search button in the app.

Additional context

Examples of apps with search providers available in Utter:
Screenshot_20240514-044330_utter!_1
For instance, we can add a voice command in Utter to search for a local music file by saying play TITLE and it'll show the results matching TITLE. And if we use the Search & Play mode, it'll immediately start playing the first file that matches TITLE.
So I'm thinking of something like that, but for articles in Kiwix.

@kelson42 kelson42 self-assigned this May 14, 2024
@kelson42 kelson42 added this to the 3.11.0 milestone May 14, 2024
@kelson42
Copy link
Collaborator

@MohitMaliDeveloper Same as #30?

@kelson42 kelson42 modified the milestones: 3.11.0, 3.12.0 May 19, 2024
@kelson42 kelson42 modified the milestones: 3.12.0, 3.13.0 Jul 12, 2024
@shashank-0-0
Copy link
Contributor

shashank-0-0 commented Jul 27, 2024

@kelson42 @MohitMaliFtechiz I have tried implementing this similar to how music apps like spotify have implemented it. Utilized this https://android-developers.googleblog.com/2010/09/supporting-new-music-voice-action.html to register kiwix as a searchable application.
I am searching for "wikipedia" articles in kiwix via saiy in the below recording.
https://github.com/user-attachments/assets/8fe20d84-1d2c-4965-97eb-607a1f2c572a

@shashank-0-0
Copy link
Contributor

I am not sure how this is related to #30 as the requirements of the #30 issue is not quite clear to me, but let me know if I can raise a pr for the above implementation enabling users to search articles on kiwix via voice assistants.

@ThreeDeeJay
Copy link
Author

@shashank-0-0 Any progress on this? 👀
By the way, I was thinking more of searching specific articles, though I assume would require setting a default archive if there's more than 1 🤔

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

No branches or pull requests

3 participants