Submission 480, Citation Info

[mtwente]

Pull request

Proposed changes

• add DOI to frontmatter (reserved via Zenodo)
• add citation info (bibtex and plain text) at the bottom of the abstract

Adding this to the yaml frontmatter:

citation:
  type: speech
  event: Digital History Switzerland 2024
  container-title: 'Digital History Switzerland 2024: Book of Abstracts'
  editor:
  - Jérôme Baudry
  - Lucas Burkart
  - Béatrice Joyeux-Prunel
  - Eliane Kurmann
  - Moritz Mähr
  - Enrico Natale
  - Christiane Sibille
  - Moritz Twente

results in:

I'm not sure if type: speech is the correct tag, but it appears to be a better fit than type: paper-conference according to https://docs.citationstyles.org/en/stable/specification.html#appendix-iii-types

Types of changes

• New feature (non-breaking change which adds functionality).
• Enhancement (non-breaking change which enhances functionality)
• Bug Fix (non-breaking change which fixes an issue).
• Breaking change (fix or feature that would cause existing functionality to change).

Checklist

• I have read the README document.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have mentioned all co-authors in the PR description as Co-authored-by: Name <[email protected]>.

Summary by CodeRabbit

• New Features
  • Introduced a Digital Object Identifier (DOI) for improved citation and referencing.
  • Added a structured metadata format for the "Digital History Switzerland 2024" event, including citation details and editors.
  • Established a freeze policy for metadata updates to enhance organization and accessibility.

[coderabbitai]

Walkthrough

This pull request introduces a new metadata file, submissions/_metadata.yml, which provides structured information about the publication related to the "Digital History Switzerland 2024" event. It details citation formats, event information, and the editors involved. Additionally, it enhances the document at submissions/480/index.qmd by adding a DOI for improved citation and academic visibility.

Changes

Files	Change Summary
submissions/480/index.qmd	Added DOI 10.5281/zenodo.13768615 for citation purposes.
submissions/_metadata.yml	Introduced structured metadata for the publication, including citation format, event details, and editors.

Possibly related PRs

• Submission 480, Forney/Stuber #23: The changes in this PR involve the addition of a new DOI in submissions/480/index.qmd, which is relevant to the citation format introduced in the main PR's submissions/_metadata.yml.
• Submission 480, subsequent corrections #69: This PR includes corrections to the bibliographic entries in submissions/480/references.bib, which directly relates to the citation management aspect highlighted in the main PR's metadata structure.

Suggested labels

submission

Suggested reviewers

• maehr

Poem

In the meadow where knowledge blooms,
A DOI now lights up the rooms.
Citations dance with scholarly flair,
At "Digital History," we gather and share.
With each new detail, our work takes flight,
A rabbit's joy in the academic light! 🐇✨

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b18ad63 and e08cef1.

Files selected for processing (1)

• submissions/_metadata.yml (1 hunks)

Files skipped from review due to trivial changes (1)

• submissions/_metadata.yml

Warning

Review ran into problems

Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  -- I pushed a fix in commit <commit_id>, please review it.
  -- Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  -- @coderabbitai generate unit testing code for this file.
  -- @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  -- @coderabbitai generate interesting stats about this repository and render them as a table.
  -- @coderabbitai read src/utils.ts and generate unit testing code.
  -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[maehr]

@mtwente Thanks for the PR. I have some minor remarks.

1. Move the citation info to submissions/_metadata.yml to set metadata for all submissions (see https://quarto.org/docs/projects/quarto-projects.html#directory-metadata)
2. Change type to standard (@misc is the right bibtex key for presentations)
3. Activate freeze

format:
  html:
    citation:
      type: standard
      event: Digital History Switzerland 2024
      container-title: 'Digital History Switzerland 2024: Book of Abstracts'
      editor:
      - Jérôme Baudry
      - Lucas Burkart
      - Béatrice Joyeux-Prunel
      - Eliane Kurmann
      - Moritz Mähr
      - Enrico Natale
      - Christiane Sibille
      - Moritz Twente

freeze: auto

[maehr]

see https://github.com/digihistch24/book-of-abstracts/pull/70#issuecomment-2357605478

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0a217c3 and b18ad63.

Files selected for processing (2)

• submissions/480/index.qmd (1 hunks)
• submissions/_metadata.yml (1 hunks)

Files skipped from review due to trivial changes (1)

• submissions/480/index.qmd

Additional context used

yamllint

submissions/_metadata.yml

[error] 17-17: no new line character at the end of file

(new-line-at-end-of-file)

Additional comments not posted (1)

submissions/_metadata.yml (1)

1-16: LGTM! The metadata structure is well-organized and includes essential bibliographic information.

The YAML structure effectively captures the key metadata elements for the publication, including the citation type, event name, publication title, and list of editors. This structured approach enhances the organization and accessibility of the metadata, facilitating proper citation and reference management.