Welcome to the Codexis documentation! This site provides comprehensive information about our Elixir-based book building system, designed to transform LaTeX manuscripts into multiple publication formats with robust quality assurance.

Project Overview

Codexis is an advanced book building system that transforms LaTeX manuscripts into high-quality digital publications. Built on Elixir/OTP, the system leverages functional programming, robust concurrency, and comprehensive quality checks to ensure consistent, high-quality output across multiple formats.

Key Features

• Unified Build System:
  • Shared temporary directory for efficient multi-format builds
  • Eliminates redundant LaTeX processing (40-60% faster builds)
  • Centralized temp directory management with secure permissions
  • Comprehensive error handling and recovery mechanisms
• Modular Architecture:
  • BuildOrchestrator for process coordination
  • Format-specific builders for each output type
  • Comprehensive quality checking system
• Multiple Output Formats:
  • PDF from LaTeX source
  • EPUB with accessibility validation
  • HTML for web distribution
  • DOCX for Microsoft Word
  • Markdown/WikiJS for documentation
  • RTF for rich text format
• Quality Assurance:
  • Cross-format consistency validation
  • Mathematical content preservation testing
  • Performance benchmarking and monitoring
  • Comprehensive test coverage (unit, integration, end-to-end)
• Metadata Management:
  • YAML-based configuration
  • Consistent metadata across formats
  • Automated metadata enrichment

Documentation Sections

• Unified Build System Guide: Complete guide to efficient multi-format builds
• Unified Build System Troubleshooting: Diagnostic and resolution guide
• Architecture: System design, component interaction, and data flow
• Build Process: Step-by-step format generation and validation
• Quality Control: Validation tools and quality assurance processes
• Directory Structure: Standardized project organization
• Migration: Implementation status and ongoing improvements

Getting Started

To begin working with the Codexis project:

1. Check the Architecture Documentation for system design
2. Review the Event Storming Analysis for domain understanding
3. Set up the required directory structure in manuscript/
4. Adhere to project Conventions for development

Project Structure

manuscript/
├── content/
│   ├── front-matter/
│   ├── chapters/
│   ├── back-matter/
│   ├── images/
│   ├── figures/
│   ├── tables/
│   └── bibliography/
├── styles/
├── assets/
├── output/
│   ├── pdf/
│   ├── epub/
│   ├── mobi/
│   ├── html/
│   └── markdown/
└── config.yaml

Current Status

The project implements a complete book building pipeline with:

• Core Components:

  • BookBuilderOrchestrator for process management
  • MetadataHandler for configuration
  • FileStructureSetup for directory management

• Build Pipeline:

  • PDF generation from LaTeX
  • HTML conversion via make4ht
  • EPUB creation with tex4ebook
  • MOBI conversion using Calibre
  • Kindle format generation

• Quality Assurance:

  • Automated validation checks
  • Accessibility testing
  • Version comparison tools

For detailed implementation information, refer to the Architecture Documentation and Event Storm Analysis.