observational-dev / oawiki

Repository for wiki.observational.space
https://wiki.observational.space/
Creative Commons Attribution Share Alike 4.0 International
2 stars 4 forks source link

Citation Scheme #10

Closed BakerBelays closed 8 months ago

BakerBelays commented 9 months ago

We need a useful scheme to create citations, be it for images or pieces of information. This should be a priority- it separates the wiki from other sources that often self-cite or rely on things they've heard (CN, Discord, etc)

peytondmurray commented 9 months ago

There's a couple of options here:

  1. Use footnotes as a simpler way of doing this
  2. If we want something more formal, we can use sphinxcontrib-bibtex which can actually render citations specified in a refs.bib file: image

The problem with option 2 is (quoting the docs)

Citations in sphinx are resolved globally across all documents. Typically, you have a single bibliography directive across your entire project which collects all citations. Advanced use cases with multiple bibliography directives across your project are also supported, but some care needs to be taken from your end to avoid duplicate citations.

BakerBelays commented 8 months ago

Yep, then footnotes makes the most sense. Most of the time the citations are just going to be leading people to good places. Glad to see Sphinx is strong.

Certain resources will be getting pulled from often, especially physical text when it comes to ATM. It might make sense to have a small bibliography library in addition to the footnotes, but that's probably best addressed when we get to that point

random-person-001 commented 8 months ago

+1 for footnotes for now, and after we have a fair amount of content, if we feel like a bibliography would be useful, we cross that road when we get there