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

Feature: Implement hover-over referencing #126

Open
s-makin opened this issue Jan 24, 2025 · 3 comments
Open

Feature: Implement hover-over referencing #126

s-makin opened this issue Jan 24, 2025 · 3 comments
Assignees
Labels
code: low-code Coding level: may need small amount of coding For: Open Documentation Academy Enough information to act and a good candidate to be part of the ODA efforts

Comments

@s-makin
Copy link
Collaborator

s-makin commented Jan 24, 2025

The problem

Now that we have a functioning glossary page, one cool feature that would be awesome to have is the Wikipedia-style functionality that pops up a definition of a term or acronym when you hover over a link to the glossary.

The task

This functionality is available through the hoverxref Sphinx extension, which needs to be installed and tested to make sure the behaviour is correct.

Suggested approach

  • Install the Sphinx extension according to the hoverxref documentation linked above. This is done by specifying it in the custom_conf.py file. Note, this is sometimes trickier than it sounds!
  • Test to make sure it works :D

A test definition ("ACL") was included in the initial glossary implementation, on the openldap/access-control page. As long as the pop-up appears in your local build of the documentation when you hover over the term, and the text matches the expected text defined under the definition, then it's working :)

@s-makin
Copy link
Collaborator Author

s-makin commented Jan 24, 2025

@activus-d Here's one of the follow-up issues to the initial glossary implementation. Please let me know if you still want it :)

@activus-d
Copy link
Contributor

@activus-d Here's one of the follow-up issues to the initial glossary implementation. Please let me know if you still want it :)

Please go ahead and assign the issue to me.

@s-makin
Copy link
Collaborator Author

s-makin commented Jan 27, 2025

Please go ahead and assign the issue to me.

Thanks @activus-d - I've assigned it to you now, let me know if you need any more info :)

@s-makin s-makin added code: low-code Coding level: may need small amount of coding For: Open Documentation Academy Enough information to act and a good candidate to be part of the ODA efforts labels Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code: low-code Coding level: may need small amount of coding For: Open Documentation Academy Enough information to act and a good candidate to be part of the ODA efforts
Projects
None yet
Development

No branches or pull requests

2 participants