ドキュメント生成。 問題と解決策

テンプレートによってドキュメントを生成するための重要なタスクは、テンプレートの数を減らすことです。 テンプレートが少なければ少ないほど、テンプレートの保守と変更が容易になります。 これは、パターンがポリモーフィックな場合、つまり 冗長性が含まれます。 生成パラメータに応じて、ドキュメント生成中の余分な部分が削除され、その結果、必要な部分のみが残ります。 たとえば、テンプレートのテキストを次のようにマークしましょう。



<part:1>パート1のテキスト</ part:1>

永続的なテキスト。 <part:2>パート2のテキスト</ part:2>



<part:1>を削除する(または<part:2>を残す)必要があるパラメーターをジェネレーターに渡します。 その結果、以下が得られます。



永続的なテキスト。 パート2のテキスト。



論理演算AND(<part:1>および<part:3>が選択されている場合は削除しない)の場合、マークアップは次のようになります。



<part:1> <part:3>パート1のテキスト</ part:3> </ part:1>

永続的なテキスト。 <part:2>パート2のテキスト</ part:2>



論理OR演算(<part:1>または<part:3>が選択されている場合は削除)の場合、マークアップは次のようになります。



<part:1> || <part:3>パート1のテキスト</ part:3> </ part:1>

永続的なテキスト。 <part:2>パート2のテキスト</ part:2>



このテンプレートのマークアップ方法の長所と短所をリストします。



利点:



-1つのテンプレートに、テーマに関連する多くのドキュメントを含めることができます。

-マークアップは非常にシンプルで、IT以外の従業員が行うことができます。 テンプレートを開発するための優れたツールがあれば、サブジェクトエリアの有能な人がそのようなマークアップを実行でき、そのサブジェクトのIT中間者と協力する必要はありません。

-フィールドのリスト全体から取得して、テンプレートに含まれる情報を埋めることができます。これは、テンプレートから余分なフラグメントを削除した後に残るフィールドのリストです。



短所:



-特別な開発者ツールを使用しないマークアップは読みにくい。

-テンプレートの寸法が非常に大きくなるため、特別な対策を講じないと、生成速度が低下する可能性があります。



大きなサイズのテンプレートに対抗するために、テンプレートをパーツに分割する方法を適用できます。パーツはテンプレートとは別に保存され、ジェネレーターにパラメーターが渡された場合にのみ挿入されます。 これにより、テンプレートのサイズが大幅に削減されるため、生成時間が短縮されます。 テンプレートに特別なマークアップがある場合、テンプレートはテンプレート開発環境によって自動的にパーツに分割されます。これは、どの場合にパーツをメインテンプレートに挿入する必要があるかを示します。



All Articles