添加 JavaScript 代码元素

对您在模板中使用的每个代码块使用 JavaScript 代码元素。
限制: “新功能”图标 JavaScript 代码元素只在 V2 模板中提供。

关于此任务

JavaScript 的范围从简单参数到复杂脚本。
  • 对于简单参数,可以将脚本应用于元素(例如文本元素)的内容。双击文本元素,选择脚本表达式选项卡,然后输入脚本。
  • 对于复杂脚本,可以使用此任务通过使用 JavaScript 代码元素来应用脚本。
与使用元素的“脚本表达式”选项卡相比,使用 JavaScript 代码元素具有下列优点:
  • 可以复用其他用户的脚本。
  • 可以将计算分组,而不用担心它们的执行顺序。
  • 可以创建常规和复杂数据结构(例如集合)并不断地向它们添加。
    提示:Rational® Publishing Engine V2.1 发行版开始,可以通过在脚本代码中设置库脚本属性,在一个 JavaScript 代码或脚本表达式中调用另一个 JavaScript 代码元素中定义的函数。要设置库脚本属性,请转至 JavaScript Code 元素的属性视图,选择特定选项卡,然后选中库脚本复选框。有关库脚本属性的更多信息,请参阅 JavaScript 代码元素属性

JavaScript 文件 utils.js 包括在安装文件及预定义的文档构建器组件文件中,供您用于简单 JavaScript(例如在报告输出中包括当前日期)。

要查看模板中现有 JavaScript 代码的列表,请单击模板 > 复审 JavaScript。这时,会打开“搜索”视图并显示使用 JavaScript 的元素的列表。在此上下文中,不会将本机过滤器视为 JavaScript。搜索结果中不会列出本机过滤器。

过程

  1. 在开始使用 JavaScript 之前,请保存您的模板。
  2. 在“选用板”视图中,选择 “JavaScript 代码”图标 JavaScript 代码元素,然后将该元素拖到模板内容编辑器。
  3. 双击 JavaScript 代码元素。
  4. 在“脚本表达式”选项卡中,从树中选择一个变量以向其应用 JavaScript 代码。
  5. 使用下列其中一个选项来输入 JavaScript 代码:
    • 在此窗口中手动编写脚本
    • 将编辑器外部的脚本复制并粘贴到此窗口
    • 单击包括脚本,并从您的计算机、远程服务器或者文档构建器组件中选择一个文件
  6. 可选: 如果从 XHTML 中复制了脚本,那么可以执行下列操作:
    • 选择 XHTML 输入选项,以允许编辑脚本中所包含的 XHTML 标记。
    • 清除 XHTML 输入选项以从脚本中除去所有 XHTML 标记。
    如果您正在复制富文本或者正在条件中使用富文本,那么必须选择 XHTML 输入选项。
    要点: 无效 XHTML 会导致无法生成文档。在保存更改之前,请验证 XHTML 是否有效。
  7. 可选: 如果将模板生成为 XHTML 输出,那么可以执行下列操作:
    • 选择 XHTML 输出选项以解析脚本并将脚本呈现为富文本格式文本。
    • 清除 XHTML 输出选项以将脚本作为纯文本加以处理。
    此选择会应用到表达式中的所有数据源属性。不能在脚本同时使用纯文本和 XHTML。

    如果正在复制富文本格式文本或者临时创建富文本格式文本,那么必须选择 XHTML 输出选项。

  8. 输入脚本之后,单击测试脚本以验证代码。 如果 JavaScript 中存在错误,那么可能未成功完成文档生成。
  9. 单击确定以保存更改。 代码块可在元素中折叠。可以展开代码以在模板内容编辑器中查看代码。

在 JavaScript 编辑器中工作

使用 JavaScript 编辑器并利用语法着色和内容辅助来处理脚本。

关于此任务

语法着色指定 JavaScript 源代码如何按它自己的颜色和样式来呈示。要更改缺省语法颜色首选项,在 Document Studio 中选择窗口 > 首选项 > JavaScript > 编辑器 > 语法着色

内容辅助在弹出窗口中显示用于完成当前代码行的有效替代方法的列表。要激活内容辅助,请按 ALT + /

这是 JavaScript 编辑器的截屏。

过程

  1. 双击 JavaScript 代码元素。JavaScript 代码元素的输入代码”窗口将打开。
  2. 可选: 如果要包括来自另一个文件的新脚本,请单击包括脚本,然后从您的计算机、远程服务器或者文档构建器组件中选择一个文件。单击确定

    对于从您的计算机或者远程服务器选择的文件,所选文件中的 JavaScript 代码的副本将在 JavaScript 编辑器中打开。

    对于从文档构建器中选择的文件,“使用脚本引用”窗口将打开。您必须选择是否包括 JavaScript 作为模板中的参考链接:
    • 如果您选择,那么指向 JavaScript (.js) 文件的链接会嵌入在 <Script> 标记中。例如,以下参考链接已添加到 JavaScript 编辑器中,不得进行修改:
      <Script src= "library://api/scripts/51"></Script>
      切记: 当您运行根据模板生成文档时,并且您将 JavaScript 作为模板中的参考链接,文档构建器必须已启动并且已连接至 Document Studio。有关详细信息,请参阅连接至文档构建器组件主题。
    • 如果您选择,那么所选文件中的 JavaScript 代码的副本将在 JavaScript 编辑器中打开。
  3. 可选: 单击在编辑器中打开以在 Eclipse JavaScript 编辑器中输入脚本。 这时,脚本会作为临时 .js 文件在新的编辑器选项卡中打开,以便您可以编辑 JavaScript 以及通过“大纲”视图中的选项来管理脚本。在编辑脚本之后,保存您所作的更改,关闭临时 JavaScript 编辑器选项卡以返回到“输入 JavaScript 代码元素的代码”窗口。
  4. 单击测试脚本以验证代码。
  5. 单击确定以保存更改并退出窗口。