Включайте содержимое, извлеченное из блоков DocBlock
Этот компонент включает содержимое блока DocBlock в отчет. Это может иметь следующие компоненты как свой родительский элемент:
Model Loop
System Loop
Block Loop
Содержимое DocBlock включено в отчет одним из этих способов:
Фактическое содержимое включено в отчет.
Содержимое сохранено во внешний файл и ссылки отчета на файл.
Содержимое сохранено во внешний файл, и отчет включает в себя путь файла.
Содержимое встраивается в отчет, и отчет включает в себя ссылку на встроенный файл.
Способ, которым содержимое DocBlock включено в отчет, зависит от:
Тип контента DocBlock.
Тип отчета и основан ли отчет на шаблоне. Смотрите Шаблоны Отчета.
Значения ConvertHTML
и EmbedFile
свойства, для основанных на шаблоне отчетов.
Для основанных на шаблоне отчетов отчет включает в себя содержимое DocBlock согласно этой таблице.
Тип контента DocBlock | Сообщите о типе | Свойство ConvertHTML | Свойство EmbedFile | Отчет включает в себя | ||
---|---|---|---|---|---|---|
Содержимое DocBlock | Внешняя ссылка к файлу содержимого DocBlock | Соединитесь со встроенным файлом содержимого DocBlock | ||||
текст | HTML | N/A | N/A | да | нет | нет |
текст | ФАЙЛ HTML | N/A | N/A | да | нет | нет |
текст | Word | N/A | N/A | да | нет | нет |
текст | N/A | N/A | да | нет | нет | |
HTML | HTML | N/A | N/A | да | нет | нет |
HTML | ФАЙЛ HTML | N/A | N/A | да | нет | нет |
HTML | tRUE | N/A | да | нет | нет | |
HTML | ложь | tRUE | нет | нет | да | |
HTML | ложь | ложь | нет | да | нет | |
HTML | Word | tRUE | N/A | да | нет | нет |
HTML | Word | ложь | N/A | нет | да | нет |
RTF | N/A | tRUE | нет | нет | да | |
RTF | N/A | ложь | нет | да | нет | |
RTF | Word | N/A | N/A | да | нет | нет |
RTF | HTML | N/A | tRUE | нет | нет | да |
RTF | HTML | N/A | ложь | нет | да | нет |
RTF | ФАЙЛ HTML | N/A | N/A | нет | да | нет |
Для отчетов, которые не основаны на шаблоне, отчет включает в себя содержимое DocBlock согласно этой таблице.
Тип контента DocBlock | Сообщите о типе | Отчет включает в себя | ||
---|---|---|---|---|
Содержимое DocBlock | Внешняя ссылка к файлу содержимого DocBlock | Путь файла содержимого DocBlock | ||
текст | сеть (HTML) | да | нет | нет |
текст | Acrobat (PDF) | да | нет | нет |
текст | Word (RTF) | да | нет | нет |
текст | RTF | да | нет | нет |
HTML | сеть (HTML) | да | нет | нет |
HTML | Acrobat (PDF) | нет | да | нет |
HTML | Word (RTF) | нет | нет | да |
HTML | RTF | нет | нет | да |
RTF | Сеть (HTML) | нет | да | нет |
RTF | Acrobat (PDF) | нет | да | нет |
RTF | Word (RTF) | да | нет | нет |
RTF | RTF | да | нет | нет |
Примечание
Для неанглийского текста 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
Block Loop
, Model Loop
, Simulink Linking Anchor
, System Loop