Exponenta Banner
exponenta event banner

Документация

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

Описание

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

  • Цикл модели

  • Системный контур

  • Контур блока

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

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

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

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

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

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

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

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

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

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

Тип содержимого DocBlockТип отчетаСвойство ConvertHTMLСвойство EmbedFileОтчет включает
Содержимое DocBlockВнешняя ссылка на файл содержимого DocBlockСсылка на встроенный файл содержимого 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)данетнет
текстAcrobat (PDF)данетнет
текстСлово (RTF)данетнет
текстRTFданетнет
HTMLweb (HTML)данетнет
HTMLAcrobat (PDF)нетданет
HTMLСлово (RTF)нетнетда
HTMLRTFнетнетда
RTFВеб (HTML)нетданет
RTFAcrobat (PDF)нетданет
RTFСлово (RTF)данетнет
RTFRTFданетнет

Примечание

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

Свойства

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

    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 ®.

  • Вставка привязки связывания для блоков: вставка привязки связывания для каждого блока 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

Поддержка