Skip to content
Heleno Salgado edited this page Nov 8, 2026 · 3 revisions

🎓 Bem-vindo à Wiki do OpenSciMD

Open Access Python 3.11+ Package Manager: uv Format: Markdown

O OpenSciMD é uma iniciativa aberta voltada à curadoria, normalização tipográfica, preservação e difusão de artigos científicos e tratados clássicos de domínio público, estruturados em Markdown e integrados ao ecossistema de leitura LeiaME.

O projeto harmoniza o rigor filológico e editorial com a engenharia de software moderna, disponibilizando automações via CLI (openscimd), reflow semântico com o motor SalopDoc, validação estrita de metadados e múltiplos alvos de publicação.


Tip

Primeira vez no projeto?
Comece explorando o Guia do Colaborador para aprender como sugerir revisões em livros existentes ou converter novos artigos acadêmicos.


🗺️ Mapa Rápido da Documentação

Guia Foco Principal Público Alvo
📖 Guia do Colaborador Fluxo de ingestão de PDFs, criação de Markdown e abertura de revisões. Leitores, revisores e novos contribuidores
🛠️ CLI openscimd Catálogo completo dos comandos de validação, conversão, capas e exportação. Desenvolvedores e editores técnicos
🏷️ Diretrizes de Metadados Especificação do YAML Frontmatter e o Princípio de Separação de Categorias. Catalogadores e curadores de conteúdo
✍️ Padrão Editorial & Aparato Crítico Convenções para notas do autor ([^1]), do tradutor ([^nt1]) e editoriais ([^ne1]). Tradutores e revisores filológicos

🔄 Pipeline do Ecossistema

O diagrama abaixo ilustra o ciclo de vida de uma obra dentro do OpenSciMD, desde o arquivo bruto original até a entrega em múltiplos formatos:

flowchart TD
    Raw["📄 PDF / Documento Bruto (data/raw/)"] -->|openscimd import-pdf| SalopDoc["⚙️ Motor SalopDoc (Reflow & YAML)"]
    SalopDoc --> Draft["📝 Rascunho Inicial (data/draft/)"]
    Draft --> Review["🔍 Fila de Revisão Editorial (data/review/)"]
    Review -->|openscimd validate| Canon["📚 Acervo Oficial (content/)"]
    
    subgraph Canais de Entrega
        Canon -->|API GitHub / Cloudflare| LeiaME["📱 Aplicativo LeiaME"]
        Canon -->|openscimd epub| Kindle["📖 EPUB 3 (Send to Kindle)"]
        Canon -->|openscimd print| Print["🖨️ Amazon KDP (Livro Impresso)"]
        Canon -->|openscimd build-rag| RAG["🔎 SQLite FTS5 (Busca RAG Local)"]
    end
Loading

🏛️ Princípios Fundamentais

Important

  1. Fidelidade Filológica: Obras clássicas e históricas preservam a intenção do autor original e a correspondência 1:1 com as melhores edições de referência, evitando anacronismos ou cortes.
  2. Separação Conteúdo vs. Apresentação: O acervo vive em Markdown puro. O mesmo arquivo alimenta o aplicativo de leitura, compila o livro impresso com cálculo de lombada e gera o EPUB para e-readers.
  3. Engenharia Determinística: Validação automatizada de metadados, suíte completa de testes unitários com pytest e gestão reproduzível de dependências com uv.

💬 Comunidade & Suporte

Clone this wiki locally