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

Using Label instead of Order in a Footnote #684

Open
omer-iqbal opened this issue Dec 11, 2022 · 1 comment
Open

Using Label instead of Order in a Footnote #684

omer-iqbal opened this issue Dec 11, 2022 · 1 comment
Labels

Comments

@omer-iqbal
Copy link

omer-iqbal commented Dec 11, 2022

I am working with documents and Islamic commentaries. My goal is to preserve the original footnote numbers or labels so they can be searched and found by the users and so users can also cite the original footnote when needed. So I need to preserve the original footnote.

There are two issues:

  1. For larger works, like books and commentaries, the original text is broken into multiple sections (which can be hundreds or even thousands for multi-volume works) and each section will be stored in its own markdown.
  2. Some works have footnotes that use non-numeric labels. For example, this Quran commentary book (e.g. page 112) uses letters a, b etc. for footnotes.

Based on that, it looks like footnotes need a feature where Footnote.Label can be used in the markup instead of the Footnote.Order property.

Then, based on an option provided, HtmlFootnoteGroupRenderer will either use Order or Label (without the ^ prefix).

If this proposal seems acceptable, I can try to make a pull request (not sure though what the time frame might look like).

Comments/suggestions/feedback welcome.

I looked at this list of issues and didn't find a similar issue.

@omer-iqbal omer-iqbal changed the title Adding IDs to footnote renderer Custom footnote IDs Dec 11, 2022
@omer-iqbal omer-iqbal changed the title Custom footnote IDs Using Label instead of Order in a Footnote Dec 13, 2022
@xoofx xoofx added the question label Jan 24, 2023
@xoofx
Copy link
Owner

xoofx commented Jan 24, 2023

Based on that, it looks like footnotes need a feature where Footnote.Label can be used in the markup instead of the [Footnote.Order]
(https://github.com/xoofx/markdig/blob/master/src/Markdig/Extensions/Footnotes/Footnote.cs#L30) property.

I'm confused, because Footnote in markdig do support using label instead of order here in the specs, so why this is not working for your case?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants