mirror of
https://github.com/BookStackApp/BookStack.git
synced 2026-02-08 19:06:06 +03:00
Footnote / source reference support in page editor #2160
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @Silence32 on GitHub (Mar 15, 2021).
A great feature would be to be able to make source references in text. The source references should then be listed collectively at the end of a page.
@ssddanbrown commented on GitHub (Oct 15, 2021):
Merging in #2745. Possible overlap with #1914
@ghost commented on GitHub (Nov 14, 2021):
What is the status of this as of today? I think something similar to the DokuWiki references plugin would make BookStack really solid for academic or academic-like content.
@ssddanbrown commented on GitHub (Nov 14, 2021):
@vogelfreiheit No update or progress currently.
If using the markdown editor, then we generally try to stick to commonmark, and hence support common-mark style reference links in markdown content: https://spec.commonmark.org/0.30/#reference-link. We don't have any automated editor functionality to support this commonmark feature.
@ssddanbrown commented on GitHub (May 4, 2023):
For those wanting this for the WYSIWYG editor, I have published a within-WYSIWYG editor hack here:
https://www.bookstackapp.com/hacks/wysiwyg-footnotes/
Considerations listed on that page.
@nharris-lmg commented on GitHub (Sep 29, 2023):
Adding a +1 to this feature as we are coming at it from a scientifically angled use case and would love an easy OOBE for managing cited sources.
@Zabien commented on GitHub (Jan 16, 2024):
As far as I understood, footnotes are part of Markdown, but not of CommonMark, so not supported here plus there is a hack for the WYSIWYG editor which has not yet been implemented into core and is also not on the roadmap for the near future? Could you please confirm this, @ssddanbrown? Either way, +1 for this feature from us.
@ssddanbrown commented on GitHub (Jan 16, 2024):
@Zabien That's pretty much correct, apart from "footnotes are part of Markdown", since it really depends on the implementation/flavour of markdown (since markdown is not a standard, which is the point of commonmark).
@Zabien commented on GitHub (Jan 17, 2024):
Agreed, thank you very much for your quick clarification! 🙏
@OddSquirrel commented on GitHub (Jun 14, 2024):
Is this working for anybody? Granted, I'm not the sharpest tool in the shed, but I took the script, put it into a file ("footnote.js") without the
<script>tags and placed the file inside mybookstack_app_data/www/volume, where also the index.html is located.Then, I added
<script src="footnote.js"></script>to my custom head setting.Result: No errors, but also no footnote button. 🙈
EDIT: It does work, when I put the script in the custom head setting as it is. Looks like the footnote.js just can't be found, and I'm too dumb to figure out the right folder. 😒
@rosahaj commented on GitHub (Jun 23, 2024):
@OddSquirrel Try chaning
<script src="footnote.js"></script>to<script src="/footnote.js"></script>(adding a/prefix to thesrcattribute). The script likely cannot be found because you're using a relative path.@OddSquirrel commented on GitHub (Jun 23, 2024):
@rosahaj Thanks for getting back to me! 😊 For now, it's been working just fine with the entire script right in the custom head settings. So far, it hasn't given me any problems other than making the settings a bit convoluted, but I'll definitely give it a spin with your advice when I have a bit more time on my hands. Thanks again! 👍
@mc-knife commented on GitHub (Oct 8, 2024):
just reporting here: this hack works well with v24.05.4 (says "Last Tested On: v23.05" on above link)
@JoomlaEstonia commented on GitHub (Jun 1, 2025):
Aare there any plans for future for adding references/citations as a core feature?
We've been using Wikimedia so far and been looking elsewhere for other options, but as citations are core feature and must-have, we don't feel confident enough to rely on a hack.
Thank you!
@ssddanbrown commented on GitHub (Jun 1, 2025):
@JoomlaEstonia No, not at this time.