search

bootlin / elixir

The Elixir Cross Referencer
GNU Affero General Public License v3.0
920 stars 138 forks source link

Proposal: add a mode that displays a popup on identifier click #264

Closed fstachura closed 5 months ago

fstachura commented 5 months ago

In the current version of Elixir, clicking on an identifier redirects the browser to another URL (example: https://elixir.bootlin.com/linux/latest/C/ident/pci_get_device). This works, but in my opinion is rather slow and inconvenient. I propose adding a mode in which such action would instead display an inline HTML popup with similar content. This new mode would of course be disabled by default.

I have already implemented a proof of concept here: https://github.com/fstachura/elixir/tree/dynamic-references It's good enough for me, although note that in this PoC this mode is always enabled. Also, the code that positions the popup is probably not production ready yet.

michaelopdenacker commented 5 months ago

This sounds like a nice idea, thanks! However, I lack time for testing at the moment... Would you be able to show it on a public website somewhere (maybe on a smaller project to index, such as Zephyr or Musl)?

fstachura commented 5 months ago

I have temporarily set the fork up on https://elixir.ksi.ii.uj.edu.pl/

Line numbers on some pages are completely misaligned, but I have seen this happen before I started making any modifications. I suspect that production code is not fully synchronized with the repo. Example: https://elixir.ksi.ii.uj.edu.pl/musl/latest/source/arch/arm/kstat.h

tpetazzoni commented 5 months ago

I think this work has been merged, so closing the issue.