search

quarto-dev / quarto-cli

Open-source scientific and technical publishing system built on Pandoc.
https://quarto.org
Other
3.99k stars 328 forks source link

Documentation for `funding` front matter doesn't match schema #10790

Open halleysfifthinc opened 2 months ago

halleysfifthinc commented 2 months ago

What would you like to do?

Give feedback or suggest an improvement

Description

The docs at https://quarto.org/docs/authoring/front-matter.html#funding show funding front-matter being able to be set like:

---
author:
  - name: Norah Jones
    id: nj
funding:
  - source: "NIH (Grant #: 1-R01-MH99999-01A1)"
    investigator: 
      - ref: nj
---

when the schema at https://github.com/quarto-dev/quarto-cli/blob/4ca7321584065f0b2632160cf03ff32c42e5a78f/src/resources/schema/document-funding.yml states that there must be an awards key under funding and above any array of sources/etc:

---
author:
  - name: Norah Jones
    id: nj
funding:
  awards:
    - source: "NIH (Grant #: 1-R01-MH99999-01A1)"
      investigator: 
        - ref: nj
---

quarto (v1.5.57) fails to render/preview without the awards key.

cderv commented 2 months ago

Thanks for catching that. It was improved 1.4 version to allow multiple fields https://github.com/quarto-dev/quarto-cli/commit/1fdf9ccf669bbc005d2cfb70e565d8c80fb0af0f

We'll update the doc

cderv commented 2 months ago

Looking into this we have issue for Jats so I'll handle it when fixing the issue, including our testing.