dita_sop_converter documentation

Add your content using reStructuredText syntax. See the reStructuredText documentation for details.

Contents:

• DITA SOP Converter - System Design
  • Architectural Forces and Constraints
• High-Level Architecture
• Core Design Patterns
  • Template Method – in ConverterPipeline
  • Strategy – classifier implementation
  • Composite Model – topic trees
  • Separation of Concerns
  • Software Design Patterns Used
• Internal Data Models (Updated)
  • Raw Structures
  • Classified Models
• Table + Step Handling (Updated)
  • Supported cases
• Image Handling Design (Updated)
• Naming + Map Model (Updated)
• Why the Pipeline Is Tolerant
• Extensibility Roadmap
• Summary
• Project development Guide
  • 1. Project layout
  • 2. Environment setup
  • 3. Coding standards
  • 4. Running tests
  • 5. Type checking (mypy)
  • 6. Logging
  • 7. Development workflow for improving conversion heuristics
  • 8. Adding new features
  • 9. Using this project in other tools
  • 10. Summary
• Runtime I/O Flow and Phase-2 Enhancements
  • 1. Runtime I/O Flow
  • 2. Performance and Profiling Strategy
  • 3. Phase-2 Enhancements (RFC-style)
  • 4. Risks
  • 5. Open questions
  • 6. Change history
• Pipeline Module
  • Responsibilities
  • ConverterPipeline
• docx_reader Module
  • DocxReader
  • RawBlock
  • RawDocument
  • RawSection
• Classifier Module
  • Responsibilities
  • Non-responsibilities
  • BaseClassifier
  • SopHeuristicClassifier
• Model Module
  • Block
  • ImageBlock
  • ImageConvertResult
  • ImageModel
  • MapEntry
  • MapModel
  • RawNoteBlock
  • StepBlock
  • TableBlock
  • TableRowBlock
  • TopicModel
  • TopicType
• dita_writer Module
  • DitaWriter
• Logging Module
  • configure_logging()
  • get_logger()