Repository navigation
Citation Workflow v0.3.0
Choose Windows, macOS or Linux for your download folder, and send feedback directly through GitHub Issues.
Open the website · Read the setup guide
What's new
- Cross-platform downloads: the homepage, download settings and batch page share a Windows / macOS / Linux selector. Windows is the default on a first visit; each system remembers its own folder.
- macOS and Linux companion support: POSIX absolute paths and
~/...home-directory paths are supported. Start the companion withsh start.sh; Windows continues to usestart.bat. The selected system must match the computer running the companion. - Feedback: a muted speech-bubble icon and text link sits beside the outlined Batch download button on the homepage and remains in the batch page's top-right corner. It opens GitHub Issues, with bug-report and suggestion forms. A GitHub account is required to submit feedback; issues are public.
- Preprints and conferences: DOI, arXiv and supported preprint/conference links retain their paper type and explicit version. Original repositories include arXiv, bioRxiv/medRxiv, ChemRxiv, PMLR, NeurIPS, CVF and ACL where metadata and accessible PDFs are available.
- Full-text routing: source history records availability and verification failures across PMC and the supported databases. Current PMC cloud datasets and public catalogue download routes are supported. Source failures do not mean a paper has no accessible full text.
- Compatibility checks: Windows and Ubuntu checks must pass before deployment. macOS checks run separately, so a waiting macOS runner does not delay website updates.
Upgrade
- Close the old companion before starting the new version.
- Download Source code (zip) or Source code (tar.gz) from this release and extract it into a new folder.
- Install Python 3.10 or later. On Windows, double-click
start.bat. On macOS or Linux, open a terminal in the extracted folder and runsh start.sh. - Keep the companion running and refresh the website, or open http://127.0.0.1:8765/.
- Choose your operating system and an existing download folder. The folder picker requires Tkinter and a graphical desktop; a typed path also works.
No Node.js installation or third-party Python packages are required to run the companion. Updating only the website does not update an already-running companion.
Validation and limitations
Python and JavaScript checks cover path validation, legacy settings, per-system folder memory, PDF saving, duplicate filenames, references and paper types. Windows and Ubuntu (WSL) also saved the same real PMLR PDF successfully, with matching SHA-256 hashes. Desktop and narrow-screen browser checks cover the homepage, system selection and batch feedback link.
macOS support is available, but has not undergone complete testing. Its compatibility workflow runs separately and does not block deployment. Native macOS folder selection, browser permissions and end-to-end PDF downloads remain unverified. Full-text access depends on external sources and may require institutional sign-in or manual downloading. This release does not resolve every retrieval or citation-formatting issue identified during testing.
Developed by Marron Zihao Yao.