Skip to content

Investigate .zenodo.json Download Behavior and Download-Both Option #30

Description

@beanbean9339

Summary

OpenCite currently generates and downloads a Zenodo metadata file using the filename .zenodo.json. However, some browsers and operating systems do not reliably preserve leading-dot filenames when downloading files from a web application. As a result, users may receive zenodo.json instead of .zenodo.json.

Current Behavior

  • OpenCite generates valid Zenodo metadata.
  • The application requests the filename .zenodo.json.
  • Some browser/OS combinations may save the file as zenodo.json instead.

Expected Behavior

When possible, users should receive a correctly named .zenodo.json file that is compatible with GitHub and Zenodo workflows.

Potential Solutions

Option 1: Keep Current Behavior

  • Continue requesting .zenodo.json.
  • Document browser limitations.
  • Users can rename the file manually if necessary.

Option 2: Add "Download Both" ZIP Export

Provide a single ZIP download containing:

  • CITATION.cff
  • .zenodo.json

Benefits:

  • Preserves the exact filename inside the archive.
  • Allows users to download both metadata files at once.

Tradeoffs:

  • Requires users to extract the archive before use.
  • Adds additional export logic and ZIP generation dependencies.

Option 3: Add User Guidance

  • Display a note explaining that some browsers may remove the leading dot.
  • Provide instructions for renaming the file if needed.

Notes

  • The application previews already display the generated metadata and can be copied directly by users if download behavior is inconsistent.
  • This issue does not affect the validity of the generated metadata, only the downloaded filename.
  • A future "Download Both" feature would likely address this issue while also improving usability.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions