Loading Documentation Hub... Scanning documentation library
Loading Documentation Hub... Scanning documentation library
Loading Documentation Hub... Scanning documentation library
Завантаження документації... Підготовка контенту платформи Ring
Завантаження документації... Підготовка контенту платформи Ring
Завантаження документації... Підготовка контенту платформи Ring
Phase 3: Citation Manager & Bibliography System
Status : 📋 PlannedDuration : 3-4 weeksPrerequisites : Phase 2 Complete
Overview
Phase 3 builds a comprehensive citation management system with DOI/metadata import from multiple academic databases, 50+ citation styles via CSL, and seamless editor integration for inline citations and automatic bibliography generation.
🎯 Key Deliverables
Citation Database - Store and organize citations with librariesDOI Import - Auto-fetch metadata from CrossRef, PubMed, Semantic ScholarCSL Processor - 50+ citation styles (APA, MLA, Chicago, IEEE, etc.)Citation Manager UI - Library management and searchEditor Integration - Inline citations and auto-bibliography
📅 Sprint Breakdown
Sprint 3.1: Citation Database Schema & Core Types (1 week)
Task Description 3.1.1 Define Citation TypeScript types (CSL-JSON standard)
Phase 3: Citation Manager & Bibliography System
Status : 📋 PlannedDuration : 3-4 weeksPrerequisites : Phase 2 Complete
Overview
Phase 3 builds a comprehensive citation management system with DOI/metadata import from multiple academic databases, 50+ citation styles via CSL, and seamless editor integration for inline citations and automatic bibliography generation.
🎯 Key Deliverables
Citation Database - Store and organize citations with librariesDOI Import - Auto-fetch metadata from CrossRef, PubMed, Semantic ScholarCSL Processor - 50+ citation styles (APA, MLA, Chicago, IEEE, etc.)Citation Manager UI - Library management and searchEditor Integration - Inline citations and auto-bibliography
📅 Sprint Breakdown
Sprint 3.1: Citation Database Schema & Core Types (1 week)
Task Description 3.1.1 Define Citation TypeScript types (CSL-JSON standard)
Phase 3: Citation Manager & Bibliography System
Status : 📋 PlannedDuration : 3-4 weeksPrerequisites : Phase 2 Complete
Overview
Phase 3 builds a comprehensive citation management system with DOI/metadata import from multiple academic databases, 50+ citation styles via CSL, and seamless editor integration for inline citations and automatic bibliography generation.
🎯 Key Deliverables
Citation Database - Store and organize citations with librariesDOI Import - Auto-fetch metadata from CrossRef, PubMed, Semantic ScholarCSL Processor - 50+ citation styles (APA, MLA, Chicago, IEEE, etc.)Citation Manager UI - Library management and searchEditor Integration - Inline citations and auto-bibliography
📅 Sprint Breakdown
Sprint 3.1: Citation Database Schema & Core Types (1 week)
Task Description 3.1.1 Define Citation TypeScript types (CSL-JSON standard)
Create citation database schema
3.1.3 Create CitationService
3.1.4 Create CitationLibraryService
3.1.5 Create citation API routes
citations - Main citation storage with CSL-JSONcitation_libraries - User folders/collectionscitation_library_items - Many-to-many relationshippublication_citations - Citations used in publications
Sprint 3.2: DOI & Metadata Import Services (1 week) Create citation database schema
3.1.3 Create CitationService
3.1.4 Create CitationLibraryService
3.1.5 Create citation API routes
citations - Main citation storage with CSL-JSONcitation_libraries - User folders/collectionscitation_library_items - Many-to-many relationshippublication_citations - Citations used in publications
Sprint 3.2: DOI & Metadata Import Services (1 week) Create citation database schema
3.1.3 Create CitationService
3.1.4 Create CitationLibraryService
3.1.5 Create citation API routes
citations - Main citation storage with CSL-JSONcitation_libraries - User folders/collectionscitation_library_items - Many-to-many relationshippublication_citations - Citations used in publications
Sprint 3.2: DOI & Metadata Import Services (1 week) Task Description 3.2.1 Install import dependencies 3.2.2 Create CrossRefService 3.2.3 Create PubMedService 3.2.4 Create SemanticScholarService 3.2.5 Create OpenAlexService 3.2.6 Create unified CitationLookupService 3.2.7 Create BibTeX/RIS parser 3.2.8 Create lookup API routes
Task Description 3.2.1 Install import dependencies 3.2.2 Create CrossRefService 3.2.3 Create PubMedService 3.2.4 Create SemanticScholarService 3.2.5 Create OpenAlexService 3.2.6 Create unified CitationLookupService 3.2.7 Create BibTeX/RIS parser 3.2.8 Create lookup API routes
Task Description 3.2.1 Install import dependencies 3.2.2 Create CrossRefService 3.2.3 Create PubMedService 3.2.4 Create SemanticScholarService 3.2.5 Create OpenAlexService 3.2.6 Create unified CitationLookupService 3.2.7 Create BibTeX/RIS parser 3.2.8 Create lookup API routes
API Use Case Rate Limit CrossRef DOI metadata 50 req/sec PubMed Biomedical 10 req/sec (with key) Semantic Scholar AI/ML papers 100 req/5min OpenAlex Comprehensive 100K req/day
API Use Case Rate Limit CrossRef DOI metadata 50 req/sec PubMed Biomedical 10 req/sec (with key) Semantic Scholar AI/ML papers 100 req/5min OpenAlex Comprehensive 100K req/day
API Use Case Rate Limit CrossRef DOI metadata 50 req/sec PubMed Biomedical 10 req/sec (with key) Semantic Scholar AI/ML papers 100 req/5min OpenAlex Comprehensive 100K req/day
Sprint 3.3: Citation Style Language (CSL) Processor (1 week)
Sprint 3.3: Citation Style Language (CSL) Processor (1 week)
Sprint 3.3: Citation Style Language (CSL) Processor (1 week) Task Description 3.3.1 Install citeproc library 3.3.2 Download 50+ CSL style files 3.3.3 Create CSLProcessorService 3.3.4 Create CitationStylePicker component 3.3.5 Create BibliographyGenerator component
Task Description 3.3.1 Install citeproc library 3.3.2 Download 50+ CSL style files 3.3.3 Create CSLProcessorService 3.3.4 Create CitationStylePicker component 3.3.5 Create BibliographyGenerator component
Task Description 3.3.1 Install citeproc library 3.3.2 Download 50+ CSL style files 3.3.3 Create CSLProcessorService 3.3.4 Create CitationStylePicker component 3.3.5 Create BibliographyGenerator component
Category Styles Author-Date APA, MLA, Harvard, Chicago Author-Date Numeric IEEE, Vancouver, Nature, ACS Note Chicago Note, Turabian, OSCOLA
Category Styles Author-Date APA, MLA, Harvard, Chicago Author-Date Numeric IEEE, Vancouver, Nature, ACS Note Chicago Note, Turabian, OSCOLA
Category Styles Author-Date APA, MLA, Harvard, Chicago Author-Date Numeric IEEE, Vancouver, Nature, ACS Note Chicago Note, Turabian, OSCOLA
Sprint 3.4: Citation Manager UI (1 week)
Sprint 3.4: Citation Manager UI (1 week)
Sprint 3.4: Citation Manager UI (1 week) Task Description 3.4.1 Create Citation Manager page 3.4.2 Create CitationCard component 3.4.3 Create CitationForm component 3.4.4 Create QuickAddModal 3.4.5 Create ImportModal 3.4.6 Create LiteratureSearch component
Task Description 3.4.1 Create Citation Manager page 3.4.2 Create CitationCard component 3.4.3 Create CitationForm component 3.4.4 Create QuickAddModal 3.4.5 Create ImportModal 3.4.6 Create LiteratureSearch component
Task Description 3.4.1 Create Citation Manager page 3.4.2 Create CitationCard component 3.4.3 Create CitationForm component 3.4.4 Create QuickAddModal 3.4.5 Create ImportModal 3.4.6 Create LiteratureSearch component
Citation list with search/filter
Library sidebar (folders)
Quick add via DOI/URL
Bulk import from BibTeX/RIS
Literature search across databases
Sprint 3.5: Editor Citation Integration (1 week)
Citation list with search/filter
Library sidebar (folders)
Quick add via DOI/URL
Bulk import from BibTeX/RIS
Literature search across databases
Sprint 3.5: Editor Citation Integration (1 week)
Citation list with search/filter
Library sidebar (folders)
Quick add via DOI/URL
Bulk import from BibTeX/RIS
Literature search across databases
Sprint 3.5: Editor Citation Integration (1 week) Task Description 3.5.1 Create Tiptap citation extension 3.5.2 Create CitationInsertionModal 3.5.3 Create auto-bibliography extension 3.5.4 Add citation button to toolbar 3.5.5 Create citation sidebar panel 3.5.6 Update export services for citations
Task Description 3.5.1 Create Tiptap citation extension 3.5.2 Create CitationInsertionModal 3.5.3 Create auto-bibliography extension 3.5.4 Add citation button to toolbar 3.5.5 Create citation sidebar panel 3.5.6 Update export services for citations
Task Description 3.5.1 Create Tiptap citation extension 3.5.2 Create CitationInsertionModal 3.5.3 Create auto-bibliography extension 3.5.4 Add citation button to toolbar 3.5.5 Create citation sidebar panel 3.5.6 Update export services for citations
Ctrl+K - Insert citationInline citation rendering
Multiple citation support (Smith & Jones, 2020; Brown, 2021)
Auto-updating bibliography section
📦 Dependencies npm install citeproc csl-json doi-regex isbn3 bibtex-parse ris-parser zod
Environment Variables PUBMED_API_KEY=your-key
SEMANTIC_SCHOLAR_API_KEY=your-key
🔧 Technical Architecture
Service Structure features/citations/
├── types/
│ └── citation.ts # CSL-JSON types
├── services/
│ ├── citation-service.ts # CRUD operations
│ ├── citation-library-service.ts
│ ├── crossref-service.ts # CrossRef API
│ ├── pubmed-service.ts # PubMed API
│ ├── semantic-scholar-service.ts
│ ├── openalex-service.ts
│ ├── citation-lookup-service.ts # Unified lookup
│ ├── citation-parser-service.ts # BibTeX/RIS
│ └── csl-processor-service.ts # Formatting
├── csl-styles/
│ ├── apa-7th.csl
│ ├── mla-9th.csl
│ └── ... (50+ styles)
└── components/
├── citation-card.tsx
├── citation-form.tsx
├── citation-style-picker.tsx
└── ...
Citation Node Schema (Tiptap)
Ctrl+K - Insert citationInline citation rendering
Multiple citation support (Smith & Jones, 2020; Brown, 2021)
Auto-updating bibliography section
📦 Dependencies npm install citeproc csl-json doi-regex isbn3 bibtex-parse ris-parser zod
Environment Variables PUBMED_API_KEY=your-key
SEMANTIC_SCHOLAR_API_KEY=your-key
🔧 Technical Architecture
Service Structure features/citations/
├── types/
│ └── citation.ts # CSL-JSON types
├── services/
│ ├── citation-service.ts # CRUD operations
│ ├── citation-library-service.ts
│ ├── crossref-service.ts # CrossRef API
│ ├── pubmed-service.ts # PubMed API
│ ├── semantic-scholar-service.ts
│ ├── openalex-service.ts
│ ├── citation-lookup-service.ts # Unified lookup
│ ├── citation-parser-service.ts # BibTeX/RIS
│ └── csl-processor-service.ts # Formatting
├── csl-styles/
│ ├── apa-7th.csl
│ ├── mla-9th.csl
│ └── ... (50+ styles)
└── components/
├── citation-card.tsx
├── citation-form.tsx
├── citation-style-picker.tsx
└── ...
Citation Node Schema (Tiptap)
Ctrl+K - Insert citationInline citation rendering
Multiple citation support (Smith & Jones, 2020; Brown, 2021)
Auto-updating bibliography section
📦 Dependencies npm install citeproc csl-json doi-regex isbn3 bibtex-parse ris-parser zod
Environment Variables PUBMED_API_KEY=your-key
SEMANTIC_SCHOLAR_API_KEY=your-key
🔧 Technical Architecture
Service Structure features/citations/
├── types/
│ └── citation.ts # CSL-JSON types
├── services/
│ ├── citation-service.ts # CRUD operations
│ ├── citation-library-service.ts
│ ├── crossref-service.ts # CrossRef API
│ ├── pubmed-service.ts # PubMed API
│ ├── semantic-scholar-service.ts
│ ├── openalex-service.ts
│ ├── citation-lookup-service.ts # Unified lookup
│ ├── citation-parser-service.ts # BibTeX/RIS
│ └── csl-processor-service.ts # Formatting
├── csl-styles/
│ ├── apa-7th.csl
│ ├── mla-9th.csl
│ └── ... (50+ styles)
└── components/
├── citation-card.tsx
├── citation-form.tsx
├── citation-style-picker.tsx
└── ...
Citation Node Schema (Tiptap) { name : ' citation ' , group : ' inline ' , inline : true , atom : true , attrs : { citationIds : ' string[] ' , style : ' string ' , prefix : ' string ' , { name : ' citation ' , group : ' inline ' , inline : true , atom : true , attrs : { citationIds : ' string[] ' , style : ' string ' , prefix : ' string ' , { name : ' citation ' , group : ' inline ' , inline : true , atom : true , attrs : { citationIds : ' string[] ' , style : ' string ' , prefix : ' string ' ,
📊 Success Metrics
📊 Success Metrics
📊 Success Metrics Metric Target DOI lookup <2s Citation search <3s CSL formatting <100ms per citation Bibliography (100 citations) <1s Import 1000 citations <10s Time to add citation <10s via DOI Citation insertion <3 clicks
Metric Target DOI lookup <2s Citation search <3s CSL formatting <100ms per citation Bibliography (100 citations) <1s Import 1000 citations <10s Time to add citation <10s via DOI Citation insertion <3 clicks
Metric Target DOI lookup <2s Citation search <3s CSL formatting <100ms per citation Bibliography (100 citations) <1s Import 1000 citations <10s Time to add citation <10s via DOI Citation insertion <3 clicks
⚠️ Risk Mitigation
⚠️ Risk Mitigation
⚠️ Risk Mitigation Risk Mitigation External API availability Fallback chain, caching CSL complexity Use well-tested citeproc library Rate limiting Request queuing, caching Data quality Allow manual editing, merge from multiple sources
Risk Mitigation External API availability Fallback chain, caching CSL complexity Use well-tested citeproc library Rate limiting Request queuing, caching Data quality Allow manual editing, merge from multiple sources
Risk Mitigation External API availability Fallback chain, caching CSL complexity Use well-tested citeproc library Rate limiting Request queuing, caching Data quality Allow manual editing, merge from multiple sources
📚 Citation Types Supported
📚 Citation Types Supported
📚 Citation Types Supported Type Example Journal Article Smith, J. (2024). Title. Journal , 1(2), 1-10. Book Author, A. (2024). Book Title . Publisher. Book Chapter Author, A. (2024). Chapter. In Book . Publisher. Conference Paper Author, A. (2024). Paper. In Proceedings . Thesis Author, A. (2024). Thesis Title [PhD]. University. Report Organization. (2024). Report Title . Webpage Author. (2024). Page Title . URL Dataset Author. (2024). Dataset [Data set]. Repository. Software Author. (2024). Software (Version 1.0).
Type Example Journal Article Smith, J. (2024). Title. Journal , 1(2), 1-10. Book Author, A. (2024). Book Title . Publisher. Book Chapter Author, A. (2024). Chapter. In Book . Publisher. Conference Paper Author, A. (2024). Paper. In Proceedings . Thesis Author, A. (2024). Thesis Title [PhD]. University. Report Organization. (2024). Report Title . Webpage Author. (2024). Page Title . URL Dataset Author. (2024). Dataset [Data set]. Repository. Software Author. (2024). Software (Version 1.0).
Type Example Journal Article Smith, J. (2024). Title. Journal , 1(2), 1-10. Book Author, A. (2024). Book Title . Publisher. Book Chapter Author, A. (2024). Chapter. In Book . Publisher. Conference Paper Author, A. (2024). Paper. In Proceedings . Thesis Author, A. (2024). Thesis Title [PhD]. University. Report Organization. (2024). Report Title . Webpage Author. (2024). Page Title . URL Dataset Author. (2024). Dataset [Data set]. Repository. Software Author. (2024). Software (Version 1.0).
suffix
:
'
string
'
,
locator : ' string (page numbers) '
}
}
suffix
:
'
string
'
,
locator : ' string (page numbers) '
}
}
suffix
:
'
string
'
,
locator : ' string (page numbers) '
}
}
