Шаблоны репортеров

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

Раздел (см. Раздел « Шаблоны»)
Глава (см. главу Шаблонов)

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

Шаблоны разделов

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

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

Шаблон тела раздела с именем Section N, где N является уровнем раздела (см. Section1 Template и Section2 - Section6 Templates).
Пронумерованный шаблон заголовка раздела с именем SectionNumeredTitle N (см. раздел «Шаблоны заголовков нумерованных разделов»).
Ненумерованный шаблон заголовка раздела имеет имена SectionTitle N (см. раздел «Ненумерованные шаблоны заголовка раздела»).

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

Section1 шаблон

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

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

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

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

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

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

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

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

Шаблон Section1 задает нижний колонтитул страницы по умолчанию, идентичный по содержимому и формату первому колонтитулу страницы.
Примечание
Чтобы просмотреть или изменить нижний колонтитул страницы по умолчанию, необходимо вставить страницу в шаблон Section1 следующим образом:
1. Скопируйте шаблон из Section галерея QuickParts шаблона репортера (то есть его библиотека шаблонов) в тело шаблона репортера.
2. Вставьте абзац после отверстия «Содержимое» в шаблон.
3. Включите Page Break Before абзаца свойство.
Шаблон Section1 PDF
Шаблон Section1 PDF находится в библиотеке шаблонов файла PDF репортера Section (default.pdftx). Файл шаблона является zip-файлом. Библиотека шаблонов хранится в файле с именем docpart_templates.html. Чтобы просмотреть или изменить шаблон Section1:
1. Разархивируйте копию default.pdftx файл с использованием Report API unzipTemplate команда.
2. Откройте docpart_templates.html файл в редакторе MATLAB или любом другом текстовом редакторе.
3. Когда вы закончите редактировать шаблон Section1, сохраните docpart_templates.html файл.
4. Переархивируйте default.pdftx файл, с использованием Report API zipTemplate команда.
Для получения дополнительной информации см. раздел «Создание библиотеки шаблонов деталей PDF».
Шаблон PDF Section1 использует следующий HTML разметки, чтобы задать макет страницы PDF раздела верхнего уровня, сгенерированного Section репортер. Разметка также определяет расположение отверстий, которые должны быть заполнены содержимым Section репортёрские Title и Content свойства.

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

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

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

задает горизонтальное правило, за которым следует автоматически сгенерированный номер страницы.
Стили для шаблонов верхнего и нижнего колонтитулов представлены в pdf/stylesheets/root.css файл.
Шаблон Section1 HTML
Шаблон Section1 детали документа в default.htmt файл задает отверстия заголовок и содержимое.

Section2 - Section6 шаблоны

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

Word Section2 - Section6 шаблоны
В качестве примера на этом изображении показан шаблон Section2.
PDF и HTML- Section2 - Section6 шаблоны
В качестве примера на этом изображении показан шаблон Section2.

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

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

Удержание идентификатора	Тип отверстия	Описание
Заголовок	Блок	The `Section` reporter заполняет это отверстие содержимым на основе типа содержимого свойства Title следующим образом. Если на `Title` содержимое свойства является встроенным объектом, таким как строка или `mlreportgen.domText` объект, репортер Section использует `SectionTitle` reporter, чтобы форматировать и сгенерировать встроенное содержимое как заголовок. Затем сгенерированное содержимое добавляется в отверстие заголовок. The `SectionTitle` reporter использует шаблоны для форматирования встроенного содержимого. Если его `Title` содержимое свойства является абзацем или другим объектом уровня блоков, `Section` reporter добавляет абзац в отверстие заголовок. Если его `Title` содержимое свойства другой репортер, `Section` reporter добавляет содержимое, сгенерированное репортером, в отверстие заголовок.
Содержимое	Блок	Содержимое раздела

Стили шаблонов сечений

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

Имя стиля	Тип стиля	Описание
SectionContent	Символ	Отверстие «Содержимое» в шаблонах Section1-Section6 задает этот стиль как стиль текста по умолчанию для содержимого, заполняющего отверстие. Содержимое может задавать стили или форматы, которые переопределяют стиль по умолчанию.
SectionTitle1 - SectionTitle6	Символ	Отверстие Title в соответствующем шаблоне сечения задает соответствующее имя стиля в качестве стиля по умолчанию для заголовка сечения. Например, отверстие Title в шаблоне Section1 задает SectionTitle1 как имя стиля по умолчанию для заголовка раздела верхнего уровня. Содержимое, добавленное к отверстию заголовок, может задавать форматы или стили, которые переопределяют стиль по умолчанию.
SectionTitleHeader	Символ	Заголовки Section1 страниц используют этот стиль для центрирования содержимого заголовка.
SectionTitleFooter	Символ	Нижний колонтитул Section1 использует этот стиль для содержимого нижнего колонтитула.

Шаблоны заголовков разделов

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

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

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

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

Отверстие NumberPrefix, заполняемое содержимым SectionTitle репортёрские NumberPrefix свойство (по умолчанию пустое)
Автоматическая разметка номера, которая заменяется иерархическим номером во время генерации отчета. Разметка автонумерации отличается для каждого шаблона уровня таким образом, чтобы сгенерировать иерархический номер, соответствующий этому уровню.
Отверстие NumberSuffix, заполняемое содержимым SectionTitle репортёрские NumberSuffix свойство (по умолчанию пустое).
Отверстие содержимого, которое должно быть заполнено содержимым SectionTitle репортёрские Content свойство.

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

Шаблон SectionNumberedTitle1 Word
Шаблон SectionNumberedTitle1 PDF
Шаблон SectionNumberedTitle1 HTML

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

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

Примечание

Если вы настраиваете нумерованный шаблон раздела, не удаляйте и не заменяйте поля SEQ в шаблоне Word или разметку в формате PDF или HTML. Для создания ненумерованных разделов используйте «Ненумерованные шаблоны заголовков разделов».

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

Все шаблоны SectionNumeredTitle (Section1 - Section6) имеют отверстия, описанные в этой таблице.

Идентификатор отверстия	Тип отверстия	Описание
NumberPrefix	Действующий	Префикс для отображения перед номером раздела.
NumberSuffix	Действующий	Суффикс для отображения после номера раздела.
Содержимое	Действующий	Содержимое заголовка

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

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

На следующих изображениях показаны версии шаблонов SectionTitle1 в формате Word, PDF и HTML. Шаблоны нижнего уровня аналогичны.

Шаблон Word SectionTitle
Все уровни шаблонов Word SectionTitle имеют одно и то же отверстие содержимого.
PDF и HTML- SectionTitle1 шаблон
PDF и HTML- SectionTitle2 - SectionTitle6 шаблоны
Эти шаблоны заголовков разделов включают отверстие содержимое, как в SectionTitle1 шаблоне. Каждый из этих разделов задает стиль заголовка.

Отверстие шаблона заголовка раздела

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

Идентификатор отверстия	Тип отверстия	Описание
Содержимое	Действующий	Содержимое заголовка

Шаблоны глав

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

Заголовок раздела главы содержит слово Chapter in English locales или эквивалентное в других локалях, поддерживаемых Report API. The Chapter reporter включает слово Chapter в заголовки путем установки NumberPrefix или NumberSuffix свойства SectionTitle reporter используется для генерации заголовка главы.
Все сгенерированные разделы верхнего уровня начинаются на странице 1. Напротив, только первая глава, сгенерированная Chapter репортер запускается на странице 1. Последующие главы продолжают нумерацию страниц из предыдущей главы. The Chapter репортер реализует это поведение программно, таким образом избегая необходимости использования измененной версии шаблона верхнего уровня Section.

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

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