Main Content

このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

Documentation

DocBlock ブロックから抽出したコンテンツを含める

説明

このコンポーネントは、DocBlock ブロックのコンテンツをレポートに含めます。以下のコンポーネントを親にもつことができます。

  • モデル ループ

  • システム ループ

  • ブロック ループ

DocBlock コンテンツは、以下のいずれかの方法でレポートに含められます。

  • 実際のコンテンツがレポートに含められる。

  • コンテンツは外部ファイルに保存され、レポートがそのファイルへリンクされる。

  • コンテンツは外部ファイルに保存され、レポートにそのファイルへのパスが含められる。

  • コンテンツはレポートに組み込まれ、レポートにその組み込みファイルへのリンクが含められる。

DocBlock コンテンツをレポートに含める方法は、以下によって異なります。

  • DocBlock コンテンツ タイプ。

  • レポート タイプ、およびレポートがテンプレートベースかどうか。レポート テンプレートを参照してください。

  • テンプレートベースのレポートの場合、ConvertHTML プロパティと EmbedFile プロパティの値。

テンプレートベースのレポートには、以下の表に従って DocBlock コンテンツがレポートに含められます。

DocBlock コンテンツ タイプレポート タイプ[HTML の変換] プロパティ[ファイルの組み込み] プロパティレポートに含まれるもの
DocBlock コンテンツDocBlock コンテンツ ファイルへの外部リンク組み込み DocBlock コンテンツ ファイルへのリンク
テキストHTML該当なし該当なしありなしなし
テキストHTML ファイル該当なし該当なしありなしなし
テキストWord該当なし該当なしありなしなし
テキストPDF該当なし該当なしありなしなし
HTMLHTML該当なし該当なしありなしなし
HTMLHTML ファイル該当なし該当なしありなしなし
HTMLPDFtrue該当なしありなしなし
HTMLPDFfalsetrueなしなしあり
HTMLPDFfalsefalseなしありなし
HTMLWordtrue該当なしありなしなし
HTMLWordfalse該当なしなしありなし
RTFPDF該当なしtrueなしなしあり
RTFPDF該当なしfalseなしありなし
RTFWord該当なし該当なしありなしなし
RTFHTML該当なしtrueなしなしあり
RTFHTML該当なしfalseなしありなし
RTFHTML ファイル該当なし該当なしなしありなし

テンプレートベースではないレポートには、以下の表に従って DocBlock コンテンツがレポートに含められます。

DocBlock コンテンツ タイプレポート タイプレポートに含まれるもの
DocBlock コンテンツDocBlock コンテンツ ファイルへの外部リンクDocBlock コンテンツ ファイルのパス
テキストWeb (HTML)ありなしなし
テキストAcrobat (PDF)ありなしなし
テキストWord (RTF)ありなしなし
テキストRTFありなしなし
HTMLWeb (HTML)ありなしなし
HTMLAcrobat (PDF)なしありなし
HTMLWord (RTF)なしなしあり
HTMLRTFなしなしあり
RTFWeb (HTML)なしありなし
RTFAcrobat (PDF)なしありなし
RTFWord (RTF)ありなしなし
RTFRTFありなしなし

メモ

英語以外の HTML DocBlock テキストを Documentation コンポーネントに含める場合は UTF-8 ファイル エンコードを使用します。HTML コードは標準のテキスト エディターで作成します。

プロパティ

  • インポートするファイル: インポートした情報を書式設定する方法を指定します。次の例は、以下のテキストを入力として使用して各オプションを指定した場合の結果を示します。

    First row.
      Second row.
    
    Third row follows blank line.
    • テキスト形式 (改行を無視)。改行なし (段落なし) の標準テキストをインポートします。たとえば、次のようになります。

      First row. Second row. Third row follows blank line.

    • 改行で定義される段落。改行 (ハード リターンまたはキャリッジ リターン) で定義される段落に含まれたテキストをインポートします。たとえば、次のようになります。

      First row.
      Second row.
      
      Third row follows blank line.
    • 空白行で定義される段落。空白行 (テキストを含まない行) で定義される段落に含まれたテキストをインポートします。たとえば、次のようになります。

      First row. Second row.
      
      Third row follows blank line.
    • テキスト (改行を保持)。改行を含む標準テキストをインポートします。たとえば、次のようになります。

      First row.
      Second row.
      
      Third row follows blank line.
    • 固定幅テキスト (改行を保持)。改行を含む固定幅テキスト (すべての文字が同じ幅またはサイズ) をインポートします。たとえば、次のようになります。

      First row.
        Second row.
      
      Third row follows blank line.

      ヒント

      このオプションは MATLAB® ファイルをインポートする場合に便利です。

  • ブロックのアンカーへのリンクを挿入: 各 DocBlock ブロックに、他のリンクがそのブロックを指す場所を指定するリンク アンカーを挿入します (詳しいヘルプについては、Simulink アンカーのリンクまたはリンク コンポーネントのリファレンス ページを参照してください)。既に Object Linking Anchor コンポーネントで DocBlock ブロックのアンカーの場所を指定してある場合、このオプションは使用しないでください。

  • HTML の変換: HTML コンテンツを、レポートに追加する DOM オブジェクトに変換するかどうかを指定します。このオプションは、Word および PDF のテンプレートベースのレポートにのみ適用されます。このオプションが選択されている場合、コンテンツは HTML に変換されます。このオプションが選択されていない場合、以下になります。

    • PDF レポートでは、[ファイルの組み込み] オプションの値に応じて、レポートにコンテンツが組み込まれるか、コンテンツへの外部リンクが含まれます。

    • Word レポートでは、レポートにコンテンツへの外部リンクが含まれます。

  • ファイルの組み込み: DocBlock ブロックのコンテンツを生成レポートに組み込むかどうかを指定します。このオプションは、テンプレートベースの PDF レポートでの HTML または RTF コンテンツ、および、テンプレートベースの HTML レポートでの RTF コンテンツにのみ適用されます。このオプションが選択されている場合、コンテンツはレポートに組み込まれ、その組み込まれたコンテンツへのハイパーリンクが挿入されます。

レポートに挿入されるもの

あり。テキスト、組み込みファイル、または外部ファイルへのリンク。

クラス

rptgen_sl.csl_blk_doc