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

References key not working in page YAML #654

Closed
1 task done
Erin-Cecele opened this issue Jan 23, 2023 · 4 comments
Closed
1 task done

References key not working in page YAML #654

Erin-Cecele opened this issue Jan 23, 2023 · 4 comments
Labels
bug Actual behavior does not match expected behavior quire-11ty This is an issue with the quire-11ty package

Comments

@Erin-Cecele
Copy link
Collaborator

Erin-Cecele commented Jan 23, 2023

Before proceeding, check to make sure there isn’t an existing issue for this bug.

  • I have searched the existing issues and determined this is a new bug.

Steps to reproduce

Adding references (as in example below) to page YAML does not add page-level biblio.

title: Chapter Title
order: 10
layout: page
references:
 - "West 1939"
 - "Evans 1938"
 - "Lynd 1929"

Actual behavior

Nothing happens when a references key is added to the page YAML. The biblio does not appear. It doesn't break the preview. There is no messaging output related to references in the Terminal.

Expected behavior

Per v0, the references key should either add a page-level bibliography in place of what is created by the {% cite %} shortcode or it should add additional references to an existing bibliography (created by the {% cite %} shortcode) and sort accordingly.

PLEASE NOTE: While this key was originally called references in v0, we would like to suggest renaming it citations as this will connect it more to the {% cite %} shortcode (ie., there are two ways to add citations, with the {% cite %} shortcode or in the page yaml with citations). And anything called "references" should be a list like what we find in references.yaml.

Version numbers

quire: 1.0.0-rc.0
node: 18.12.1

What browsers are you seeing the problem on?

Chrome

Relevant Terminal/Shell output

No response

Supporting Information

This is related to GH Discussion #555 and Quire-Docs Disccussion #440.

@Erin-Cecele Erin-Cecele added the status:triage needed Issue needs to be triaged by the Quire team. This label is automatically applied to new issues. label Jan 23, 2023
@Erin-Cecele
Copy link
Collaborator Author

Related to Jira issue DEV-12066

@Erin-Cecele Erin-Cecele added status:backlog Issue is a lower priority but needs to eventually be addressed bug Actual behavior does not match expected behavior quire-11ty This is an issue with the quire-11ty package and removed status:triage needed Issue needs to be triaged by the Quire team. This label is automatically applied to new issues. labels May 30, 2023
@Erin-Cecele Erin-Cecele added status:triage needed Issue needs to be triaged by the Quire team. This label is automatically applied to new issues. and removed status:backlog Issue is a lower priority but needs to eventually be addressed labels Jun 27, 2023
@Erin-Cecele Erin-Cecele added status:needs discussion Issue needs discussion before being addressed and removed status:triage needed Issue needs to be triaged by the Quire team. This label is automatically applied to new issues. labels Jul 13, 2023
@Erin-Cecele
Copy link
Collaborator Author

Just tested this, and it still isn't working. Needs further discussion with the core team.

@Erin-Cecele Erin-Cecele added status:backlog Issue is a lower priority but needs to eventually be addressed and removed status:needs discussion Issue needs discussion before being addressed labels Aug 3, 2023
@Erin-Cecele
Copy link
Collaborator Author

After discussion with the team, we opened a ticket to address the issue. This is a lower priority so will remain on backlog for the time being. In the meantime, if someone from the community is interested in addressing this issue, let us know!

@Erin-Cecele Erin-Cecele removed the status:backlog Issue is a lower priority but needs to eventually be addressed label Aug 14, 2023
@Erin-Cecele
Copy link
Collaborator Author

Erin-Cecele commented Aug 14, 2023

This issue was fixed with PR #818 and will be included in the next release candidate: 1.0.0-rc.13

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Actual behavior does not match expected behavior quire-11ty This is an issue with the quire-11ty package
Projects
None yet
Development

No branches or pull requests

2 participants