Translate

2018/07/01

モデルのドキュメント出力

Papyrus で作成したモデルプロジェクト全体をドキュメント出力したい場合には
が最も有効な手段となります.
Gendocは ドキュメントテンプレートを用いて EMF モデルからドキュメントを生成する `From models to documents' のためのプラグインであり,
  • OpenOffice Writer (.odt)
  • Microsoft Word (.docx)
  • Microsoft Excel (.xlsx)
  • Microsoft Powerpoint (.pptx)
のファイルを出力することが可能です.
プロジェクトのサイトは
https://www.eclipse.org/gendoc/index.php
になります.

このプロジェクトは進捗やリリーススケジュールが分かりづらく,一時期は全く機能していないのでは?と思えたりもしましたが,最近は主要な開発者の方から色々とコミット頂けた様で少し動きが出ています.
最新のバージョンは 0.7.1 です.ただリリース時期と対応する Papyrus のバージョンが微妙で,プロジェクトのホームページ上に記載された情報によると,その元となる 0.7.0 がリリースされたのが
26th Mars 2018 : Gendoc 0.7.0 is now 
とのことで,この 2018-3-26 という日付が示している Papyrus のバージョンが何かというのはよくわからないです.
ただこの先のロードマップの宣言は明確に示されており,
Future releases
Gendoc v0.8.0 (2018)
  • Photon Release.
  • Error reporting improvements.
  • Improved XLSX file format support.
  • Improved PPTX file format support.
  • Improved Rich Text support.
Gendoc v1.0 (2018)
  • API freeze
とのことです.
今年中には Photon 対応を行い,またバージョン1.0 品が正式に出る予定みたいです.

今年色々とアップデートがあるみたいなので,Nightly Build を使っておくのも良いかもしれません.Nightly Build のリポジトリは以下で確認できます.
https://www.eclipse.org/gendoc/downloads/download.php
ここに示されているLocationを Papyrus の Install New Software ... のダイアログ上に Add する形でインストールと適宜のupdateが可能です:

使い方は下記の pdf を参照してください:
Gendoc v0.7 tutorial


ダイアグラムのファイル出力

Papyrus で作成したUML/SysML等のモデル図からドキュメントを生成したいことが多々あります.

ダイアグラムそのものを画像として抽出するには,個々のダイアグラム上でマウス右クリックを行い,
File → Save As Image File ...
の操作をすることで図を画像保存することが可能です.

その際に選択可能な画像形式には,
GIF,BMP,JPG,SVG,PNG,PDF
があります.表示されるダイアグラム上の Image Format リストから選択することが可能です.


どれが良いかは難しいですが,自分としては「PNG」を使うことが多いです.次点としては「PDF」と「SVG」になるのですが,
  • PDFはクラスにグラデーションのかかった色を付けている場合に,そのグラデーションが正しく出力されない場合がある
  • SVGは少し前までのMS-Wordでは画像として直接取り込めない(Word側の問題)
という問題があるため無難な「PNG」を使うことが多いです.
png で保存
pdf で保存(pdfで保存したファイルをacrobat reader で表示しスナップショットを取得)

svg で保存(svgで保存したファイルを google chrome で表示し画面ダンプをpngで保存)

ただ,上記問題が影響がない場合にはPDFとSVGを使用しますし,特にベクタグラフィックスとして図をハンドリングしたい時はそちらを使います.

その他のダイアグラム出力のやり方としては,Project Explorer 上のモデルファイルを選択し,マウス右クリックで
Export All Diagrams ...
を選択するやり方もあります.
Export All Diagrams メニュー
Export All Diagrams ダイアログ

これによりモデル中に含まれるすべてのダイアグラムがファイル出力されます.
選択可能な画像フォーマットは上記のものです.

ただ少なくとも Papyrus 3.x の時には,ダイアグラム名を日本語にしていた場合にファイル名が文字化けしていました.Papyrus 4.0 ではどうなっているかについては確認していません.