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

Sort References by Order of Appearance in Document #806

Open
samm82 opened this issue Jul 10, 2018 · 2 comments
Open

Sort References by Order of Appearance in Document #806

samm82 opened this issue Jul 10, 2018 · 2 comments

Comments

@samm82
Copy link
Collaborator

samm82 commented Jul 10, 2018

As mentioned in #729, there should be a function that creates an Ordering to be passed into bibMap and citationsFromBibMap to sort the references by order of appearance in the document.

@samm82 samm82 self-assigned this Jul 10, 2018
@samm82 samm82 changed the title Sort by Order of Appearance in Document Sort References by Order of Appearance in Document May 3, 2019
@balacij balacij added newcomers Good first issue to work on! artifacts and removed enhancement Low Priority labels Apr 26, 2023
@balacij
Copy link
Collaborator

balacij commented Jul 21, 2024

If we want to sort references by order of appearance in documents, it might be simplest to switch to a Stateful renderer. Otherwise, we would need to pre-calculate how things would be rendered (without rendering the artifacts), keeping track of the order citations appear, and then using that ordering in the real deal rendering.

I think we've seen enough issues such that I'm convinced a Stateful renderer wouldn't be a bad thing, necessarily. @JacquesCarette Do you have any thoughts on this?

Some more tickets this where this might be helpful

  1. Determine Document Outline from Actual Document Contents #946
  2. Printing mdBook SRS to different files / Generating multi-file software artifacts #3796
  3. ? (I will update as I go along thru the tickets) MOVED TO Stateful artifact rendering: Verify it makes sense to implement (and implications), design, and implement #3864

@JacquesCarette
Copy link
Owner

A stateful renderer would not be a bad thing.

I'm not a big fan of having references in order of first appearance - but there are styles that require this. So we should have the capability to do so.

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

No branches or pull requests

3 participants