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

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

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

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

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

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

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

Шаблон Section1

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

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

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

  • Word Section1 Template

    Шаблон Word Section1 находится в галерее QuickParts файла шаблона default.dotx генератора отчетов Section. Галерея 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. Разметка также задает местоположение дыр, чтобы быть заполненной содержимым свойств Title и Content генератора отчетов Section.

    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 используют этот стиль для содержимого нижнего колонтитула.

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

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

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

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

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

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

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

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

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

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

  • Word SectionNumberedTitle1 Template

  • Шаблон PDF SectionNumberedTitle1

  • HTML SectionNumberedTitle1 Шаблон

Во время генерации отчета генератор отчетов Section устанавливает свойство Content генератора отчетов SectionTitle к встроенному содержимому свойства Title генератора отчетов Section. Это не устанавливает свойства 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, для заголовка раздела верхнего уровня. Смотрите Стили шаблонов Раздела. Абзац заголовка содержит дыру, чтобы быть заполненным содержимым свойства SectionReporter's Content (установленный генератором отчетов 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, пронумерованные шаблоны заголовка раздела и непронумерованные шаблоны заголовка раздела

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