Разработка шаблонов документов

Шаблон документа задает структуру, макет и содержимое отчета. Успешное создание шаблона предусматривает планирование, разработку, тестирование и сохранение шаблона.

Процедура

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

Связанные концепции

1: Сбор требований

Разным потребностям соответствуют разные эскизы. Перед тем как приступить к разработке шаблонов, определите бизнес-потребности и практические требования документа.

Элементы данных
В шаблоны можно добавить различные элементы для отображения информации разных типов. Какая информация требуется пользователям, которые будут просматривать документ? Получив ответ на этот вопрос, можно приступить к выбору элементов данных:
  • В каких элементах шаблона отображаются эти данные? Каким образом они будут выглядеть в окончательной версии документа?
  • Существуют ли разные способы отображения информации? Какой из них оптимальным образом подходит в контексте просмотра документа?
  • Какой требуется объем данных? Ненужные данные можно отфильтровать, чтобы ускорить время создания отчета.
Тип вывода
Какой тип вывода наилучшим образом подойдет пользователям, которые будут просматривать документ? Проектируемый шаблон может выглядеть по-разному для разных типов вывода. Отдельные элементы оптимизированы для отображения в конкретном формате; отдельные элементы поддерживаются не во всех форматах. Ознакомьтесь со способами отображения элементов шаблона в разных форматах вывода. Вы сможете выбрать элементы и тип вывода, которые лучше всего подходят друг другу.
Один шаблон или несколько шаблонов
Шаблон планируется использовать один раз или может потребоваться повторное использование отдельных его фрагментов в других шаблонах?
  • Один шаблон: один шаблон может содержать все фрагменты эскиза документа. Это означает, что все содержимое доступно в одном месте и объединение не требуется.
  • Несколько шаблонов: допустим модульный подход, предусматривающий создание нескольких шаблонов, которые объединяются на этапе создания документа. Например, у вас может быть шаблон оглавления, шаблон первой страницы обложки, шаблон данных, шаблон индекса и шаблон последней страницы обложки. Эти шаблоны можно использовать многократно при генерации различных документов.
Определите, сколько шаблонов необходимо с учетом этих требований. Можно задать имя и описание для каждого блока шаблона в атрибутах метаданных. Содержимое имени отображается в шаблоне, а содержимое описания - в поле подсказки элемента шаблона.
Контекст просмотра
Как пользователи будут просматривать этот документ?
  • Будет ли он печататься и/или просматриваться на экране?
  • Будет ли он открываться в интегрированном продукте?
Связанные концепции

2: Разработайте шаблон

В процессе создания шаблона следующие методики помогают эффективно распределить время.
  • Можно спроектировать шаблон для предоставления свойств специального макета страницы, таких как размер, ориентация и поля страницы, число колонок и стили для типов абзацев, которые с большой вероятностью будут использоваться в документах.
  • Шаблон может содержать:
    • Элементы структуры документа, такие как абзацы, таблицы, списки и оглавление.
    • Блоки макета документа, такие как шаблоны страниц, таблицы стилей, верхние и нижние колонтитулы.
    • Внутренние и внешние пользовательские стили, такие как форматирование текста или абзаца. Форматирование текста включает полужирный шрифт, курсив, подчеркивание, размер шрифта и цвет шрифта. Форматирование абзаца включает поля, границы, отступы и параметры сценария в форме JavaScript.
    • Вложенное содержимое шаблона, такое как изображения, статический текст и ссылки на статические файлы и таблицы стилей.
    • Элементы данных, такие как атрибуты, условия и динамические элементы данных.
    • Извлечение данных в форме запросов и фильтров.
    • Внешние переменные, получающие значения во время выполнения, и внутренние переменные, используемые для вычислений. Создание внешних переменных более предпочтительно по сравнению с жестким кодированием URL источников данных в шаблоне. Если адреса (URL) жестко закодированы, то при изменении имени сервера потребуется адреса во всех шаблонах. Внешние переменные позволяют переопределить адреса во время выполнения. Для шаблонов, встроенных в другие продукты, используйте специальные переменные, которые распознаются этими продуктами, когда они ссылаются на данные.
  1. Запустите Document Studio.
  2. Создайте новый шаблон с нуля или на основе существующего шаблона.
  3. Добавьте схему источника данных.
  4. Добавьте элементы.
  5. Настройте форматирование элементов.
  6. Определите динамическое содержимое.
  7. Необязательно: Уточните данные с помощью фильтров, средств сортировки и условий.

3: Тестирование шаблона

  1. Запустите инструмент проверки.
  2. Откройте шаблон в режиме предварительного просмотра.
Вспомогательная задача:

4: Сохранение шаблона

Следующие действия

После создания и тестирования шаблонов выполните следующие действия:

Комментарии