このプロジェクトについて
Open Presentation Format (OPF) は、スライドデッキのためのポータブルで人間が読める JSON ドキュメント形式です。このリポジトリは、フォーマット仕様、JSON Schema、カタログプリセット、例、生成された開発者向け型定義、ローカル検証ツール、および将来的なレンダリング/編集/変換ツールキットの計画ドキュメントの正典となるホームです。npm には @openpresentation/opf として公開されており、現在はプリステーブル版(0.x で、1.0 に至るまでマイナーバージョン間で破壊的変更が予想される)であり、MIT ライセンスの下で提供されています。
動機:.pptx は XML の zip バンドルであるため、人間が差分を確認することが難しく、モデルが信頼性を持って読み書きすることも困難であり、git での意味のある追跡も難しいため、すべての変更がバイナリブロブのように見えてしまいます。OPF はプレーンな JSON であり、エディタで読め、モデルが例からスキーマを推測することなく書き込め、他の作業と共にバージョン管理で追跡可能です。掲げられた目標は、LLM がマークアップタグと格闘するのではなく、デッキの作成(ナラティブ構造、フレーミング、データ分析、チャートの提案、修正)に参加できるようにすることです。
慣習と命名:OPF ドキュメントは、完全なプレゼンテーションの場合、*.opf.json(例:board-review.opf.json)という名前の JSON ファイルになります。*.opf という単純な拡張子は、他のドキュメントやプロジェクト形式ですでに使用されているため、プロジェクトでは推奨していません。Open Presentation Format という名称、およびスキーマ、カタログ、パッケージ、ローカルツールは、製品固有のブランディングを採用することなく、サードパーティツールが読み取り、書き込み、検証、レンダリング、変換、およびサポートの記述に使用できます。
JavaScript/TypeScript パッケージの機能:spec/ から正典スキーマとバンドルされたカタログレコードをエクスポートし、パッケージでアドレス指定可能な仕様コンテンツのための型付き raw 仕様ファイルマニフェスト、Presentation をトップレベル型とする生成済み TypeScript 型、および OPF JSON とカタログレコードのローカル検証を提供します。検証では、有効性に加えて、未知のカタログ ID などのアドバイザリ警告が返されます。スキーマ、カタログ、仕様ファイル、バリデータ、型に対するフォーカスされたサブパスインポートが利用可能であり、raw JSON スキーマはエンジンやリゾルバーによって直接インポートできます。また、このパッケージは純粋なコンポジションジオメトリを公開しているため、ダウンストリームライブラリでレイアウト動作を共有できます。明示的に、.pptx のレンダリングやパース、AI によるコンテンツ生成、リモートカタログの取得、ホストされた API の呼び出し、またはマネージドサービスの提供は行いません。
ローカルツール:インストール可能な MIT ライセンスの CLI を使用して、OPF ファイルをローカルで作成、検証、編集、検査できます(例:タイトル付きデッキの作成、ファイルの検証、パッチの適用)。CLI 0.5.0 コマンドは、ローカルコピーを使用して AI エージェント向けに 6 つの OPF スキルをプロジェクトにインストールし、既存の指示を保持し、カスタマイズされたスキルの上書きを拒否します。ドキュメントには、エージェントスキル、LLM による作成、ダイナミックコンポジション、およびローカルエコシステムの検証について記載されています。
リポジトリレイアウトのハイライト:トップレベルの Presentation ドキュメント用の正典 JSON Schema、ドキュメントモデル、コンテンツシェイプ、カタログ解決、および検証哲学への概念的な導入、設計優先順位アルゴリズム(スライド設計、デッキ設計、解決済みテーマ、エンジンデフォルト)、トップレベルフィールド、スキーマ定義、コンパニオンカタログスキーマ、およびチャートやテーブルを含むスライド/リージョンコンテンツペイロードに関する著者向けリファレンス、技術的フィクスチャおよびシナリオ指向のギャラリー例へのガイド、ブラウザキャンバス、フォント読み込み、および現在の忠実度の限界に関するライブエディタノート、およびメンテナー向けリリースランブックが含まれています。OPF を HTTP 経由で公開することを選択したダウンストリームサービス向けに、オプションのリファレンス OpenAPI コントラクトが存在しますが、OpenPresentation はその API をホストしていません。
エコシステムの境界:レンダリング、編集、変換機能は、別の MIT 兄弟リポジトリである opf-render (OPF から SVG/PNG/PDF へ)、opf-editor (ヘッドレスエディタプリミティブとオプションの UI コンポーネント)、および opf-pptx (純粋なローカル PPTX インポート/エクスポート) に配置されています。これらはオープンソースのプリミティブのみを提供し、ホスティング、認証、ストレージ、コラボレーション、キュー、プレビュー、分析、サポート、およびワークフロー UX はダウンストリームアプリケーションが所有します。将来的な Python および Go パッケージも同様のローカルファーストの境界に従い、ネットワーク呼び出しや隠れたテレメトリを必要とせずに、スキーマ、モデル、カタログ、検証、およびパッケージアドレス指定可能なアセットを公開することが期待されています。レイアウト、テーマ、カラーおよびフォントスキーム、チャートタイプ、ナラティブ、オーディエンス、目的、トーン、言語、およびソーシャルプラットフォームなどの人間が閲覧可能なカタログプリセットは、pptx.gallery を通じて参照されます。
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.