Repository Formats Overview
Complete guide to all repository formats and specifications supported by Door43
Repository Formats Overview
This section provides comprehensive documentation for all repository formats and specifications used in the Door43 ecosystem. The guides are organized by specification type for better clarity and navigation.
Resource Container (RC)
The primary unfoldingWord specification for Bible translation resources.
- Bible Text Repositories - UHB, UGNT, ULT, UST
- Translation Notes Repositories - TN, OBS-TN
- Translation Questions Repositories - TQ
- Translation Words Repositories - TW
- Translation Words Links Repositories - TWL
- Translation Academy Repositories - TA
- Open Bible Stories Repositories - OBS, OBS-TN, OBS-TWL
🌯 Scripture Burrito (SB)
Alternative Bible resource specification with flexible organization.
- Scripture Burrito Repositories - SB format handling
Tool-Generated Formats
Special formats created by translation tools with unique structures.
- translationCore Format - Single-book projects from translationCore
- translationStudio Format - Chapter/story projects from translationStudio
By Specification Type
- Resource Container: Most common format, used by unfoldingWord for all major resources
- Scripture Burrito: Alternative format, more flexible but less common
- Tool-Generated: Special handling for tool-specific formats
By Resource Type
- Bible Texts: UHB, UGNT, ULT, UST → Resource Container guides
- Translation Helps: TN, TQ, TW, TWL, TA → Resource Container guides
- Stories: OBS → Resource Container guides
- Tool Projects: → Tool-Generated guides
- Alternative Formats: → Scripture Burrito guides
By Use Case
- Building Preview Apps: Focus on Resource Container guides (most content)
- Creating Editing Tools: All specifications for comprehensive support
- Format Conversion: Migration guides for RC ↔ SB conversion
- Tool Integration: Tool-Generated guides for specific tool support
📊 Specification Comparison
| Aspect | Resource Container | Scripture Burrito | Tool-Generated |
|---|---|---|---|
| Primary Use | Standard unfoldingWord resources | Alternative Bible resources | Tool-specific projects |
| File Organization | Flat structure with manifest.yaml | Ingredients-based organization | Tool-specific patterns |
| Metadata Format | YAML manifest | JSON metadata | Tool-specific formats |
| Content Types | USFM, TSV, Markdown | Flexible MIME types | Tool-dependent |
| Complexity | Medium | High | Variable |
| Adoption | Very High | Low | Tool-specific |
New to Door43 Resources?
- Start with Resource Container Bible Text guide
- Learn the basic patterns and file structures
- Explore other Resource Container guides as needed
Need Alternative Formats?
- Check Scripture Burrito guide
- Use Migration guides for format conversion
Working with Tool Projects?
- Identify the tool that created the project
- Use the appropriate Tool-Generated guide
🔗 Related Documentation
- Getting Started - Introduction to the ecosystem
- Developer Guides - Technical implementation guides
- Migration & Conversion - Format conversion guides
- API Reference - Complete API documentation
Need help choosing the right guide? Most Door43 resources use the Resource Container specification, so start there unless you know you're working with Scripture Burrito or tool-generated content.