1. 製品
  2.   ワードプロセッシング
  3.   Ruby
  4.   Sablon
 
  

Word DOCX ファイルを生成するオープンソース Ruby ライブラリ

ソフトウェア開発者が簡単に Word DOCX ドキュメントを作成できる強力な無料 Ruby API。ドキュメント設計が可能です。's Layout, Apply Styles, and Use Mail Merge Fields as Placeholders for Dynamic Content.

Sablon ライブラリとは？

ソフトウェア開発の世界では、レポート、請求書、手紙などの動的なドキュメントを生成することは一般的な要件です。多くのライブラリはゼロからドキュメントを作成できますが、適切なフォーマットを得るためには学習コストが高く、コーディングが煩雑になることが多いです。そこで登場するのが、強力なオープンソース Ruby ライブラリ Sablon です。Sablon は、Microsoft Word の親しみやすさと Ruby のパワーを活用し、最小限の労力で複雑かつ美しくフォーマットされたドキュメントを作成できるようにします。Word Docx の作成、MailMerge フィールドによるコンテンツ挿入、先進的なフォーマットサポート、テンプレートへの注釈追加、設定可能な HTML & CSS 変換など、多くの機能をサポートしています。

Sablon の核心は、.docx ファイル用のドキュメントテンプレートプロセッサです。Word に組み込まれた Mail Merge 機能を利用し、慣れ親しんだ環境でテンプレートを作成できます。ドキュメントのレイアウト設計、スタイル適用、Mail Merge フィールドを動的コンテンツのプレースホルダーとして使用できます。その後、Sablon はこのテンプレートとデータコンテキスト（Ruby のハッシュ）を組み合わせ、データが埋め込まれた最終的な Word ドキュメントを生成します。このアプローチにより、プレゼンテーション層（Word テンプレート）とデータ層（Ruby コード）が分離され、ドキュメント生成プロセスがクリーンで保守しやすくなります。Ruby とテンプレート言語に慣れた方にとっては直感的な構文です。デザイナーに優しく、コンテンツとデザインが完全に分離されています。デザイナーはコードに触れずに直接 Word で作業できます。

Previous Next

Sablon の始め方

Sablon のインストールには RubyGems の使用が推奨されます。スムーズなインストールのために以下のコマンドをご利用ください。

RubyGems 経由でドキュメントをインストール


gem 'sablon'
You can also download it directly from GitHub.

Word フィールドを使ったコンテンツ挿入（Ruby）

最も基本的な機能は動的コンテンツの挿入です。オープンソース Ruby ライブラリ Sablon は、Word に組み込まれたフィールド構文を使用してプレースホルダーを定義します。Word テンプレートにフィールドコードを挿入し、動的コンテンツを配置したい場所に配置します。Sablon はこのフィールドをあなたの値に置き換えます。以下の例は、ソフトウェア開発者がユーザーに挨拶するためにコンテンツを動的に挿入できる方法を示しています。

Ruby で Word ドキュメントにテキストコンテンツを動的に挿入する方法は？

require 'sablon'

template = Sablon.template(File.expand_path('~/template.docx'))
context = {
  name: "Sarah Connor"
}

template.render_to_file(File.expand_path('~/output.docx'), context)

Template:

Hello, «name»! Welcome to our platform.

Output:
Hello, Sarah Connor! Welcome to our platform.

HTML から WordML への変換

Sablon の際立った特徴の一つは、HTML を WordProcessingML（.docx ファイルで使用される XML フォーマット）に変換できることです。データベースやリッチテキストエディタから、整形された段落、リスト、テーブルなどのリッチテキストコンテンツを挿入する際に非常に便利です。Sablon は HTML 文字列を Word ドキュメント内の適切にフォーマットされたセクションに変換し、見出し、太字・斜体テキスト、リストのフォーマットを保持します。以下は、既存のテンプレートを読み込み、HTML コンテンツを Ruby アプリケーション内の Word Docx ファイルに変換するシンプルな例です。

Ruby ライブラリで HTML コンテンツを Word Docx ファイルに変換する方法は？

require "sablon"

template = Sablon.template(File.expand_path("template.docx"))

html_content = "
これはサブヘッディングです
これは 太字 と 斜体 のテキストがある段落です。
  • 最初の項目
  • 2 番目の項目
"

context = {
  article_content: Sablon.content(:html, html_content)
}

template.render_to_file(File.expand_path("output.docx"), context)

Conditional Rendering

Ruby による動的画像挿入

オープンソース Sablon ライブラリは、Ruby ライブラリを使用して Word Docx ドキュメント内に画像を動的に挿入する便利な機能を提供しています。数行のコードで開発者はドキュメントに画像を動的に挿入できます。画像ファイルを指定すると、Sablon がドキュメントに埋め込みます。以下の例は、Word ドキュメントへの動的画像挿入を実現する方法を示しています。

Ruby ライブラリで画像を Word Docx に動的に挿入する方法は？


// You would have a placeholder image in your template with a special filename like «=company_logo».

context = {
  company_logo: Sablon.content(:image, "path/to/your/logo.png")
}

Ruby による条件付きレンダリング

Sablon ライブラリは条件ブロックをサポートし、変数の有無や値に基づいて Word ドキュメントの一部を表示または非表示にできます。特定の条件に応じてドキュメントをカスタマイズするのに最適です。例えば、以下の例はユーザーが特定情報を表示または非表示にするコマンドを設定できる方法を示しています。show_extra_info が true の場合、if と endIf タグ間のコンテンツが最終ドキュメントに含まれます。false または nil の場合、コンテンツは削除されます。

Ruby を使用して Word Docx ドキュメントの一部を表示または非表示にする方法は？


context = {
  show_extra_info: true # or false
}
 日本