印刷テンプレート

印刷テンプレート エンティティは、エンティティのプロパティとリレーションを使用して PDF ファイルの構造を定義する .cshtml、.json、および .css ファイルを含む ZIP パッケージです。

[印刷テンプレート] ページで印刷テンプレート エンティティを作成するには、次の手順に従います。

1. メイン メニュー バーの [管理] をクリックします。
2. [管理] ページで、[印刷テンプレート] をクリックします。
3. [印刷テンプレート] ページで、[新しい印刷テンプレート] をクリックします。

4. [新しい印刷テンプレート] ダイアログ ボックスで、次のパラメーターを定義します。

   フィールド	タイプ	説明	値	必須
   名前	文字列	印刷テンプレートの名前。	文字列値	はい
   ターゲットの定義	ドロップダウン リスト	PDF ファイルに表示されるエンティティの定義	エンティティ定義	はい
   カスタム プロパティ	文字列	PDF ファイルの生成時にユーザーが指定する必要のある追加プロパティです	名前とラベルの値	いいえ

5. [作成] をクリックします。

6. [印刷テンプレートをアップロード] ダイアログ ボックスで、印刷テンプレート パッケージをアップロードします。

[エンティティ] ページの印刷テンプレート エンティティを作成するには、次の手順に従います。

1. メイン メニュー バーの [管理] をクリックします。
2. [管理] ページで、[エンティティ] をクリックします。
3. [エンティティ] ページの [検索] フィールドに Print.EntityGenerationTemplate と入力し、それを選択します。
4. [印刷テンプレート エンティティ] ページの [新しいエンティティ] をクリックします。

5. エンティティの詳細ページで [システム] タブをクリックして、次のパラメーターを定義します。

   フィールド	タイプ	説明	値	必須
   名前	文字列	印刷テンプレートの名前。	文字列値	はい
   ターゲットの定義	ドロップダウン リスト	PDF ファイルに表示されるエンティティの定義	エンティティ定義	はい
   アセット	選択リスト	印刷テンプレートの ZIP パッケージ	ZIP ファイル	いいえ
   カスタム プロパティ	文字列	PDF ファイルの生成時にユーザーが指定する必要のある追加プロパティです	名前とラベルの値	いいえ

6. エンティティの詳細ページで [テクニカル] タブをクリックして、次のパラメーターを定義します。

   フィールド	タイプ	説明	値	必須
   識別子	文字列	印刷テンプレート エンティティの識別子	文字列値	はい
   セキュリティの継承	トグル スイッチ	親エンティティからセキュリティ設定を継承します	オン / オフ	いいえ

印刷テンプレート エンティティの作成後、印刷エンティティの生成アクションは、印刷テンプレートに基づいて PDF ファイルを生成するために使用されます。

印刷エンティティの生成アクションを作成するには、次の手順に従います。

1. メイン メニュー バーの [管理] をクリックします。
2. [管理] ページで、[アクション] をクリックします。
3. [アクション] ページで [新しいアクション] をクリックします。

4. [新しいアクション] ダイアログ ボックスで、次のパラメーターを定義します。

   フィールド	タイプ	説明	値	必須
   名前	文字列	アクションの名前	文字列値	はい
   ラベル	文字列	アクションのラベル	文字列値	いいえ
   タイプ	ドロップダウン リスト	アクション タイプ	[印刷エンティティ生成] を選択	はい
   定義	ドロップダウン リスト	PDF 生成のターゲット定義	エンティティ定義	はい
   テンプレート	ドロップダウン リスト	PDF 生成に使用する印刷テンプレート エンティティ	印刷テンプレート	はい

5. [保存] をクリックします。

印刷テンプレート エンティティと印刷エンティティの生成アクションを作成したら、PDF の生成操作を設定する必要があります。この操作を呼び出すと、印刷エンティティの生成アクションがトリガーされ、これにより PDF が生成されます。

任意のページのページ コンポーネントに対して PDF の生成操作を設定できます。次の手順では、アセットの詳細ページで操作をエンティティ操作コンポーネントに追加する方法について詳しく説明しますが、手順は PDF の生成操作をサポートするすべてのページおよびページ コンポーネントで同じです。

PDF の生成操作を追加する

1. メイン メニュー バーの [管理] をクリックします。
2. 管理ページで、[ページ] をクリックします。
3. ページ ポータルで [アセットの詳細] ページを検索して選択します。
4. [レイアウト] タブをクリックし、次に [エンティティの操作] コンポーネントをクリックして編集します。
5. [EntityOperations コンポーネント] ページで [操作の追加] をクリックし、次に [PDFの生成] を選択します。
6. PDF の生成操作の表示設定 を設定します。

7. 次の操作設定を定義します。

   フィールド	タイプ	説明	値	必須
   アクション	選択リスト	PDF 生成をトリガーする印刷エンティティの生成アクション	印刷エンティティの生成タイプのアクション	はい
   高解像度	トグル スイッチ	より高品質な PDF の生成	オン / オフ	いいえ

8. [保存] をクリックします。

"highRes": {
"property": "Renditions",
"rendition": "thumbnail"
}

このセクションでは、「Module」という名前のエンティティで使用される印刷テンプレート ZIP パッケージの例を示します。このパッケージには、「Feature」という名前の関連エンティティのリストが含まれています。

ZIP パッケージには、次のファイルが含まれています。

• Module.json - 使用される Module プロパティと、関連するエンティティ (この場合は Feature エンティティ) を指定するメイン ファイル。
• Module.cshtml - HTML 形式を使用して PDF ファイルで定義された Module プロパティの構造を指定します。このファイルは、他の .cshtml ファイルを参照して、それらを構造内に埋め込むことができます。
• Feature.cshtml - HTML 形式を使用して PDF ファイルで定義された Feature プロパティの構造を指定します。このファイルは、他の .cshtml ファイルに埋め込むことができます。
• CSS ファイル: このファイルは .cshtml ファイルに関連する CSS を指定します。

Module json

次のコードは、Module.json ファイルの例です。

{
"template": {
"type": "Template",
"file": "module.cshtml",
"source": {
"type": "entity",
"variables": [
{
"name": "TopTitleLabel",
"type": "snippet",
"value": {
"en-US": "Module Specifications"
}
},
{
"name": "Preview",
"type": "rendition",
"lowRes": {
"property": "Renditions",
"rendition": "preview"
},
"highRes": {
"property": "MainFile"
},
"relation": {
"name": "ModuleToMasterAsset",
"role": "Parent",
"relation": {
"name": "MasterFile",
"role": "Parent"
}
}
},
{
"name": "FeaturesLabel",
"type": "snippet",
"value": {
"en-US": "Features"
}
},
{
"name": "ModuleName",
"type": "property",
"property": "ModuleName"
},
{
"name": "ModuleDescription",
"type": "property",
"property": "ModuleDescription"
},
{
"name": "Features",
"type": "Template",
"template": {
"type": "Template",
"file": "features.cshtml",
"source": {
"type": "relation",
"relation": {
"name": "ModuleToFeature",
"role": "Parent"
},
"variables": [
{
"name": "FeatureName",
"type": "property",
"property": "FeatureName"
},
{
"name": "FeatureDescription",
"type": "property",
"property": "FeatureDescription"
},
{
"name": "FeatureType",
"type": "property",
"property": "FeatureType"
}
]
}
}
}
]
}
}
}

Module cshtml

次のコードは、Module.cshtml ファイルの例です。

@model Stylelabs.M.Print.EntityGeneration.Models.Model

<html>
<head>
<link rel="stylesheet" href="bootstrap.min.css" />
<link rel="stylesheet" href="styles.css" />
<title>Module specification</title>
</head>
<body>
<div class="top-header">
<img src="/logo.png" class="logo" />
<h5 class="top-title">
@Raw(@Model.Properties["$$TopTitleLabel$$"].FirstOrDefault())
</h5>
</div>
<div class="container-wrapper">
<div class="container">
<div class="row">
<div class="col-xs-8">
<h1>@Raw(@Model.Properties["$$ModuleName$$"].FirstOrDefault())</h1>
<div class="lead">
@Raw(@Model.Properties["$$ModuleDescription$$"].FirstOrDefault())
</div>
</div>
<div class="col-xs-4">
<img src="@(@Model.Properties["$$Preview$$"].FirstOrDefault())" d>
</div>
</div>
</div>
</div>
<div class="container">
<h5>@Raw(@Model.Properties["$$FeaturesLabel$$"].FirstOrDefault())</h5>
<div class="features-wrapper">
@foreach (var feature in @Model.Properties["$$Features$$"]) {
@Raw(feature) }
</div>
</div>
</body>
</html>

Feature cshtml

次のコードは、Feature.cshtml ファイルの例です。

@model Stylelabs.M.Print.EntityGeneration.Models.Model

<h4>
@Raw(@Model.Properties["$$FeatureName$$"].FirstOrDefault()) @*<span
class="type"
>@Raw(@Model.Properties["$$FeatureType$$"].FirstOrDefault())</span
>*@
</h4>
<div class="feature-description">
@Raw(@Model.Properties["$$FeatureDescription$$"].FirstOrDefault())
</div>