On Wed, Sep 16, 2020 at 04:32:23PM -0700, Raymond Toy wrote:
> For example you can navigate to
> https://common-lisp.net/project/maxima/docs/maxima_singlepage.html#Item_003a-Bugs_002fdeffn_002frun_005ftestsuite
> and this works just fine.
>
> But once you get there and maybe scroll around a bit to look for other
> functions or variables, you can't easily get a link to the
> function/variable/section. Currently, you have to go to the index to find
> a link to the thing.
>
> These entries all have @anchor{}, so it would be really nice if the HTML
> doc could add some kind of self-link so that when I find what I want, I can
> copy the link and share it with someone.
I agree that this could be a useful feature. I don't think it should be
done with @anchor{} but maybe with @deffn, @defop etc. The interface
could be an icon that appears when you mouse over the text, as at
https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html
That looks nice and would certainly fine with me.
where mousing over any heading pops up such an icon. E.g. at
https://common-lisp.net/project/maxima/docs/maxima_singlepage.html#Functions-and-Variables-for-Bug-Detection-and-Reporting
mousing over the "Function: run_testsuite" could pop up such an icon.
This should be possible with CSS as this still works on the page linked
above even when _javascript_ is disabled.
Using CSS is fine too for deffn and friends instead of anchor. But this seems hard because I don't have a good way of figuring out where to put such links. AFAICT, the link is basically <span id="Item_section+deffn">. If it said <span id="linkname" class="deffn">, then I could do something.