Bibliothek
KatanA Document Viewer
Eine Rust-Bibliothek zum Einbetten von Dokumentvorschauen sowie HTML-, PDF- und Bildexport in eine App. Sie verwendet UI-unabhängige Dokumentdaten.
Rust-Entwickler, die Dokumentviewer oder HTML-, PDF- und Bildexport einbetten
01
Implementierte Fähigkeiten
02
Erste Schritte
- Holen Sie das Repository und prüfen Sie im README die Anforderungen an Laufzeit und Schriften.
- Verwenden Sie das export_debug-Beispiel mit Markdown-Datei und Ausgabeordner und prüfen Sie das erzeugte Dokument.
Bereiten Sie Rust und die erforderlichen Entwicklungstools vor und prüfen Sie vor der Installation die Umgebungsanforderungen im verknüpften README. Beispiele zeigen einen Einstieg und garantieren keinen Betrieb in jeder Umgebung.
Belegegit clone https://github.com/HiroyukiFuruno/katana-document-viewer.git
cd katana-document-viewer
cargo run -p katana-document-viewer --example export_debug -- README.md ./export-output01 / KDV
Anwendungsfälle
Gemeinsame Plattform zum Anzeigen und Exportieren von Dokumenten
Es eignet sich, wenn Sie Markdown als KDV-Dokumentrahmen, -status und -diagnose behandeln möchten, ohne es direkt an eine app-spezifische Benutzeroberfläche zu binden, und HTML, PDF, PNG und JPEG aus derselben Renderpipeline generieren möchten. Die Grenzen der Viewer-Anzeige und der Exportverarbeitung können gemeinsam genutzt werden.
Vorbereiten des Exports eines Dokuments mit Abbildungen und Tabellen
Sie können mit KDV Markdown mit Diagrammen und Formeln erstellen, die Diagrammwiedergabe an KRR delegieren und nicht unterstützte Bedeutungen als Diagnose- und Rohquellen beibehalten. Dies ist die Grundlage, wenn Sie Eingaben, die auf der Anzeigeseite nicht interpretiert werden können, in einem Zustand belassen möchten, der später verarbeitet werden kann, anstatt sie stillschweigend zu verwerfen.
02 / KDV
Ablauf von Eingabe zu Ausgabe
Eingabe normalisieren
Lesen Sie die Eingabedatei, richten Sie CRLF/CR an LF aus und normalisieren Sie den Markdown-Fence mit MarkdownFenceNormalizer. Legen Sie den URI, die Art der Quelle, die Revision und den Text für die Eingabequelle fest.
Erstellen Sie einen Snapshot und erstellen Sie ein Diagramm
Strukturieren Sie Markdown mit KatanaMarkdownModel::parse und erstellen Sie einen Snapshot mit DocumentSnapshotFactory::from_kmm. Übergeben Sie das Markdown-Exportprofil und das Design an BuildRequest und generieren Sie einen BuildGraph einschließlich Diagnose mit ForgePipeline::build.
Speichern Sie Artefakte und Diagnosen
Übergeben Sie das Build-Diagramm an ForgePipeline::export, um Artefakte für jedes Format zu erstellen und sie zusammen mit dem Build-Diagramm, der Abdeckung und dem zusammenfassenden TOML auszugeben. Wenn das Artefakt leer ist, führt der Beispielexportprozess zu einem Fehler und der Benutzer erhält kein unvollständiges Artefakt.
03 / KDV
Wichtige APIs und CLI
DocumentSnapshotFactory — Dokument-Snapshot- Kombinieren Sie das KMM-Dokument und DocumentSource, um einen DocumentSnapshot zu erstellen, den Viewer/Forge verarbeiten kann. Nicht nur der Eingabetext, sondern auch der URI und die Revision sind Voraussetzungen für den Snapshot.
ForgePipeline::build — Build-Pipeline- Verarbeitet den Snapshot, das BuildProfile und das Design von BuildRequest und gibt einen BuildGraph mit dem Snapshot, dem Profil, der Diagnose und den gerenderten Diagrammen des Dokuments zurück.
ForgePipeline::export — Dokumentexport- Gibt ExportOutput aus dem Build-Diagramm, dem Format und dem Thema von ExportRequest zurück. Das Format ist HTML, PDF, PNG und JPEG, und Artefakte und gefälschte Diagnosen können kombiniert und an die nächste Stufe übergeben werden.
KRR-Diagramm-Backend- Verbinden Sie das Diagrammrendering mit der KRR-Grenze, indem Sie DiagramRenderingBackend und KrrDiagramRenderEngine an die Pipeline übergeben. KDV selbst ist keine API, die direkt Eigentümer der App-Benutzeroberfläche oder einer anderen Diagrammimplementierung ist.
04 / KDV
An einem Beispiel verstehen
Beispiel für die Erstellung einer README-Datei und die Überprüfung der Anzahl der Dokumentknoten
Dieser Code liest README.md, normalisiert, parst und erstellt einen Snapshot, baut mit dem Markdown-Exportprofil einen BuildGraph und zeigt die Anzahl der nodes an. Der Build-Teil wird aus dem öffentlichen export_debug-Beispiel extrahiert und weder in einer Datei gespeichert noch in 4 Formate exportiert.
use katana_document_viewer::{
BuildProfile, BuildRequest, DiagramRenderingBackend, DocumentSnapshotFactory,
DocumentSource, ForgePipeline, KrrDiagramRenderEngine, MarkdownFenceNormalizer,
SourceKind, SourceRevision, SourceUri,
};
use katana_markdown_model::{KatanaMarkdownModel, MarkdownInput};
use std::fs;
fn main() -> Result<(), Box<dyn std::error::Error>> {
let path = "README.md";
let content = MarkdownFenceNormalizer::normalize(&fs::read_to_string(path)?);
let source = DocumentSource {
uri: SourceUri(format!("file://{path}")),
kind: SourceKind::Markdown,
revision: SourceRevision("local".to_string()),
content: content.clone(),
};
let document = KatanaMarkdownModel::parse(MarkdownInput::from_content(path, content))?;
let snapshot = DocumentSnapshotFactory::from_kmm(source, document);
let request = BuildRequest {
snapshot,
profile: BuildProfile::markdown_export(),
theme: Default::default(),
};
let pipeline = ForgePipeline::new(DiagramRenderingBackend::new(KrrDiagramRenderEngine));
let graph = pipeline.build(&request)?;
println!("nodes={}", graph.snapshot.document.nodes.len());
Ok(())
}05 / KDV
Integration und Grenzen
Bringen Sie kein UI-Backend ein
KDV ist nicht auf UI-Backends wie egui/eframe angewiesen und stellt KUC-Typen auch nicht der öffentlichen API zur Verfügung. Übergeordnete Apps wie KatanA sind für die Synchronisierung von Viewer und Editor verantwortlich, während KDV sich auf die Grenze Dokument/Viewer/Export konzentriert.
Als Gerüst vorstellen
Der öffentliche README-Status ist Gerüstbau, v0.1.0 ist eine UI-unabhängige Artefakt-/Forge-/Export-Grundlage. Die Bedingungen für die Implementierung bestehen nicht darin, die Parser-Lücken von KMM mit Reparse zu füllen oder Bedeutungen, die von KRR nicht unterstützt werden, als abgeschlossene Funktionen zu behandeln.
Belege
Diese Übersicht basiert auf den öffentlichen Repositories zum Zeitpunkt der Prüfung. Implementierung und Nutzung können in den verknüpften fixierten Commits geprüft werden.