「マインドマップ to ドキュメント」取扱い説明書

改定 2012/06/1

Ver. 1.05

1 : 概要
2 : 目的と機能
3 : 機能詳細

改定履歴

1 : 概要 [index]

MM_DocumentはFreemindで書かれた文書から他の形式の文書を生成する為のツールです。

初版ではHTMLの文書への変換をサポートします。PDF文書への変換も一部サポートしていますが不完全です。

Rubyのソースレベルでの公開ですのでご自由に活用してください。必要なgemはインストールしてください。

1.1 : 注意事項 [index]

このスクリプトはマインドマップに書かれた内容をほとんどそのまま利用します。

その為、HTML文書を生成するとき、マインドマップ上の文字列にHTMLやCSS、JavaScript等を埋め込むと混乱したり、想定外の動作をしたりします。

特にセキュリティ上の安全処置をとっていませんので、想定外に組込まれたJavaScriptが動く可能性があります。ご自身のマインドマップ以外から生成したHTMLを安全確認する事無く開いたりりしないで下さい。

1.2 : 利用方法 [index]

MM_Document.rbを実行するとファイル選択のボタンの付いたダイアログが出てきますのでマインドマップファイルを指定してください。

結果はマインドマップと同じフォルダーに作られます。

2 : 目的と機能 [index]

(1). MM_DocumentはFreemindの文書から他の形式の文書を自動生成することを目的とします。

(2). Freemind独自でのエクスポート機能とは異なり、アウトラインエディタ的な利用を目指します。ひとつのファイル中で複数の文書を生成することが可能です。

(3). Freemindのツリー構成とアイコン指定を組み合わせて生成文書の指定、更に章立てやパラグラフ構成を記述できるようにします。

(4). folderアイコン以下をひとまとまりの文書として出力します。

(5). 目次や章番号を自動生成し、作成効率を高めます。

(6). 文書の版の履歴を記述できます。

(7). HTML文書生成ではCSSの記述が可能ですから好きな形式で表示可能となります。

3 : 機能詳細 [index]

文書に出力するノードには全て、下記に示された何らかのアイコンを指定してください。アイコンのついていないノードは無視されますので注意して下さい。

下記の「章」「文節」「備考・リンク」のノードには'class'属性を付けることが出来ます。class属性はHTML出力時にタグのclass属性として付加されます。

このツールで使用していないアイコンは単純に無視されますのでマインドマップ上に有っても問題ありません。

3.1 : 文書指定 [index]

フォルダーアイコンで文書のタイトルを指定します。

また、属性値として文書の形式やバージョンを指定します。

3.1.1 : 属性 [index]

属性名 内容
virsion 文書のバージョンを指定する文字列。
DocumentType 生成する文書形式の指定
下記の形式をカンマで繋げて指定する。
指定しない場合はHTMLとする。
html, pdf
filename 出力する文書のファイル名。
拡張子はDocumentTypeで決まる。
指定しない場合にはノードの内容が文書名となる。
Date 文書の改定日
established_day 初版の発行日

3.1.2 : 例 [index]

3.2 : 章 [index]

リストアイコンで章を指定します。

章は階層構造に応じて章番号が付けられます。

  • 例は「文節」の例を参照。

3.3 : 文節 [index]

attachアイコンで文を指定します。

テキストノード、リッチテキストノード、図や画像の添付されたノードを指定することが出来ます。

3.3.1 : 例 [index]

3.3.2 : 文字の置き換え [index]

文の中には自動インクリメントの数値又は文字列を使用できます。

この機能のため下記に該当する文字列は文中で使えなくなります。

正規表現 : /\(([\+\-\.]+)\)/ 又は /\{([\+\-\.]+)\}/

+ - . を幾つか繋げたものを括弧で括った物を指定された数値又は文字列で置き換えます。初期値が指定されていない場合には1と見なされます。空白を含んではいけません。

/\(([\+\-\.]+)\)/ な文字列は置換え後はインクリメントされます。文字列もインクリメントされます。

/\{([\+\-\.]+)\}/ な文字列は最後の値を使用し、インクリメントを行ないません。

異なる文字列は独立した値を持ちます。

3.3.2.1 : 使用例 [index]

(+)=1  ← (+)を1とします。以後(+)は1,2,3,...と成ります。

(++)=a ←(++)をaとします。以後(++)はa,b,c,...と成ります。

(++) ←最後の(++)の値の次の値に置き換えられます。

3.3.3 : 備考・リンク [index]

文節ノードにinfoアイコンを追加して備考やリンクを指定します。このアイコンは単独では機能しません。アイコンの順序は関係ありません。

表示形式が変更され、リンクの機能が付きます。

ノードにリンクが指定されていた場合、HTML出力にもリンクとして出力されます。

  • 例は「改定履歴」の例を参照。

「備考・リンク」では文字の置換えは行なわれません。

3.3.4 : include [index]

文節ノードにwizardアイコンを指定した場合、文字列をファイル名としてその内容を無変換でその場所に読み込みます。

3.4 : 改ページ [index]

downアイコンで改ページを指定します。

HTML出力では改ページの指定は無視されます。

3.5 : 改定履歴 [index]

bellアイコンで改定履歴を指定します。

改定履歴ノードの下に文節ノードを指定する事も出来ます。

3.5.1 : 例 [index]

3.6 : CSS指定 [index]

HTML出力時にスタイルとして使用されるCSSを指定できます。

messagebox_warningアイコンのついた'CSS'ノードの下にCSSデータが記述されるものとします。

CSSの記述形式はCSS3とします。

3.6.1 : 例 [index]


改定履歴 [index]

2012年04月22日 ver. 1.0 公開用HTML版 初版

HTML用として公開開始。

PDFはprawnの旧版に依存しているので拡張を見送る。

2012年04月24日 ver. 1.01 使用上の注意事項(セキュリティ警告)を追加

セキュリティ警告を明記

章へのclass属性の付く場所が間違っているバグを修正

JavaScriptをヘッダに埋め込む機能を実験的に追加

2012年04月24日 ver. 1.02 ritchcontentノードのtext処理を修正

ノードがrichcontentに成っているとき文字列を取れていない場所があったのを修正。改行等を無くした文字列として処理する。

historyサーチパスの変更

2012年04月25日 ver. 1.03 paragraphにinclude機能追加

サニタイジング無しの組込を追加

2012年04月27日 ver. 1.04 アイコンの付け忘れ防止機能追加

文書ツリー内の未文書化ノードをファイルに書き出す。

2012年06月01日 ver. 1.05 Win32OLEモード追加

実行モジュール(EXE)化を実施