Main Content

Documentation

Include content extracted from DocBlock blocks

Description

This component includes DocBlock block content in a report. It can have the following components as its parent:

  • Model Loop

  • System Loop

  • Block Loop

The DocBlock content is included in a report in one of these ways:

  • The actual content is included in the report.

  • The content is saved to an external file and the report links to the file.

  • The content is saved to an external file and the report includes the path of the file.

  • The content is embedded in the report and the report includes a link to the embedded file.

The way that the DocBlock content is included in a report depends on:

  • The DocBlock content type.

  • The report type and whether the report is template-based. See Report Templates.

  • The values of the ConvertHTML and EmbedFile properties, for template-based reports.

For template-based reports, the report includes the DocBlock content according to this table.

DocBlock Content TypeReport TypeConvertHTML PropertyEmbedFile PropertyReport Includes
DocBlock ContentExternal Link to DocBlock Content FileLink to Embedded DocBlock Content File
textHTMLN/AN/Ayesnono
textHTML-FILEN/AN/Ayesnono
textWordN/AN/Ayesnono
textPDFN/AN/Ayesnono
HTMLHTMLN/AN/Ayesnono
HTMLHTML-FILEN/AN/Ayesnono
HTMLPDFtrueN/Ayesnono
HTMLPDFfalsetruenonoyes
HTMLPDFfalsefalsenoyesno
HTMLWordtrueN/Ayesnono
HTMLWordfalseN/Anoyesno
RTFPDFN/Atruenonoyes
RTFPDFN/Afalsenoyesno
RTFWordN/AN/Ayesnono
RTFHTMLN/Atruenonoyes
RTFHTMLN/Afalsenoyesno
RTFHTML-FILEN/AN/Anoyesno

For reports that are not template-based, the report includes the DocBlock content according to this table.

DocBlock Content TypeReport TypeReport Includes
DocBlock ContentExternal Link to DocBlock Content FilePath of DocBlock Content File
textweb (HTML)yesnono
textAcrobat (PDF)yesnono
textWord (RTF)yesnono
textRTFyesnono
HTMLweb (HTML)yesnono
HTMLAcrobat (PDF)noyesno
HTMLWord (RTF)nonoyes
HTMLRTFnonoyes
RTFWeb (HTML)noyesno
RTFAcrobat (PDF)noyesno
RTFWord (RTF)yesnono
RTFRTFyesnono

Note

For non-English HTML DocBlock text that you want to include in a Documentation component, use UTF-8 file encoding. Use a simple text editor to create the HTML code.

Properties

  • Import file as: Specifies how to format the imported information. The following example shows how each option works, using the following text as input:

    First row.
      Second row.
    
    Third row follows blank line.
    • Plain text (ignore line breaks). Imports plain text without any line breaks (no paragraphs), as in this example:

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

    • Paragraphs defined by line breaks. Imports the text contained in paragraphs defined by line breaks (hard returns or carriage returns), as in this example:

      First row.
      Second row.
      
      Third row follows blank line.
    • Paragraphs defined by empty rows. Imports text contained in paragraphs defined by empty rows (rows that do not contain text), as in this example:

      First row. Second row.
      
      Third row follows blank line.
    • Text (retain line breaks). Imports plain text, including line breaks, as in this example:

      First row.
      Second row.
      
      Third row follows blank line.
    • Fixed-width text (retain line breaks). Imports fixed-width text (all letters have the same width or size) including line breaks, as in this example:

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

      Tip

      This option is useful for importing MATLAB® files.

  • Insert linking anchor for blocks: Inserts a linking anchor for each DocBlock block that designates the location where other links for that block point. (See the Simulink Linking Anchor or Link component reference pages for more help.) Do not use this option if you have already specified an anchor location for a DocBlock block with an Object Linking Anchor component.

  • ConvertHTML: Specifies whether to convert HTML content to a DOM object that is appended to the report. This option applies only to Word and PDF template-based reports. If the option is selected, the content is converted to HTML. If the option is not selected:

    • For a PDF report, the report embeds the content or includes an external link to the content, depending on the value of the EmbedFile option.

    • For a Word report, the report includes an external link to the content.

  • EmbedFile: Specifies whether to embed the content of the DocBlock block in the generated report. This option applies only to HTML or RTF content with template-based PDF reports and to RTF content with template-based HTML reports. If the option is selected, the content is embedded in the report and a hyperlink to the embedded content is inserted.

Insert Anything into Report?

Yes. Text, embedded file, or link to external file.

Class

rptgen_sl.csl_blk_doc