|
40 | 40 |
|
41 | 41 | --- |
42 | 42 |
|
| 43 | +## Statement of Need |
| 44 | + |
| 45 | +Researchers frequently accumulate reference lists in ad-hoc formats — DOIs copied from browser tabs, arXiv IDs from paper PDFs, titles typed by hand, and BibTeX fragments from various sources. Cleaning these into a consistent, complete `.bib` file is tedious and error-prone. |
| 46 | + |
| 47 | +OneCite solves this by accepting **any mix of identifiers and text queries** and automatically resolving them to structured BibTeX through a pipeline of academic APIs (CrossRef, arXiv, PubMed, Semantic Scholar, and others). It is designed for researchers who work primarily in the terminal, use LaTeX, and want a lightweight, scriptable tool — not a full reference manager. |
| 48 | + |
| 49 | +**When to use OneCite vs. alternatives:** |
| 50 | + |
| 51 | +| Tool | Best for | |
| 52 | +|---|---| |
| 53 | +| **OneCite** | One-shot conversion of messy reference lists to BibTeX in a terminal/script | |
| 54 | +| **Zotero** | Long-term reference management, GUI-based, browser integration | |
| 55 | +| **CrossRef API directly** | When you have clean DOIs and want canonical metadata | |
| 56 | +| **doi2bib** | Single DOI → BibTeX conversion, no fuzzy matching | |
| 57 | + |
| 58 | +--- |
| 59 | + |
43 | 60 | ## Features |
44 | 61 |
|
45 | 62 | | Feature | Description | |
46 | 63 | | ----------------------- | ------------------------------------------------------------------------------------------------------- | |
47 | 64 | | **Fuzzy Matching** | Match references against multiple academic databases even from incomplete or inaccurate info. | |
48 | | -| **Multiple Formats** | Input `.txt`/`.bib` → Output **BibTeX**, **APA**, or **MLA**. | |
| 65 | +| **Multiple Formats** | Input `.txt`/`.bib` → Output **BibTeX**. | |
49 | 66 | | **4-stage Pipeline** | A 4-stage process (clean → query → validate → format) to produce consistent output. | |
50 | 67 | | **Field Completion** | Enrich entries by filling in missing fields like journal, volume, pages, and authors. | |
51 | 68 | | 🎓 **7+ Citation Types** | Handles journal articles, conference papers, books, software, datasets, theses, and preprints. | |
52 | | -| **Domain-Aware Routing** | Auto-detects content type and domain (Medical/CS/General) to pick the best data source. | |
| 69 | +| **Multi-Source Lookup** | Queries CrossRef, arXiv, PubMed, Semantic Scholar, Google Books, and others for every entry. | |
53 | 70 | | **Many Identifier Types** | Accepts DOI, PMID, arXiv ID, ISBN, GitHub URL, Zenodo DOI, or plain text queries. | |
54 | 71 | | 🎛️ **Interactive Mode** | Manually select the correct entry when multiple potential matches are found. | |
55 | 72 | | **Custom Templates** | YAML-based templates to control which fields are collected and how entries are typed. | |
@@ -144,14 +161,12 @@ Your `results.bib` file now contains entries of different types. |
144 | 161 | ## 📖 Advanced Usage |
145 | 162 |
|
146 | 163 | <details> |
147 | | -<summary><strong>🎨 Multiple Output Formats (APA, MLA)</strong></summary> |
| 164 | +<summary><strong>Direct String and Stdin Input</strong></summary> |
148 | 165 |
|
149 | 166 | ```bash |
150 | | -onecite process refs.txt --output-format apa |
151 | | -# → LeCun, Y., Bengio, Y., & Hinton, G. (2015). Deep learning. Nature, 521(7553), 436-444. |
152 | | - |
153 | | -onecite process refs.txt --output-format mla |
154 | | -# → LeCun, Yann, Yoshua Bengio, and Geoffrey Hinton. "Deep Learning." Nature 521.7553 (2015): 436-444. |
| 167 | +onecite process "10.1038/nature14539" |
| 168 | +onecite process "Attention is all you need, Vaswani et al., NIPS 2017" |
| 169 | +echo "10.1038/nature14539" | onecite process - |
155 | 170 | ``` |
156 | 171 | </details> |
157 | 172 |
|
|
0 commit comments