Documentation

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

Описание

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

  • Model Loop

  • System Loop

  • Block Loop

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

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

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

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

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

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

  • Тип контента DocBlock.

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

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

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

Тип контента DocBlockСообщите о типеСвойство ConvertHTMLСвойство EmbedFileОтчет включает в себя
Содержимое DocBlockВнешняя ссылка к файлу содержимого DocBlockСоединитесь со встроенным файлом содержимого DocBlock
текстHTMLN/AN/Aданетнет
текстФАЙЛ HTMLN/AN/Aданетнет
текстWordN/AN/Aданетнет
текстPDFN/AN/Aданетнет
HTMLHTMLN/AN/Aданетнет
HTMLФАЙЛ HTMLN/AN/Aданетнет
HTMLPDFtRUEN/Aданетнет
HTMLPDFложьtRUEнетнетда
HTMLPDFложьложьнетданет
HTMLWordtRUEN/Aданетнет
HTMLWordложьN/Aнетданет
RTFPDFN/AtRUEнетнетда
RTFPDFN/Aложьнетданет
RTFWordN/AN/Aданетнет
RTFHTMLN/AtRUEнетнетда
RTFHTMLN/Aложьнетданет
RTFФАЙЛ HTMLN/AN/Aнетданет

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

Тип контента DocBlockСообщите о типеОтчет включает в себя
Содержимое DocBlockВнешняя ссылка к файлу содержимого DocBlockПуть файла содержимого DocBlock
текстсеть (HTML)данетнет
текстAcrobat (PDF)данетнет
текстWord (RTF)данетнет
текстRTFданетнет
HTMLсеть (HTML)данетнет
HTMLAcrobat (PDF)нетданет
HTMLWord (RTF)нетнетда
HTMLRTFнетнетда
RTFСеть (HTML)нетданет
RTFAcrobat (PDF)нетданет
RTFWord (RTF)данетнет
RTFRTFданетнет

Примечание

Для неанглийского текста HTML DocBlock, который вы хотите включать в компонент Документации, используйте кодирование файла 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

Поддержка

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