出力生成設定の指定

最終更新日： 2025年2月24日
  • トピック：

作成対象：

  • 経験者
  • 管理者

AEM Guidesには、出力生成プロセスをカスタマイズするための多くの設定オプションが用意されています。 このトピックでは、出力生成プロセスの設定に役立つすべての設定とカスタマイズについて説明します。

DITA マップダッシュボードの「ベースライン」タブの設定

DITA マップダッシュボードで「ベースライン」 タブを非表示にするには、次の手順を実行します。

  1. 設定の上書きの手順に従って、設定ファイルを作成します。
  2. 設定ファイルで、マップダッシュボードの「ベースライン」タブを設定するために、次の\（property\）詳細を指定します。
PIDプロパティキープロパティの値
com.adobe.fmdita.config.ConfigManagerhide.tabs.baselineブール\（true/false\）デフォルト値: true
NOTE
この設定はデフォルトで有効になっており、マップダッシュボードでは「ベースライン」タブは使用できません。

既存のAEM サイト内で混合型公開を設定する

DITA コンテンツを含むAEM Site がある場合は、AEM Site 出力を設定して、DITA コンテンツをサイト内の事前定義済みの場所に公開できます。 例えば、次のAEM サイトページのスクリーンショットでは、ditacontent ノードは DITA コンテンツを格納するために予約されています。

ページの残りのノードは、AEM サイトエディターから直接作成されます。 DITA コンテンツを事前定義済みの場所に公開するように公開設定を指定すると、既存の非 DITA コンテンツがAEM Guides公開プロセスで変更されることはありません。

定義済みノードに DITA コンテンツを発行できるようにするには、既存のサイトで次の設定を実行する必要があります。

  • サイトのテンプレートプロパティの設定

  • サイトにノードを追加して DITA コンテンツを公開

既存のサイトのテンプレートプロパティを設定するには、次の手順を実行します。

  1. パッケージマネージャーを使用して/libs/fmdita/config/templates/default ファイルをダウンロードします。

    NOTE
    libs ノードでデフォルトの設定ファイルをカスタマイズする必要はありません。 apps ノードに libs ノードのオーバーレイを作成し、apps ノードでのみ必要なファイルを更新する必要があります。

  2. 以下のプロパティを追加します。

    プロパティ名タイプ値
    topicContentNode文字列DITA コンテンツを公開するノード名を指定します。 例えば、AEM Guidesが DITA コンテンツを公開するデフォルトのノードは
    です。 jcr:content/contentnode
    topicHeadNode文字列DITA コンテンツのメタデータ情報を保存するノード名を指定します。 例えば、AEM Guidesがメタデータ情報を格納するデフォルトのノードは
    です。 jcr:content/headnode

次にサイトのテンプレート設定を使用して DITA コンテンツを公開すると、そのコンテンツは topicContentNode および topicHeadNode プロパティで指定したノードに公開されます。

AEM サイト出力のカスタマイズ

AEM Guidesでは、次の形式での出力の作成がサポートされています。

  • AEM サイト
  • PDF
  • HTML5
  • EPUB
  • DITA-OT によるカスタム出力

AEM サイトの出力については、異なる出力タスクに異なるデザインテンプレートを割り当てることができます。 これらのデザインテンプレートは、異なるレイアウトで DITA コンテンツをレンダリングできます。 例えば、内部オーディエンスと外部オーディエンスに対して異なるデザインテンプレートを指定できます。

カスタマイズした DITA Open Toolkit \（DITA-OT\） プラグインをAEM Guidesで使用することもできます。 これらのカスタム DITA-OT プラグインをアップロードすると、特定の方法でPDF出力を生成できます。

TIP
AEM サイト出力の作成に関するベストプラクティスについては、ベストプラクティスガイドの AEM サイトの公開 の節を参照してください。

出力を生成するためのデザインテンプレートのカスタマイズ

AEM Guidesでは、事前定義済みの一連のデザインテンプレートを使用して、AEM Site 出力を生成します。 AEM Guidesのデザインテンプレートをカスタマイズして、企業のブランディングに合った出力を生成できます。 デザインテンプレートは、様々なスタイル \（CSS\）、スクリプト \（サーバー側とクライアント側の両方\）、リソース \（画像、ロゴ、その他のアセット\）、およびこれらすべてのリソースを結び付ける JCR ノードのコレクションです。 デザインテンプレートは、単一のサーバーサイドスクリプトと複数の JCR ノードのみで構成するか、スタイル、リソース、JCR ノードの複雑な組み合わせで構成することができます。 デザインテンプレートは、AEM Guides サイト出力を生成する際にAEM パブリッシングサブシステムで使用され、生成された出力の構造、ルックアンドフィールを制御します。

デザイン テンプレート リソースをサーバ上のどこに配置するかについては制限はありませんが、通常は機能に応じて論理的に編成されます。 例えば、デフォルトのテンプレートでは、すべてのJavaScriptと CSS ファイルがフォルダーに保存 /etc/designs/fmdita/clientlibs/siteoutput/default れています。 これらのファイルが配置されている場所では、それらのファイルは JCR ノードのコレクションによってリンクされます。 これらの JCR ノードとファイルによって、デザインテンプレート全体が構成されます。

AEM Guidesに付属しているデフォルトのデザインテンプレートを使用すると、ランディング、トピックおよび検索ページのコンポーネントをカスタマイズできます。 デフォルトのデザインと対応する参照テンプレートのコピーを作成し、異なるコンポーネントを指定して目的の出力を生成できます。

次の手順を実行して、AEM Site の出力生成に使用する独自のデザインテンプレートを指定します。

  1. パッケージマネージャーを使用して、次の場所からデフォルトのデザインテンプレートをダウンロードします。

    /libs/fmdita/config/templates

  2. ダウンロードしたファイルのコピーをCloud Manager Git リポジトリ内の次の場所に作成します。

    /apps/fmdita/config/templates

  3. また、デフォルトのテンプレートノードから参照されたテンプレートをダウンロードしてコピーする必要もあります。 参照されるテンプレートは、次の場所に配置されます。

    /libs/fmdita/templates/default/cqtemplates

    次の表に、AEM Guides デザインテンプレートのプロパティを示します。

    プロパティ説明
    landingPageTemplate、searchPageTemplate、topicPageTemplate、shadowPageTemplateこれらの対応するページの cq:Template ノード （ランディング、検索、トピック\）を指定してください。 デフォルトでは、これらのページの cq:Template ノードは /libs/fmdita/templates/default/cqtemplates ノードにあります。 このノードは、ランディングページ、検索ページ、トピックページの構造とプロパティを定義します。
    shadowPageTemplate は、チャンクされたコンテンツの最適化に使用されます。 このプロパティの値を次に設定する必要があります。fmdita/templates/default/cqtemplates/shadowpage
    メモ：topicPageTemplate の値を指定する必要があります。 landingPageTemplate と searchPageTemplate はオプションのプロパティです。 検索ページとランディングページを生成しない場合は、これらのプロパティを指定しないでください。
    titleデザインテンプレートのわかりやすい名前。
    topicContentNodeトピックページ内の DITA コンテンツを格納するノードの場所。 パスは、トピックページを基準とした相対パスです。
    topicHeadNodeDITA コンテンツから派生したヘッド値\（またはメタデータ\）を含むノードの場所。 パスはトピックページを基準とした相対パスです。
    tocNode目次を含むノードの場所。 パスは、ランディングページまたは宛先パスを基準とした相対パスです。
    basePathProp公開されたサイトのルートのパスを保存するプロパティ名。
    indexPathProp公開されたサイトのランディングページまたはインデックスページのパスを保存するプロパティ名。
    pdfPathPropトピックのPDFの生成が有効な場合に、トピックのPDFのパスを保存するためのプロパティ名。
    pdfTypePropPDF世代のタイプを格納するプロパティ名。 現在、このプロパティには常に「トピック」が含まれています。
    searchPathPropテンプレートに検索ページが含まれている場合に、検索ページのパスを保存するためのプロパティ名。
    siteTitleProp公開するサイトのタイトルを保存するためのプロパティ名。 通常、このタイトルはパブリッシュするマップのタイトルと同じです。
    sourcePathProp現在のページのソース DITA トピックのパスを保存するためのプロパティ名。
    tocPathProp公開されたサイトの目次ルートのパスを保存するプロパティ名。
NOTE
カスタムデザインテンプレートノードを作成したら、AEM サイト出力プリセットのデザインオプションを更新して、カスタムデザインテンプレートノードを使用する必要があります。

詳しくは、 最初のAdobe Experience Manager Web サイトの作成および 基本「AEMでの独自 Web サイトの開発」を参照してください。

AEM サイト出力の生成にドキュメントタイトルを使用

AEM Site 出力を生成する場合、URL の生成方法は、コンテンツの検出性に重要な役割を果たします。 UUID ベースのファイル名を使用している場合、ファイルの UUID に基づいて URL を生成しても、検索しづらくなります。 管理者または公開者は、AEM サイト出力の URL の生成方法を制御できます。 AEM Guidesでは、UUID ベースのファイル名ではなくファイルのタイトルを使用して、AEM サイト出力の URL を生成できる設定を提供します。 デフォルトでは、UUID ベースのファイルシステムの場合、このオプションはオンになっています。 つまり、UUID ベースのファイルシステムに対してAEM サイト出力を生成する場合、ファイルの UUID ではなく URL の生成にファイルのタイトルが使用されます。

NOTE
さらに、AEM Site 出力の URL に一連の文字のみを含めるルールを設定することもできます。 詳しくは、 トピックを作成し、AEM サイトの出力を公開するためのファイル名のサニタイズルールの設定を参照してください。

設定の上書きの手順に従って、設定ファイルを作成します。 設定ファイルで、次の\（property\）の詳細を指定して、AEM サイト出力での URL 生成を設定します。

PIDプロパティキープロパティの値
com.adobe.fmdita.config.ConfigManageraemsite.pagetitleブール \（true/false\） ページタイトルを使用して出力を生成する場合は、このプロパティを true に設定します。 デフォルトでは、ファイル名を使用するように設定されています。
デフォルト値:false

ドキュメントのタイトルを使用するには、AEM サイト出力の URL を設定します

AEM Site 出力の URL にドキュメントタイトルを使用できます。 ファイル名が存在しないか、特殊文字がすべて含まれる場合は、AEM サイト出力の URL で特殊文字を区切り文字に置き換えるようにシステムを設定できます。 また、最初の子トピックの名前に置き換えるように設定することもできます。

ページ名を設定するには、次の手順を実行します。

  1. 設定の上書きの手順に従って、設定ファイルを作成します。
  2. 設定ファイルで、次の（プロパティ）の詳細を指定して、トピックのページ名を設定します。
PIDプロパティキープロパティの値
com.adobe.fmdita.common.SanitizeNodeNamenodename.systemDefinedPageNameブール値（true/false）。 デフォルト値: false

たとえば、<topichead> の @navtitle にすべての特殊文字があり、aemsite.pagetitle プロパティを true に設定した場合、既定では区切り文字が使用されます。 nodename.systemDefinedPageName プロパティを true に設定すると、最初の子トピックの名前が表示されます。

AEM Sitesやその他の形式でトピックを作成し、出力を公開するためのファイル名のサニタイズルールを設定します

管理者は、ファイル名に使用できる有効な特殊文字のリストを定義できます。これらの特殊文字が、最終的にAEM サイトの出力の URL になります。 以前のリリースでは、@、$、> などの特殊文字を含むファイル名を定義できていました。 これらの特殊文字により、AEM サイトページの生成時に URL がエンコードされていました。

3.8 リリース以降、ファイル名で使用できる特殊文字のリストを定義する設定が追加されました。 デフォルトでは、有効なファイル名設定には「a-z A-Z 0-9 - _」が含まれます。 つまり、ファイルを作成する際に、ファイルのタイトルに任意の特殊文字を含めることができますが、内部的には、ファイル名ではハイフン\（-\）に置き換えられます。 例えば、ファイルのタイトルを Introduction 1 またはIntroduction@1にすることができ、これらの場合に生成される対応するファイル名は Introduction-1 になります。

有効な文字のリストを定義する場合、これらの文字「*/:[\]|#%{}?&<>"/+」と a space は常にハイフン \（-\）に置き換えられることに注意してください。

NOTE
有効な特殊文字リストを設定しないと、ファイル作成プロセスで予期しない結果が生じる場合があります。

設定の上書きの手順に従って、設定ファイルを作成します。 設定ファイルで、次の\（property\）の詳細を指定して、ファイル名とAEM サイト出力に有効な特殊文字を設定します。

PIDプロパティキープロパティの値
com.adobe.fmdita.common.SanitizeNodeNameImplaemsite.DisallowedFileNameCharsプロパティが '<>`@$ に設定されていることを確認します。 このリストには、さらに特殊文字を追加できます。
NOTE
上記の設定は、すべての出力形式に適用されます。 つまり、PDF、HTMLまたはカスタム出力を生成する際に、最終的な出力は、設定されたファイル名のサニタイズルールに従います。

その他のプロパティも設定できます。例えば、ファイル名で小文字を使用する、無効な文字を処理するための区切り文字、ファイル名に使用できる最大文字数などです。 これらのプロパティを設定するには、次のキーと値のペアを設定ファイルに追加します。

プロパティキープロパティの値
nodename.uselowerブール値\（true/false\）.
デフォルト値:true
nodename.separator任意の文字。
デフォルト値:_ \（underscore\）
nodename.maxlength整数値。
デフォルト値:50