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 opensearch manifest for elixir.bootlin.com #401

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

fstachura
Copy link
Collaborator

Closes #216

This adds a static opensearch manifest for elixir.bootlin.com. The manifest only works for latest Linux and statically points to elixir.bootlin.com (self hosted instances will need to manually edit the manifest)

@tleb
Copy link
Member

tleb commented Mar 12, 2025

Please add more details to your commit messages. The following are all questions I asked myself while reading your code. I don't see anything to change in the diff, but the commit messages are lacking.

  • Where do you specify this is Firefox specific? At least that was my understanding of it. Do we want to do the same for other browsers? Do they even provide such features?
  • Why do we need to force a specific content-type from the Apache config?
  • Where is a link to the opensearch spec (and/or documentation)?
  • Why is the autocomplete response the way it is? Why that return value? With a link to the place in the spec that describes that.

Thanks!

@fstachura
Copy link
Collaborator Author

Where do you specify this is Firefox specific? At least that was my understanding of it. Do we want to do the same for other browsers? Do they even provide such features?

It's not Firefox specific, it's an open standard, other browsers at least used to support it (Chrome and pre-chromium Edge). I believe macOS Safari still supports it.

Why do we need to force a specific content-type from the Apache config?

https://developer.mozilla.org/en-US/docs/Web/XML/Guides/OpenSearch

Your server should serve OpenSearch plugins using Content-Type: application/opensearchdescription+xml.

Where is a link to the opensearch spec (and/or documentation)?
Why is the autocomplete response the way it is? Why that return value? With a link to the place in the spec that describes that.

I added that to commit messages

OpenSearch is a standard that allows browsers to discover search engines.
A special XML file with information about the search engine is linked
from its webpage in a link tag.
OpenSearch is supported by Firefox and (maybe) macOS Safari.
It used to be supported by Chromium-based browsers, but that feature was
deprecated.
https://stackoverflow.com/questions/56400952/does-chrome-allow-auto-discovery-of-opensearch

MDN Docs:
https://developer.mozilla.org/en-US/docs/Web/XML/Guides/OpenSearch

OpenSearch specification:
https://github.com/dewitt/opensearch/blob/master/opensearch-1-1-draft-6.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Request: serve OpenSearch file (for Firefox "add search engine" function)
2 participants