Documentation

Включите содержимое, извлеченное из блоков DocBlock

Описание

Этот компонент включает DocBlock себя содержимое блока в отчете. Он может иметь следующие компоненты в качестве родительского элемента:

  • Model Loop

  • System Loop

  • Block Loop

DocBlock содержимого включается в отчет одним из следующих способов:

  • Фактическое содержимое включается в отчет.

  • Содержимое сохраняется во внешнем файле, а отчет связывается с файлом.

  • Содержимое сохраняется во внешний файл, и отчет содержит путь к файлу.

  • Содержимое встраивается в отчет, и отчет включает ссылку на встраиваемый файл.

Способ включения содержимого DocBlock в отчет зависит от:

  • Тип содержимого DocBlock.

  • Тип отчета и то, основан ли отчет на шаблоне. См. раздел Шаблоны отчетов.

  • Значения ConvertHTML и EmbedFile свойства для отчетов на основе шаблонов.

Для отчетов на основе шаблонов отчет включает DocBlock содержимое в соответствии с этой таблицей.

Тип содержимого DocBlockТип отчетаСвойство ConvertHTMLСвойство EmbedFileОтчет включает
Содержимое DocBlockВнешняя ссылка на файл содержимого DocBlockСсылка на файл содержимого Embedded DocBlock
текстHTMLН/ДН/Дданетнет
текстHTML-ФАЙЛН/ДН/Дданетнет
текстWordН/ДН/Дданетнет
текстPDFН/ДН/Дданетнет
HTMLHTMLН/ДН/Дданетнет
HTMLHTML-ФАЙЛН/ДН/Дданетнет
HTMLPDFправдаН/Дданетнет
HTMLPDFложныйправданетнетда
HTMLPDFложныйложныйнетданет
HTMLWordправдаН/Дданетнет
HTMLWordложныйН/Днетданет
RTFPDFН/Дправданетнетда
RTFPDFН/Дложныйнетданет
RTFWordН/ДН/Дданетнет
RTFHTMLН/Дправданетнетда
RTFHTMLН/Дложныйнетданет
RTFHTML-ФАЙЛН/ДН/Днетданет

Для отчетов, не основанных на шаблонах, отчет включает DocBlock содержимое в соответствии с этой таблицей.

Тип содержимого DocBlockТип отчетаОтчет включает
Содержимое DocBlockВнешняя ссылка на файл содержимого DocBlockПуть к файлу содержимого DocBlock
текстweb (HTML)данетнет
текстАкробат (PDF)данетнет
текстСлово (RTF)данетнет
текстRTFданетнет
HTMLweb (HTML)данетнет
HTMLАкробат (PDF)нетданет
HTMLСлово (RTF)нетнетда
HTMLRTFнетнетда
RTFВеб (HTML)нетданет
RTFАкробат (PDF)нетданет
RTFСлово (RTF)данетнет
RTFRTFданетнет

Примечание

Для неанглийского текста HTML DocBlock, который необходимо включить в компонент Documentation, используйте UTF-8 кодировку файла. Используйте простой текстовый редактор, чтобы создать HTML кода.

Свойства

  • Import file as: Указывает, как форматировать импортированную информацию. В следующем примере показано, как работает каждая опция, используя следующий текст в качестве входных данных:

    First row.
  Second row.

Third row follows blank line.

    • Plain text (ignore line breaks). Импорт простого текста без каких-либо пропусков линий (без абзацев), как в этом примере: 

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

    • Paragraphs defined by line breaks. Импортирует текст, содержащийся в абзацах, заданных пропусками линий (жесткие возвраты или возвраты каретки), как в этом примере: 

      First row.
Second row.

Third row follows blank line.

    • Paragraphs defined by empty rows. Импортирует текст, содержащийся в абзацах, заданных пустыми строками (строки, не содержащие текста), как в этом примере: 

      First row. Second row.

Third row follows blank line.

    • Text (retain line breaks). Импортирует простой текст, включая пропуски линий, как в этом примере:

      First row.
Second row.

Third row follows blank line.

    • Fixed-width text (retain line breaks). Импортирует текст фиксированной ширины (все буквы имеют одинаковую ширину или размер), включая пропуски линий, как в этом примере:

      First row.
  Second row.

Third row follows blank line.

      Совет

      Эта опция полезна для импорта MATLAB® файлы.

  • Insert linking anchor for blocks: Вставляет привязку связи для каждого блока DocBlock, которая определяет местоположение, где другие ссылки для этой точки блока. (См. Simulink Linking Anchor или Link страницы с описанием компонентов для получения дополнительной справки.) Не используйте эту опцию, если вы уже задали расположение якоря для блока DocBlock с Object Linking Anchor компонент.

  • ConvertHTML: Определяет, преобразовать ли HTML содержимого в объект DOM, добавленный к отчету. Эта опция применяется только к отчетам на основе шаблонов Word и PDF. Если опция выбрана, содержимое преобразуется в HTML. Если опция не выбрана:

    • Для отчета PDF отчет встраивает содержимое или включает внешнюю ссылку на содержимое в зависимости от значения опции EmbedFile.

    • Для отчета Word отчет включает внешнюю ссылку на содержимое.

  • EmbedFile: Определяет, следует ли встраивать содержимое блока DocBlock в сгенерированный отчет. Эта опция применяется только к содержимому HTML или RTF с отчетами о PDF на основе шаблонов и к содержимому RTF с HTML-отчетами на основе шаблонов. Если выбрана опция, содержимое встраивается в отчет и вставляется гиперссылка на встроенное содержимое.

Вставить что-нибудь в отчет?

Да. Текст, встроенный файл или ссылка на внешний файл.

Класс

rptgen_sl.csl_blk_doc

Simulink Report Generator

Поддержка

Для просмотра документации необходимо авторизоваться на сайте