Mr.DITA Japan Blog ブログテーマ:DITA FrameMaker

DIT-FMxにおけるcoderef要素

[DITA FrameMaker] 投稿日時:2015/02/26(木) 23:42

DITA 1.2から実装されたcoderef要素は、DITAトピックにプログラムのコードなどを外部に置いたまま参照する場合に便利な要素です。ユースケースとしては、例えばAPIリファレンスにおいてSVNなどのソース管理システムで管理されているコードを実際の例として参照したい場合などです。codeblockの内容をcoderefとして参照していれば、コードは常に最新版で正確であるので安心です。長いコードやPDFにフォーマットする場合などは親のcodeblockexpanse属性値の値をルール化したりする工夫が必要ですが、便利な要素です。

ただし、coderef要素をビジュアルな編集モードで読み取り不可のコンテンツブロックとしてコンテンツ参照のように表示されことができるのは、今のところ、DITA-FMxだけのようです。VARでもあるoXygenをはじめ、Arbortext、XMetaLのどれもが機能をもっていませんでした。oXygenは機能要求しておきましたので、近いうちにDITA-FMxと同等の機能が実装されるでしょう。ドラッグ&ドロップでcoderefを挿入できればユーザビリティーが増しますので、これも一緒にリクエストしておきました。


 

FrameMakerにおけるDITA索引エントリーの入力

[DITA FrameMaker] 投稿日時:2015/02/22(日) 00:16

DTPアプとしてのFrameMakerの操作に慣れたユーザーにとっては真新しいことではありませんが、FrameMakerにおける索引エントリー(indexterm)の入力は、マーカー内のマーカーテキストとして入力します。日本語のソートに必須の「よみがな」もふることができます。レベル化することも非構造化の文書作成環境ではでき、通常の業務においては支障をきたすことはありません。しかしながら、構造化FrameMakerのDITA環境では、階層を加えるレベル付けされた索引エントリーを作成することはできません。これでは情報をトピックのキーワード索引エントリー経由で探し易くするというDITA情報アーキテクチャの考えを満たすことはできません。また、この機能制限によって他のDITAオーサリングツールとの互換性が保たれなくなってしまいます。では、FrameMakerユーザーはどう対処したらよいのでしょうか?DITAオーサリングのために新しいDITAオーサリングツールを購入し、操作方法を新たに学ばなければいけないのでしょうか?非構造化とXMLによる構造化文書の両方の作成ができるコストパフォーマンスの高い、使いやすく便利なツールから離れなければならないのでしょうか?答えはNOです。

DITA FMx FrameMakerプラグイン

FrameMakerではDITAの文書作成はできないのか、と落胆する必要はありません。FrameMakerに他のDITAオーサリングツールと同等の機能を追加してくれるアドオンツールが存在します。Leximation社のDITA-FMxです。

DITA FMxがインストールされた環境では、DITAのindexterm要素(エレメント)は、FrameMaker編集環境では、fm-indextermというDITA-FMx拡張のための要素(エレメント)に置き換えられ、マーカーとして扱われます。DITA保存時には、自動的にindexterm要素に戻され双方向にそれぞれ互換性が維持されます。DITAマップからのFMのブック作成時には、索引エントリーとして取り込まれレベル化された索引エントリーを持つ索引ページが自動生成されます。下の2つの緑で囲まれた部分がそれぞれ2階層にレベル化されたindextermのオーサリング例です。

標準的なDITAエディターoXygenにおけるオーサーモード編集画面

FrameMaker+DITA-FMxにおけるWYSIWYGビュー編集画面

DITA-FMxプラグインをインストールすることによってレベル化された索引エントリーをはじめとするDITAオーサリングにおける拡張機能やプロフェッショナルな美しいFrameMakerのブックパブリッシングをDITAコンテンツ開発環境にもたらします。

以降のDITA FrameMakerシリーズのブログポストでは、DITA文書化プロセスにおけるFrameMakerおよびFrameMaker XML AuthorとDITA-FMxとの併用による、これまであまり語られることの無かったDITA文書化プロセスの実践をひも解いて行きたいと思います。

<< 2019年12月  >>

Sun Mon Tue Wed Thu Fri Sat
1 2 3 4 5 6 7
8 9 10 11 12 13 14
15 16 17 18 19 20 21
22 23 24 25 26 27 28
29 30 31