Добавление элемента кода JavaScript

Для каждого блока кода в шаблоне создается элемент Код JavaScript.
Ограничение: Значок Создать компонент Элемент Код JavaScript доступен только в шаблонах версии 2.

Об этой задаче

JavaScript может быть как простым аргументом, так и сложным сценарием.
  • Для простых аргументов можно применить сценарий к содержимому элемента, такому как элемент Текст. Дважды щелкните мышью на элементе текста, перейдите на вкладку Выражение сценария и введите сценарий.
  • Для сложных сценариев можно использовать эту задачу, чтобы применить сценарий с помощью элемента исходного кода JavaScript.
Существуют преимущества использования элемента исходного кода JavaScript, а не вкладки выражения сценария для элемента:
  • Сценарии могут повторно использоваться другими пользователями.
  • Можно сгруппировать вычисления, не беспокоясь о порядке их выполнения.
  • Можно создать нормальные и сложные структуры данных, такие как наборы, и постоянно добавлять в них данные.
    Совет: Начиная с Rational Publishing Engine V2.1, можно вызвать функцию, определенную в одном элементе исходного кода JavaScript, из другого исходного кода JavaScript или выражения сценария, указав свойство Библиотечный сценарий для кода сценария. Для того чтобы указать свойство Библиотечный сценарий, откройте панель Свойства элемента Код JavaScript, перейдите на вкладку Особые и включите переключатель Библиотечный сценарий. Дополнительная информация о свойстве Библиотечный сценарий приведена в разделе Свойства элемента кода JavaScript.

Файл JavaScript utils.js включен в файлы установки и в предопределенные файлы компонента Document Builder для использования простого JavaScript, например, для включения текущей даты в выходной отчет.

Для просмотра списка существующих фрагментов кода JavaScript в шаблоне выберите Шаблон > Проверить JavaScript. Откроется панель Поиск со списком элементов, использующих JavaScript. Внутренние фильтры не считаются кодом JavaScript в этом контексте. Внутренние фильтры не отображаются в результатах поиска.

Процедура

  1. Сохраните шаблон перед началом работы с JavaScript.
  2. Из панели Палитра перенесите элемент Код JavaScript Код JavaScript в редактор материалов шаблона.
  3. Щелкните дважды на элементе кода JavaScript.
  4. На вкладке Выражение сценария выберите переменную в дереве для применения кода JavaScript.
  5. Введите исходный код JavaScript, используя один из следующих способов:
    • Напишите сценарий вручную в этом окне
    • Скопируйте сценарий во внешнем редакторе и вставьте его в это окно
    • Выберите Включить сценарий, затем выберите файл в локальной системе, на удаленном сервере или в компоненте Document Builder.
  6. Необязательно: В случае копирования сценария из файла XHTML можно выполнить следующие действия:
    • Включите переключатель Ввод XHTML, чтобы разрешить изменение тегов XHTML в сценарии.
    • Выключите переключатель Ввод XHTML, чтобы удалить все теги XHTML из сценария.
    В случае копирования отформатированного текста или его применения в условиях, необходимо выбрать параметр Ввод XHTML.
    Важное замечание: Недопустимый код XHTML вызывает ошибки создания документов. Перед указанием внесенных изменений проверьте правильность текста XHTML.
  7. Необязательно: В случае создания вывода XHTML на основе шаблона можно изменить следующие действия:
    • Включите переключатель Вывод XHTML для анализа сценария и вывода в виде отформатированного текста.
    • Выключите переключатель Вывод XHTML, чтобы обрабатывать сценарий в виде обычного текста.
    Этот параметр применяется ко всем атрибутам источника данных в выражении. В сценарии недопустимо смешанное применение обычного текста и текста XHTML.

    В случае копирования или создания отформатированного текста необходимо выбрать параметр Вывод XHTML.

  8. После ввода сценария нажмите кнопку Проверить сценарий, чтобы проверить код. Ошибки JavaScript могут привести к неполадкам при создании документа.
  9. Нажмите кнопку OK для сохранения изменений. Блок кода свертывается в элементе. Код можно развернуть для просмотра в редакторе материалов шаблона.

Работа с редактором JavaScript

Используйте редактор JavaScript для работы над сценарием с выделением синтаксиса цветом и помощником по содержимому.

Об этой задаче

Выделение синтаксиса цветом позволяет указать цвета и стиль для вывода исходного кода JavaScript. Для изменения параметров выделения синтаксиса цветом по умолчанию в Document Studio выберите Окно > Параметры > JavaScript > Редактор > Выделение синтаксиса цветом.

Помощник по содержимому предлагает варианты дополнения с учетом контекста текущей строки кода. Для активации помощника по содержимому нажмите клавиши Ctrl + пробел.

Снимок экрана, на котором показан редактор JavaScript.

Процедура

  1. Щелкните дважды на элементе кода JavaScript. Откроется окно Введите исходный код для элемента исходного кода JavaScript.
  2. Необязательно: В случае добавления нового сценария из другого файла выберите Включить сценарий, затем выберите файл в локальной системе, на удаленном сервере или в компоненте Document Builder. Нажмите кнопку OK.

    Копия кода JavaScript из выбранного локального или удаленного файла открывается в редакторе JavaScript.

    Для файлов, выбранных в Document Builder, открывается окно Использовать ссылку в виде сценария. Укажите следует ли добавлять JavaScript в шаблон в качестве ссылки:
    • Если выбрать Да, то ссылка на файл JavaScript (.js) добавляется в тег <Script>. Например, в редактор JavaScript добавляется следующая ссылка, которую не следует изменять:
      <Script src= "library://api/scripts/51"></Script>
      Напоминание: Если документ создается на основе шаблона, содержащего ссылку на JavaScript, то Document Builder должен быть запущен и подключен к Document Studio. Дополнительная информация приведена в разделе Подключение к компоненту Document Builder.
    • Если выбрать Нет, то копия кода JavaScript из выбранного файла открывается в редакторе JavaScript.
  3. Необязательно: Выберите Открыть в редакторе, чтобы ввести сценарий в редакторе JavaScript Eclipse. Сценарий открывается на новой вкладке редактора в качестве временного файла .js. Вы можете изменить JavaScript и управлять сценарием с помощью опций панели Схема. После изменения сценария сохраните изменения и закройте временную вкладку редактора JavaScript, чтобы вернуться к окну Ввести код для элемента Код JavaScript.
  4. Выберите Проверить сценарий, чтобы проверить код.
  5. Нажмите кнопку OK, чтобы сохранить изменения и закрыть окно.