Шаблоны генератора отчетов

Эта ссылка описывает шаблоны, используемые этими генераторами отчетов:

Используйте эту информацию, чтобы создать пользовательские шаблоны для использования с одним из этих генераторов отчетов или от генератора отчетов, выведенного из этих генераторов отчетов.

Разделите шаблоны

Генератор отчетов Раздела использует шесть наборов шаблонов для каждого из трех выходных типов, поддержанных MATLAB® Report Generator™: docx, PDF и HTML. Каждый набор соответствует шести уровням иерархии раздела что Section генератор отчетов может сгенерировать. Первый набор соответствует разделу верхнего уровня, второму набору к подразделу второго уровня раздела верхнего уровня, и так далее.

Каждый набор уровня содержит три шаблона:

Section генератор отчетов определяет, которые устанавливают, чтобы использовать, когда ваша программа отчета добавляет генератор отчетов в объект отчета. Например, когда ваша программа отчета добавляет Section генератор отчетов к Объекту отчета, Section генератор отчетов использует набор шаблона верхнего уровня. Section генератор отчетов использует набор шаблона второго уровня, когда отчет добавляет, что метод добавляет его в отчет как часть содержимого генератора отчетов раздела верхнего уровня. Section генератор отчетов использует дважды косвенный набор шаблона, когда отчет добавляет, что метод добавляет его в отчет как часть содержимого генератора отчетов второго уровня и т.д.

Шаблон Section1

Section Word генератора отчетов, PDF и шаблоны HTML Section1 задают формат раздела верхнего уровня, сгенерированного Разделом 1 генератор отчетов, одним словом, PDF и отчет HTML, соответственно. Все три шаблона задают местоположение отверстий и стилей по умолчанию для Section Title генератора отчетов и Content свойства.

Кроме того, PDF и шаблоны Word задают свойства макета страницы раздела верхнего уровня, включая ориентацию страницы, поля, верхние колонтитулы страницы и нижние колонтитулы раздела Word или PDF верхнего уровня. Word и шаблоны PDF задают различный заголовок для первой страницы раздела и для страниц, который следует. Заголовок первой страницы содержит только правило. Заголовок последующих страниц, названных заголовком по умолчанию, содержит заголовок раздела. Первый нижний колонтитул и последующие нижние колонтитулы идентичны.

Раздел верхнего уровня запускается на новой странице, задающей свойства верхним уровнем Section шаблон генератора отчетов. Все последующие страницы должны были вместить содержимое раздела верхнего уровня, имеют тот же макет страницы, если само содержимое не задает новый макет страницы, в этом случае, макет страницы последующих изменений страниц. Шаблоны раздела низшего уровня по умолчанию не задают макет страницы. В результате добавление подразделов к разделу не изменяет макет страницы. Содержимое подразделов имеет то же размещение как разделы верхнего уровня.

  • Word Section1 Template

    Шаблон Word Section1 находится в галерее QuickParts Section default.dotx генератора отчетов обработайте файл по шаблону. Галерея QuickParts служит Section библиотека шаблонов Word генератора отчетов. Чтобы просмотреть или отредактировать шаблон Section1, необходимо открыть default.dotx файл в Word и создает экземпляр шаблона в default.dotx шаблон. Шаблон Section1 появляется следующим в Word:

    Примечание

    Когда вы отображаете копию шаблона Word Section1, это прокручивает к верхнему колонтитулу страницы по умолчанию на второй странице, которая отображает сообщение об ошибке. Обратитесь к примечанию ниже для объяснения этого сообщения об ошибке. Чтобы видеть отверстия шаблона, прокрутите к верхней части шаблона.

    Шаблон Section 1 задает заголовок для первой страницы раздела, который отличается от заголовка последующих страниц. Заголовок всех кроме первой страницы называется заголовком по умолчанию. Первый верхний колонтитул страницы содержит правило, но в противном случае пуст.

    Примечание

    Правило реализовано как пустой абзац с нижней границей. Размер шрифта абзаца собирается в очень низкую стоимость минимизировать высоту абзаца.

    Первый нижний колонтитул содержит поле номера страницы Word. Когда этот шаблон или отчет, сгенерированный от него, открыты в Word, Word заменяет поле на количество страницы, на которой появляется нижний колонтитул.

    Верхний колонтитул страницы Section1 по умолчанию содержит поле Word StyleRef, которое ссылается на стиль заголовка раздела (то есть, SectionTitle). Когда шаблон или отчет, сгенерированный из шаблона, открыты в Word, Word заменяет поле StyleRef на содержимое первого абзаца в разделе, который сделал, чтобы SectionTitle разработал. В отчете тот абзац содержит заголовок раздела. Таким образом заголовок раздела появляется в верхних колонтитулах страницы, которые следуют за первой страницей. (Это называется верхним колонтитулом в проекте документа.)

    Примечание

    Шаблон Section1 занимает меньше чем страницу. Таким образом, когда вы копируете шаблон Section1 с галереи QuickPart генератора отчетов Раздела (то есть, библиотека шаблонов) к телу default.dotx обработайте по шаблону, только первая страница раздела появляется. Однако Word создает страницу с новым разделом (Раздел 2), который наследовал верхние колонтитулы страницы шаблона Section1. Word заменяет поле StyleRef в заголовке этого нового раздела с сообщением об ошибке, потому что нет никакого абзаца в новом разделе со стилем, на который ссылаются.

    Шаблон Section1 задает нижний колонтитул по умолчанию, который идентичен в содержимом и формате к первому нижнему колонтитулу.

    Примечание

    Чтобы просмотреть или отредактировать нижний колонтитул по умолчанию, необходимо вставить страницу в шаблон Section1 можно следующим образом:

    1. Скопируйте шаблон с Sectionгалерея шаблона генератора отчетов QuickParts (то есть, ее библиотека шаблонов) к телу шаблона генератора отчетов.

    2. Вставьте абзац после отверстия Содержимого в шаблоне.

    3. Включите Page Break Before абзаца свойство.

  • Шаблон PDF Section1

    Шаблон PDF Section1 находится в библиотеке шаблонов файла шаблона PDF генератора отчетов Раздела (default.pdftx). Файл шаблона является zip-файлом. Это хранит библиотеку шаблонов в файле named docpart_templates.html. Просмотреть или отредактировать шаблон Section1:

    1. Разархивируйте копию default.pdftx файл с помощью API Отчета unzipTemplate команда.

    2. Откройте docpart_templates.html файл в редакторе MATLAB или любом другом текстовом редакторе.

    3. По окончании редактируя шаблон Section1, сохраняете docpart_templates.html файл.

    4. Повторно архивируйте default.pdftx файл, с помощью API Отчета zipTemplate команда.

    Для получения дополнительной информации смотрите, Создают Библиотеку шаблонов Части Документа в формате PDF.

    Шаблон PDF Section1 использует следующую разметку HTML, чтобы задать макет страницы раздела PDF верхнего уровня, сгенерированного Section генератор отчетов. Разметка также задает местоположение отверстий, чтобы быть заполненной содержимым Section Title генератора отчетов и Content свойства.

    pheader и pfooter элементы в размещении Section1 указывают, что шаблоны раньше задавали содержимое и размещение верхних колонтитулов страницы и нижних колонтитулов раздела верхнего уровня. Заголовок и шаблоны нижнего колонтитула находятся в том же файле библиотеки шаблонов (docpart_templates.html) как сам шаблон Section1. Section генератор отчетов использует только первую страницу и шаблоны страницы по умолчанию.

    Первый верхний колонтитул страницы и шаблоны нижнего колонтитула

    Шаблон заголовка задает пустой абзац, сопровождаемый горизонтальным правилом. Пустой абзац задает стиль SectionTitleHead. Это задано в таблице стилей шаблона (см. ниже). Первый шаблон нижнего колонтитула задает горизонтальное правило, сопровождаемое номером страницы.

    Шаблон верхнего колонтитула страницы по умолчанию

    задает абзац, содержащий styleref, сопровождаемый горизонтальным правилом. Во время генерации отчета API Отчета заменяет styleref элемент на содержимое абзаца заголовка раздела верхнего уровня, таким образом, создавая верхний колонтитул.

    Шаблон нижнего колонтитула по умолчанию

    задает горизонтальное правило, сопровождаемое автоматически сгенерированным номером страницы.

    Стили для заголовка и шаблонов нижнего колонтитула находятся в pdf/stylesheets/root.css файл.

  • HTML Section1 Шаблон

    Часть документа Section1 обрабатывает по шаблону в default.htmt файл задает отверстия Заголовка и Содержимого.

Section2 – Шаблоны Section6

Шаблоны Section2-Section6 задают формат подразделов, сгенерированных Section генератор отчетов. Каждый шаблон содержит элементы отверстия, которые задают местоположение отверстий, чтобы быть заполненными содержимым генератора отчетов Раздела Title и Content свойства, соответственно. Отверстие Заголовка в каждом шаблоне задает стиль заголовка по умолчанию, характерный для уровня подраздела, заданного шаблоном.

  • Word Section2 – Шаблоны Section6

    Как пример, это изображение показывает шаблон Section2.

  • PDF и шаблоны HTML Section2 - Section6

    Как пример, это изображение показывает шаблон Section2.

Разделите отверстия шаблона

Всем шаблонам Раздела (Section1 – Section6) описали отверстия в этой таблице.

Содержите IDТип отверстияОписание

Заголовок

Блок

Section генератор отчетов заполняет это отверстие на основе содержимого на типе содержимого его свойства Title можно следующим образом.

  • Если Title содержимое свойства является вложенным объектом, таким как строка или mlreportgen.domText объект, генератор отчетов Раздела использует SectionTitle генератор отчетов, чтобы отформатировать и сгенерировать встроенное содержимое как заголовок. Это затем добавляет сгенерированное содержимое в отверстие Заголовка. SectionTitle использование генератора отчетов обрабатывает по шаблону, чтобы отформатировать встроенное содержимое.

  • Если его Title содержимое свойства является абзацем или другим объектом блочного уровня, Section генератор отчетов добавляет абзац в отверстие Заголовка.

  • Если его Title содержимое свойства является другим генератором отчетов, Section генератор отчетов добавляет содержимое, сгенерированное генератором отчетов к отверстию Заголовка.

Содержимое

Блок

Содержимое раздела

Разделите стили шаблонов

Раздел обрабатывает стили использования по шаблону, чтобы отформатировать некоторое содержимое. Шаблоны Word задают стили, которые они используют в таблице стилей в default.dotx обработайте файл по шаблону. PDF и шаблоны HTML задают стили в stylesheets/root.css файл в default.pdftx и default.htmt файлы, соответственно. Следующая таблица описывает стили, используемые шаблонами Раздела.

Разработайте имяТип стиляОписание

SectionContent

Символ

Отверстие Содержимого в шаблонах Section1-Section6 задает этот стиль как стиль текста по умолчанию для содержимого, которое заполняет отверстие. Содержимое может задать стили или форматы, которые заменяют стиль по умолчанию.

SectionTitle1 - SectionTitle6

Символ

Отверстие Заголовка в соответствующем шаблоне раздела задает соответствующее имя стиля как стиль по умолчанию для заголовка раздела. Например, отверстие Заголовка в шаблоне Section1 задает SectionTitle1 как имя стиля по умолчанию для заголовка раздела верхнего уровня. Содержимое, добавленное к отверстию Заголовка, может задать форматы или стили, которые заменяют стиль по умолчанию.

SectionTitleHeader

Символ

Верхние колонтитулы страницы Section1 используют этот стиль, чтобы сосредоточить содержимое заголовка.

SectionTitleFooter

Символ

Нижние колонтитулы Section1 используют этот стиль для содержимого нижнего колонтитула.

Разделите шаблоны заголовка

Если содержимое генератора отчетов Section Title свойство является строкой, текстом или другим вложенным объектом, это использует SectionTitle генератор отчетов, чтобы сгенерировать содержимое раньше заполнял отверстие Заголовка в его шаблонах уровня раздела. SectionTitle генератор отчетов в свою очередь использует шаблоны, чтобы отформатировать встроенное содержимое как заголовок. SectionTitle использование генератора отчетов два набора шаблонов для каждого выходного типа, один, чтобы создать иерархически пронумерованные заголовки (1.1, 1.2, 1.2.1, и так далее), другой, чтобы создать непронумерованные заголовки. Каждый набор содержит шесть шаблонов, соответствующих шести уровням разделов что Section генератор отчетов может сгенерировать. Шаблоны находятся в библиотеках шаблонов генератора отчетов Раздела Word, PDF, и файлы шаблона HTML, default.dotx, default.pdftx, и default.htmt, соответственно.

Пронумерованные шаблоны заголовка раздела

Если отчет или Section генератор отчетов указывает, что его заголовки пронумерованы, SectionTitle генератор отчетов использует автоматически пронумерованные шаблоны, чтобы отформатировать встроенное содержимое Section Title генератора отчетов свойство. Заголовки называют SectionNumberedTitleN, где N является уровнем раздела, к которому применяется шаблон. Например, имя шаблона для заголовка раздела верхнего уровня является SectionNumberedTitle1. Каждый шаблон содержит элемент абзаца, который задает тот же стиль, как задан отверстием Заголовка в соответствующем шаблоне уровня раздела, например, SectionTitle1 для заголовка раздела верхнего уровня. Смотрите Стили шаблонов Раздела.

Абзац заголовка содержит следующие отверстия.

  • Отверстие NumberPrefix, чтобы быть заполненным содержимым SectionTitle NumberPrefix генератора отчетов свойство (пустой по умолчанию)

  • Пронумеруйте {...} автоматически разметку, которая заменяется иерархическим номером во время генерации отчета. Разметка автоматического номера отличается для каждого шаблона уровня, чтобы сгенерировать иерархический номер, соответствующий тому уровню.

  • Отверстие NumberSuffix, чтобы быть заполненным содержимым SectionTitle NumberSuffix генератора отчетов свойство (пустой по умолчанию).

  • Отверстие содержимого, чтобы быть заполненным содержимым SectionTitle Content генератора отчетов свойство.

Следующие изображения показывают Word, PDF и шаблоны HTML SectionNumberedTitle1, соответственно. Шаблоны низшего уровня подобны.

  • Word SectionNumberedTitle1 Template

  • Шаблон PDF SectionNumberedTitle1

  • HTML SectionNumberedTitle1 Шаблон

Во время генерации отчета, Section генератор отчетов устанавливает Content свойство SectionTitle генератор отчетов к встроенному содержимому Section Title генератора отчетов свойство. Это не устанавливает NumberPrefix и NumberSuffix свойства. В результате заголовок сгенерирован SectionTitle генератор отчетов состоит значением по умолчанию иерархического номера, сопровождаемого текстом заголовка.

SectionTitle генератор отчетов обеспечивает отверстия NumberPrefix и NumberSuffix, чтобы упростить маркировку заголовков выведенными генераторами отчетов. Например, Chapter генератор отчетов, который выведен из Section генератор отчетов, устанавливает NumberPrefix свойство к Главе в английских локалях. В некоторых восточноазиатских локалях, Chapter генератор отчетов устанавливает NumberSuffix к главе обозначения символа.

Примечание

Если вы настраиваете пронумерованный шаблон раздела, не удаляйте или заменяйте поля SEQ, одним словом, обрабатывают по шаблону или разметка автоматического номера в PDF или шаблоне HTML. Чтобы сгенерировать непронумерованные разделы, используйте Непронумерованные Шаблоны Заголовка Раздела.

Отверстия шаблона SectionNumberedTitle

Всем шаблонам SectionNumberedTitle (Section1 – Section6) описали отверстия в этой таблице.

ID отверстияТип отверстияОписание

NumberPrefix

Встроенный

Префикс, чтобы отобразиться перед номером раздела.

NumberSuffix

Встроенный

Суффикс, чтобы отобразиться после номера раздела.

Содержимое

Встроенный

Содержимое заголовка

Непронумерованные шаблоны заголовка раздела

Если отчет указывает, что текущий раздел использует непронумерованные заголовки, SectionTitle генератор отчетов использует непронумерованные шаблоны, чтобы сгенерировать заголовки раздела. Непронумерованные шаблоны называют SectionTitleN, где N является уровнем раздела, заголовок которого должен быть сгенерирован. Например, шаблон для раздела верхнего уровня называют SectionTitle1. Каждый шаблон содержит элемент абзаца, который задает тот же стиль, как задан отверстием Заголовка в соответствующем шаблоне уровня раздела, например, SectionTitle1, для заголовка раздела верхнего уровня. Смотрите Стили шаблонов Раздела. Абзац заголовка содержит отверстие, чтобы быть заполненным содержимым Content SectionReporter свойство (установленный Section генератор отчетов во время генерации отчета).

Следовать изображения показывают Word, PDF и версии HTML шаблонов SectionTitle1. Шаблоны низшего уровня подобны.

  • Word SectionTitle Template

    Все уровни шаблонов Word SectionTitle имеют то же отверстие содержимого.

  • PDF и шаблон HTML SectionTitle1

  • PDF и шаблоны HTML SectionTitle2 - SectionTitle6

    Эти шаблоны заголовка раздела включают отверстие Содержимого, как в шаблоне SectionTitle1. Каждый из этих разделов задает свой стиль заголовка.

Отверстие шаблона SectionTitle

Все шаблоны SectionTitle (Section1 – Section6) содержат отверстие, описанное в этой таблице.

ID отверстияТип отверстияОписание

Содержимое

Встроенный

Содержимое заголовка

Шаблоны главы

Chapter генератор отчетов, подкласс Section генератор отчетов, использует Section верхний уровень генератора отчетов обрабатывает набор по шаблону, чтобы сгенерировать его содержимое. Это вызвано тем, что сгенерированный Главой раздел почти идентичен сгенерированному Разделом разделу. Однако два типа разделов отличаются по двум отношениям:

  • Заголовок раздела главы содержит слово Глава в английских локалях или эквивалент в других локалях, поддержанных API Отчета. Chapter генератор отчетов включает слово Глава в заголовки путем установки NumberPrefix или NumberSuffix свойства SectionTitle генератор отчетов раньше генерировал заголовок главы.

  • Все сгенерированные Разделом разделы верхнего уровня запускаются на странице 1. В отличие от этого, только первая глава сгенерирована Chapter генератор отчетов запускается на странице 1. Последующие главы продолжают нумерацию страницы из предыдущей главы. Chapter генератор отчетов реализует это поведение программно, таким образом избегая потребности использовать модифицированную версию высокоуровневого шаблона Раздела.

См. шаблон Section1, пронумерованные шаблоны заголовка раздела и непронумерованные шаблоны заголовка раздела

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