forrtproject.github.io icon indicating copy to clipboard operation
forrtproject.github.io copied to clipboard

Improve reference display

Open LukasWallrich opened this issue 1 year ago • 15 comments

The website is full of citations that are currently not systematically linked to references - so that they are of little use. We have a standing promise to change that in the glossary (#135) but the issue also arises in many other places.

Could we fix this across the webpage? I can think of three options:

  • project-specific reference pages, with links from the specific mentions
  • FORRT wide reference page, with links from the specific mentions

Or, my favorite:

  • when clicking on the citation, a popup appears with full reference and abstract - linking to the original source. Very simple dummy (with ChatGPT generated code) below, should of course be prettier.

image popup_test.html.zip

@flavioazevedo would this solution make sense for you?

LukasWallrich avatar Nov 18 '24 10:11 LukasWallrich

Add copy reference button in corner of popup

LukasWallrich avatar Nov 18 '24 13:11 LukasWallrich

This would be the possible steps - from conversation with @seunolufemi123

Maybe you can try to first implement it prettily on one page, with one reference, just using HTML, CSS and JS, as needed? Then the next step would be to move the elements to their appropriate homes: CSS into our global CSS file (see https://hugo-mini-course.netlify.app/sections/styling/custom/), the JS into a central place (header.html or footer.html in layouts/partials or maybe baseof.html) and then generate a short code based on the HTML (https://gohugo.io/templates/shortcode/). To then avoid having to include full reference details into the shortcode, we would want to look up the reference in a database - according to ChatGPT, that should be very easy: https://chatgpt.com/share/673dc36e-23e4-800e-b3a9-0a5e57494bfc, though I expect we might have to do some touble-shooting.

LukasWallrich avatar Nov 20 '24 11:11 LukasWallrich

This issue has been inactive for more than 90 days. If there is no further activity, it will be automatically closed in seven days time. You can reopen the issue if it is still relevant.

github-actions[bot] avatar Feb 11 '25 02:02 github-actions[bot]

This issue has been automatically closed due to it being stale for more than 7 days. Please feel free to reopen if you still want this issue.

github-actions[bot] avatar Feb 19 '25 02:02 github-actions[bot]

@seunolufemi123 are you still working on this? It would be a great improvement to the webpage ...

LukasWallrich avatar Feb 19 '25 13:02 LukasWallrich

Hi @LukasWallrich, I am so sorry that this is delayed, I lost track of it. Can we fix a meeting, at your convenience so you can help me make sense of what am supposed to do and how best I could do it? I would be looking forward to hearing from you. Thanks and Best regards.

seunolufemi123 avatar Feb 20 '25 10:02 seunolufemi123

There is actually a very nice hugo plugin that would get us 95% there: https://github.com/loup-brun/hugo-cite. However, it's not been updated since 2002 - not entirely sure if it is working at the moment, and can obviously break at any point.

https://github.com/joksas/hugo-simplecite is a more active project, but does not support APA style (only footnotes), and - more importantly - does not support a site-wide reference file (and as I see it not even a cited-in bibliography, which would make it much less useful for e.g. the glossary.

LukasWallrich avatar Mar 05 '25 16:03 LukasWallrich

We could go for a more "handmade" solution as suggested here - but that has already broken on their example site, so stating from hugo-cite (and maybe fixing issues in a PR to it) might be the best idea ...

LukasWallrich avatar Mar 05 '25 16:03 LukasWallrich

Process from here:

  • [ ] Lukas will set up hugo-cite on glossary landing page
  • [ ] Seun will check functionality and see if this is a good tool
  • [ ] S&L will decide on how to get citation data collected - e.g., a master spreadsheet (w/ key and bibliography entry)
  • [ ] S will document how to add bibliography entry and citation in text
  • [ ] S&L will agree how to get references into the text files

LukasWallrich avatar Mar 05 '25 17:03 LukasWallrich

Good stuff, I am looking forward to hearing from you.

seunolufemi123 avatar Mar 05 '25 17:03 seunolufemi123

This issue has been inactive for more than 90 days. If there is no further activity, it will be automatically closed in seven days time. You can reopen the issue if it is still relevant.

github-actions[bot] avatar May 05 '25 02:05 github-actions[bot]

This issue has been automatically closed due to it being stale for more than 7 days. Please feel free to reopen if you still want this issue.

github-actions[bot] avatar May 13 '25 02:05 github-actions[bot]

This issue has been inactive for more than 90 days. If there is no further activity, it will be automatically closed in seven days time. You can reopen the issue if it is still relevant.

github-actions[bot] avatar Sep 09 '25 02:09 github-actions[bot]

This issue has been automatically closed due to it being stale for more than 7 days. Please feel free to reopen if you still want this issue.

github-actions[bot] avatar Sep 17 '25 02:09 github-actions[bot]

🤖 Hi @LukasWallrich, I've received your request, and I'm working on it now! You can track my progress in the logs for more details.

github-actions[bot] avatar Oct 28 '25 22:10 github-actions[bot]