構造化アプリケーションの使用を開始

構造化アプリケーションの使用を開始する方法、および構造化アプリケーションでの書式の重要性について説明します。

非構造化 FrameMaker でオーサリング環境を設定するために必要なのはテンプレートファイルだけです。 テンプレートファイルは書式およびスタイルを定義します。スタイルガイドはテンプレートの正しい使い方について定義します。 構造化 FrameMaker に必要なのは、構造化テンプレートだけではありません。

FrameMaker で基本的な構造化オーサリング環境を確立するには、EDD や DTD が必要です。 この場合、カスタム EDD や DTD を作成することもできるし、既成の EDD や DTD を利用することもできます。 さらに、エレメント定義を書式情報にリンクする必要があります。 EDD 中のエレメントを書式にリンクするには、以下の 3 つの方法があります。

書式テンプレート

テンプレート内の様々なタグ（段落スタイル、文字スタイルなど）に基づいて書式を割り当てることができます。 既に書式テンプレートがある場合には、そのテンプレートの中の情報を再利用することができます。

書式変更リスト

EDD では、名前付きの書式定義を作成することができます。 書式変更リストを利用すると、書式仕様の一部を提供して、それ以外を段落スタイルから継承することができます。 書式変更リストは、関連するエレメントで再利用することができます。

埋め込みの書式設定

各エレメント定義に書式を書き込むことによって、書式を指定することができます。

EDD と書式を作成したら、この 2 つのコンポーネントを組み合わせて、単一の構造化テンプレートを作成します。 構造化テンプレートを作成するには、書式テンプレートを開いて、EDD からエレメント定義を取り込みます（ファイル > ／取り込み > ／エレメント定義）。生成されるファイルが、構造化テンプレートです。

EDD および構造化テンプレート以外にも、以下の要素が必要です。

読み書きルール

読み書きルールは、FrameMaker 構造と XML との間の相互変換を制御します。 具体的には、読み書きルールは表の変換やその他の複雑な書式の管理を助けます。

構造化アプリケーション

構造化アプリケーションは、構造実装内のコンポーネントファイルを一覧表示して、構成情報を提供します。 例えば、構造化アプリケーションを使うと、コンディショナルテキストタグを書き出すかどうか、および書き出す方法を指定できます。

構造化テンプレート

FrameMaker のすべての構造化アプリケーションには、構造化テンプレートが必要です。 構造化 FrameMaker の各テンプレートには、文書内で使用できるすべてのエレメントの定義のほかに、文書のページレイアウトや書式設定で使用できるエレメントもすべて含まれています。

構造化テンプレートは非構造化テンプレートに似ていますが、最もはっきりした違いはエレメントカタログです。

エレメントカタログには、EDD で定義されたエレメント定義が表示されます。 構造化文書を作成するには、まず、EDD または DTD から定義を取り込みます。 EDD や DTD のエレメント定義は、 エレメントカタログ. エレメントカタログは、有効なエレメントを文書に挿入して、EDD のルールに従う構造を構築するために使われます。

内容分析

内容分析という言葉は、既存の文書をレビューして、それがどのように設計されているか、どのような暗黙的な構造を含んでいるかを理解する過程を表します。 組織が作成した文書のリストを作成することから分析を始めます。 このリストには、ユーザーガイド、リファレンスガイド、白書、チュートリアル、トレーニングマニュアル、オンラインヘルプなどが含まれるでしょう。 各文書型の主な構成要素のリストを作成します。 コンポーネントごとに、その項目は必須かオプションか、および、文書の中に出現する回数をリストアップします。 以下の表は、高いレベルでのブックの分析を示しています。

コンポーネント

必要条件

出現

前付

必須

1

目次

必須

1

序文

オプション

0 または 1

章

必須

2 以上

付録

オプション

0 以上

用語集

オプション

0 または 1

索引

必須

1

レッスン（トレーニングマニュアルの場合）や章（ブックの場合）のような主な構成要素ごとに、階層構造の一番下に到達するまで、文書階層をより小さな単位へと下っていきます。

内容分析は、構造化環境で作成したい各文書型について行う必要があります。 各文書の内容モデルの作成が済んだら、モデルを修正して、名前を再利用する機会を求めてもよいかもしれません。 例えば、ヘルプの配布内容がトピックから構成されており、ブックの章もトピックから構成されているとします。 Topic エレメントを印刷資料とオンライン資料の両方で利用できるように作成すれば、構造定義の中のエレメントの数を最小化することができ、両方の出力形式で情報を再利用できる可能性があります。

印刷版トピック

オンライン版トピック

両方のトピック

トピック

トピック

トピック

タイトル

タイトル

タイトル

Para

Para

Para

手順

手順

手順

Para、List、Table、Graphic、Note が使用可能

Para、List、Table が使用可能

Para、List、Table、Graphic、Note が使用可能

RelatedTopics

RelatedTopics

文書が、完全に首尾一貫していることは滅多にありません。 ゆるやかな構造（変化を許容する）を作成するか、厳しい構造（ほとんど変化を許容しない）を作成するかを決める必要があります。 このスペクトルのどちらの極にも問題があります。

これらの両極端の間のバランスを見出すのは極めて困難です。 1 つの方法は、値を追加するところにだけ変化を認めることです。

注: 同じような問題は、非構造化 FrameMaker テンプレートを作成する際にも起こります。 ユーザーは、内容を作成するために必要なタグのすべてを用意しつつ、維持する必要のあるタグの数を最小化することを求められます。

分析が済んだら、既存の構造を使用するか、ユーザー独自の構造を構築するかを決めることができます。 利用できる XML 実装には様々なものがあります。DocBook および DITA（Darwin Information Typing Architecture）は、技術文書に使われる仕様です。 また、標準の構造は、軍事文書（MIL 仕様、MIL 規格）、航空機メンテナンスマニュアルなどでも定義されています。 以下の表は、標準仕様を使うか独自の構造を構築するかの判断に影響を与える要因の一部を示しています。

標準を使用する

独自に構築する

配布する際には、この標準にのっとった内容を配布する必要があります。 例えば、アメリカの軍事関係の下請け業者の多くは、発表された標準に従って文書を配布する必要があります。

したがって、作成する構造が内容分析と正確に一致することが求められます。

内容の要件は、既存の構造にかなり一致します。 必要なのは、標準構造に最小限の変更を施すことだけです。

内容分析は、情報が既存の構造にあまり一致していないことを示しています。

構造の構築にあまり時間を使いたくなくて、なおかつ、内容の構成を既存の構造に合わせて変更してもよい。

構造は、内容と正確に一致する必要があります。

必要とするものと厳密に一致するものを構築するためには、実装期間が長くなることによるコストを受け入れてもよい

独自の構造を構築するために利用できる技術的な専門知識やリソースがない。

構造を構築することのできる人材が、内部またはコンサルタントとして利用できる。

追加

構造化文書の基本的な構成単位は、エレメントです。 エレメントは文書の内容の一部（テキスト、グラフィックスなど）を表し、このエレメントが集まって文書の構造を構成します。 エレメントには、単純エレメントと複合エレメントがあります。

XML の単純エレメントには、テキストだけが含まれています。 複合エレメントは属性を持つことができ、さらに、以下のいずれかが可能です。

エレメントは、有効な値として指定された範囲の値を持つことができます。

FrameMaker のすべての構造化文書では、必ずエレメントを使用します。 それぞれのエレメントには<section>、<title>、<p>などの名前が付いています。使用できるエレメントは、文書のエレメント定義によって決定されます。

属性

属性は、エレメントに関する追加情報を提供します。 例えば、マニュアルの DTD デザイナーでは、book エレメントの version という属性を使用することにより、ユーザーがブックの改版バージョンを指定することを可能にしています。 FrameMaker では、エレメントの属性はエレメントの定義の一部となります。 XML または SGML では、エレメントの属性は DTD の属性定義リストの宣言（ATTLIST）で別個に発生します。

属性は、デフォルト値や固定値を持つことができます。 また、属性は、必須にすることもオプションにすることもできます。 例えば、topic エレメントがある場合、トピックを相互参照するためには topic ID が必須属性になることがあります。 また、属性に対しては、値の範囲を設定したり、適正な値を列挙したりすることができます。

エレメントルール

以下の7つのルールは、エレメントの並び順、出現回数、グループ化などがどのように使われるかを制御します。

すべて

子エレメントは任意の順序で出現できますが、最低でも 1 回は出現する必要があることを示します。

選択

どちらか一方の子エレメントが出現できることを示します。

Sequence

子エレメントが出現する順序を示します。

minOccurs

子エレメントが出現できる最低回数を示します。

maxOccurs

子エレメントが出現できる最高回数を示します。

エレメントグループ

エレメントは、グループ宣言の下でグループ化することができます。

属性グループ

属性は、attributeGroup 宣言の下でグループ化することができます。

XML スキーマ

XML スキーマは、XML 文書の適正な構成単位を定義します。 DTD やスキーマファイルは、EDD とは違って、書式情報を提供しません。

XML スキーマは、以下を定義します。

XML 名前空間

XML 名前空間を利用すると、名前の衝突を起こすことなく、異なるボキャブラリから取得した XML エレメントや属性を同一の文書に含むことができます。

スキーマを開くまたは取り込む

スキーマファイルを参照する XML 文書を取り込み、XML への書き出しのときに文書の検証に使用するために、構造化アプリケーションでスキーマファイルを指定できます。

スキーマファイルを指定して XML の書き出しに使用するには、structapps.fm ファイルを修正します。 schema エレメント（<XMLApplication> エレメントの子）で、書き出し用のスキーマファイルパスを指定します。

Parent topic: 構造化オーサリング