文書にブロック図を埋め込む

いくつかの文書管理システムではプラグインや拡張機能として`blockdiag` で生成したブロック図を文章に埋め込むことができます。

Sphinx に埋め込む

Sphinx は reST 形式(テキスト)で記述するドキュメント生成ツールです。

Sphinx で作成する文書にブロック図を埋め込むにはSphinx 拡張である sphinxcontrib-blockdiag パッケージを利用します。

sphinxcontrib-blockdiag については sphinxcontrib-blockdiag で説明します。

Read the Docs に埋め込む

Read the Docs は Sphinx ドキュメントのホスティングサービスです。

Read the Docs で公開する文書にブロック図を埋め込むにはSphinx 拡張である sphinxcontrib-blockdiag パッケージを利用します。

  1. sphinxcontrib.blockdiagconf.py に追加します。
  2. sphinxcontrib-blockdiagrequirements.txt に追加します。
  3. Read the Docs 上でプロジェクトの設定を行います。
    • Use virtualenv にチェックを入れてください。
    • Requirements file に requirements.txt へのパスを入れてください。

日本語(マルチバイト文字)を用いたドキュメントを公開する場合、TrueType フォントを _static ディレクトリに追加し、conf.py 内に blockdiag_fontpath の設定を追加してください。

# Set up font for blockdiag
blockdiag_fontpath = '_static/ipagp.ttf'

Embed in Re:VIEW

Re:VIEW is a document generation tool which use its original format.

Re:VIEW supports blockdiag, users can embed a blockdiag in a document with no additional software.

ipython-notebook に埋め込む

IPython-notebook は Web ベースのインタラクティブドキュメントです。

ipython-notebook にブロック図を取り込むには ipython-diags を利用します。

Redmine に埋め込む

Redmine は Web ベースのプロジェクト管理ソフトウェアです。

Redmine の Wiki にブロック図を埋め込むにはWiki External Filter Plugin を利用します。

詳細は Wiki External Filter Plugin を導入してみた をご覧ください。

Trac に埋め込む

Trac は Web ベースのプロジェクト管理ソフトウェアです。

Trac の Wiki にブロック図を埋め込むには TracBlockDiagPlugin を利用します。

moinmoin に埋め込む

moinmoin は Python で書かれた Wiki clone サーバです。

moinmoin にブロック図を取り込むには moinmoin blockdiag plugin を利用します。

mediawiki に埋め込む

mediawiki は Wiki clone サーバです。

mediawiki にブロック図を取り込むには Blockdiag MediaWiki Extension を利用します。

PukiWiki に埋め込む

PukiWiki は PHP で書かれた Wiki clone サーバです。

PukiWiki にブロック図を取り込むには blockdiag PukiWiki Extension を利用します。

Rabbit に埋め込む

Rabbit は Ruby で書かれたプレゼンテーションツールです。

Rabbit は blockdiag の埋込みをサポートしており、追加のソフトウェなしにプレゼンテーションに図を組み込むことができます。

Joomla に埋め込む

Joomla は PHP で書かれた CMS です。

Joomla にブロック図を取り込むには Plugin blockdiag を利用します。

asciidoc に埋め込む

asciidoc はテキスト文書から各種フォーマットに変換するドキュメント生成ツールです。

To embed a blockdiagram in the asciidoc, use asciidoctor-diagram.

API 経由で取得する

interactive shell for blockdiag provides a Web API. When you send some text data, you can get a blockdiagram which is SVG format.

Web API は http://interactive.blockdiag.com/image に対して、以下のパラメータを含んだ GET リクエストを送ることで呼び出すことができます。

パラメータ名 内容
src テキスト形式のブロック図を指定します。encoding=base64 を指定した場合は base64 エンコードする必要があります。
encoding base64, jsonp のいずれかを指定することができます。base64 を指定した場合、src に指定するテキストを base64 形式で送信します。jsonp を指定した場合、jsonp 形式で結果を受け取ることができます。
callback コールバック関数の名前を指定します。encoding=jsonp の場合のみ有効です。

サーバは、受信したテキストデータが正常な図であれば、SVG 形式のブロック図を送信します。もし受信したテキストに文法間違いやエラーがあった場合は、空のレスポンスを返します。

注釈

この API は実験的に提供しているものであるため、パラメータの変更やサービスの停止が行われる可能性があります。