quarto-dev / quarto-dev/quarto-cli

Citation Metadata reference page doesn't list all available options

Open Beginner friendly
#8,713 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation metadata
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

Description

The reference page for Citation Metadata currently lists the keys from csl-item: abstract, author, doi, references and title.

https://github.com/quarto-dev/quarto-cli/blob/e5649053e3afcdee6beeae379121b75214e741b0/src/resources/schema/definitions.yml#L2193-L2220

Shouldn't it list the keys for both csl-item and csl-item-shared. E.g. these ones are missing:

https://github.com/quarto-dev/quarto-cli/blob/e5649053e3afcdee6beeae379121b75214e741b0/src/resources/schema/definitions.yml#L1715-L2191

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the Citation Metadata reference page with the csl-item and csl-item-shared definitions in src/resources/schema/definitions.yml, especially the linked ranges. Update the reference so it lists the available keys from both definitions, then verify that the missing shared options are present on the rendered page.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
60/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.