Word DOCX の作成と処理のための無料の Ruby API 

プロフェッショナルな Office Word ドキュメントの作成、DOCX ファイルの変更、ページ マージンの追加、HTML に似た構文を使用したネストされたテーブルの挿入を行う機能をプログラマーに提供するオープン ソースの Ruby ライブラリ。

Caracal ライブラリを使用すると、Ruby 開発者は、HTML に似た構文を使用して、独自のアプリケーション内でプロフェッショナルな Office Word ドキュメントを生成できます。ライブラリは、いくつかの簡単なコマンドを使用して Office Open XML (OOXML) を作成および管理できるようにすることで、開発者の仕事を容易にします。ライブラリはオープン ソースであり、MIT ライセンスの下で利用できます。

このライブラリは非常によく設計されており、ドキュメントの解析命令と処理命令を分離しています。この戦略により、レンダリング プロセスに大きな柔軟性がもたらされます。ライブラリには、Word 文書の作成、ページ サイズの設定、ページ マージンのサポート、改ページ、ページ番号、フォントのサポート、スタイルとフォーマットのサポート、段落の追加、リンクとブックマークの使用、挿入など、Word 文書の処理に関連するいくつかの重要な機能が組み込まれています。テーブル、ネストされたテーブルのサポート、画像のサポートなど。

Previous Next

カラカル入門

ライブラリをスムーズにご利用いただくために、以下のコマンドアプリのGemfileを追加してください。

アプリケーションの Gemfile にコードを追加して Caracal をインストールする

 gem 'caracal'

アプリケーションの Gemfile にコードを追加して Caracal をインストールする

bundle install

Ruby を使用した Word Docx ファイルの作成

オープン ソースの Caracal ライブラリにより、Ruby 開発者は Ruby コードを使用してアプリ内で DOCX ファイルを生成できます。 DOCX ファイル形式は、XML ドキュメントの圧縮されたコレクションであり、OOXML 標準を使用して作成されます。ライブラリは、ドキュメントの構造全体を作成し、それを出力ドキュメントに圧縮することで、プログラマーを支援します。このライブラリは、既存のファイルの変更、ページ サイズの調整、余白の設定、スタイルの適用などをサポートしています。

Ruby Caracas LibraryでWord文書を作成

Caracal::Document.save 'example.docx' do |docx|
  # page 1
  docx.h1 'Page 1 Header'
  docx.hr
  docx.p
  docx.h2 'Section 1'
  docx.p  'Lorem ipsum dolor....'
  docx.p
  docx.table @my_data, border_size: 4 do
    cell_style rows[0], background: 'cccccc', bold: true
  end
  # page 2
  docx.page
  docx.h1 'Page 2 Header'
  docx.hr
  docx.p
  docx.h2 'Section 2'
  docx.p  'Lorem ipsum dolor....'
  docx.ul do
    li 'Item 1'
    li 'Item 2'
  end
  docx.p
  docx.img 'https://www.example.com/logo.png', width: 500, height: 300
end

Word ファイルにテーブルとネストされたテーブルを追加する

無料の Caracal ライブラリを使用すると、ソフトウェア開発者は、わずか数行の Ruby コードで Word ドキュメントにテーブルを追加および変更できます。ライブラリには、タイトルの追加、新しい列と行の追加、上下または左右のスタイリング、特定のセルへのスタイルの適用、セルの結合または分割など、テーブル管理に関連するいくつかの重要な機能が含まれています。ライブラリには、ネストされたテーブルのサポートも含まれていました。

Word 文書内でリストを使用する

オープン ソースの Caracal ライブラリには、Ruby コマンドを使用して DOCX ファイル内でリストを使用するためのサポートが含まれています。ライブラリを使用すると、Word 文書内に順序付きリストと順序なしリストを追加できます。また、深いネストされたリストと他の組み合わせでの混合もサポートしています。リストのスタイルを簡単に定義できます。このライブラリは、順序付きリストと順序なしリストの両方について、9 レベルのデフォルト スタイルをサポートしています。

RubyライブラリでWord文書内のリストを使用する方法

docx.ol do
  li 'First item'
  li do
    text 'Second item with a '
    link 'link', 'http://www.google.com'
    text '.'
    br
    text 'This sentence follows a line break.'
  end
end

段落とブックマークを DOCX ファイルに挿入する

Caracal ライブラリは、Word ドキュメントに段落を簡単に追加する機能を提供しています。ライブラリには、テキストの配置、フォントの選択、フォントの色とフォント サイズの設定の背景色の定義、垂直方向の配置の適用など、段落処理に関連するいくつかの機能が含まれています。また、ブックマークをドキュメントに直接挿入したり、段落ブロック内に簡単に挿入したりすることもできます。

RubyライブラリでWord文書にブックマークを追加する

# document-level bookmark
dox.bookmark_start id: 's1', name: 'section1'
docx.h2 'Section Heading'
docx.bookmark_end id: 's1'
docx.p  'Section content.'
# pargraph-level bookmark
docx.h2 'Section Heading'
docx.p do
  text 'Pretend this paragraph has a lot of text and we want to bookmark '
  bookmark_start id: 'p1', name: 'phrase1'
  text 'a single phrase'
  bookmark_end id: 'p1'
  text ' inside the larger block.'
end
 日本