资源的文档

除了查看资源之外,您可能需要为您正在构建的应用程序提供文档。WebSphere® Integration Developer 提供了一个工具来为模块、调解模块和库中的资源生成文档。

可以通过调用一个向导来开始生成文档。可以通过从一个或多个模块和库中选择多个资源来定制文档的内容,以便将所有信息写入单个报告中(该报告是一个 PDF 文件)。还可以指定输出的布局和字体。请参阅相关任务以获取如何生成文档的详细指示信息。

资源文档

文档生成器将生成有关这些资源的以下信息:

文档生成器将不会生成其他资源。

引用的文件

文档生成器还可以为所选择的资源它们引用的资源生成文档。例如,在“文档生成”向导中,可以选择业务流程和包括引用的文件选项。因此,生成的 PDF 报告中还将具有关于流程引用的资源(例如,由特定流程的活动调用的接口)的信息。

文档结构

生成的 PDF 报告具有以下结构:

  • 标题页面

    具有报告标题、作者姓名和报告日期。

  • 目录

    列示报告中的节号和页码。

  • 资源文档部分

    列示资源的属性。除了模块和库之外,所有资源的图片都会在“编辑器”视图中打开。

  • 交叉引用

    对于生成的每个资源,列示了哪些资源使用它(提供者列表)和在何处使用它(接收方列表)。

  • 附录:文档生成设置

    列示在“文档生成”向导中指定的并且用于 PDF 报告的文档生成设置。

文档布局和样式

可以使用“文档生成”向导来定制所生成的 PDF 报告的布局和样式。如果您更改布局和样式设置,则会保存这些设置并将它们用于所有后续的文档生成,直到再次更改它们为止。

可以修改下列布局设置:

  • 页面大小

    定义生成的文档的页面大小。

    缺省值:Letter

  • 目录级别

    定义要列示在报告的目录中的主题的最高级别。

    缺省值:7

  • 字体
    定义输出的字体系列、字体大小和字体样式。缺字体设置为:
    • 纯文本

      • 用于各个工件的描述和文档。纯文本的字体系列也用于标题页面、标题和页脚。
      • 缺省字体系列:Helvetica
      • 缺省字体大小:10
      • 缺省字体样式:常规
    • 章节标题

      • 用于带有编号的标题、目录的标题和附录的标题
      • 缺省字体系列:Helvetica
      • 缺省字体大小:14
      • 缺省字体样式:粗体
    • 源代码文本

      • 用于源代码(例如,Java™)的文档
      • 缺省字体系列:Courier
      • 缺省字体大小:10
      • 缺省字体样式:常规
    • 文字说明文本

      • 用于图像的文字说明
      • 缺省字体系列:Helvetica
      • 缺省字体大小:10
      • 缺省字体样式:粗体
    • 定义文本

      • 用于键/值对的文档
      • 缺省字体系列:Helvetica
      • 缺省字体大小:10
      • 缺省字体样式:常规
    • 标题文本

      • 用于未编号的标题
      • 缺省字体系列:Helvetica
      • 缺省字体大小:11
      • 缺省字体样式:粗体
    • 目录

      • 用于目录
      • 缺省字体系列:Helvetica
      • 缺省字体大小:9
      • 缺省字体样式:常规

用来保存设置的主文件

主文件是一个资源概要文件,它定义了要包括在生成的文档中的内容(不是字体样式)。当使用“文档生成”向导时,创建一个主文件来保存您的资源选择,当您下一次使用该向导来生成相同的报告时,只需选择该主文件即可。

注册新字体

文档生成器提供了可在文档中使用的三种缺省字体。这些字体是:Helvetica、Courier 和 Times,它们的字体样式为:常规、斜体、粗体和粗斜体。

可以通过注册新字体的方式来添加新字体,它们可以是 True Type 字体文件(.ttf)或 True Type 集合文件(.ttc)。字体注册是在“文档生成”向导中完成的。一旦注册了字体,就可以将它用于所有报告,直到除去它为止。不能除去缺省字体。有关如何使用“文档生成”向导的指示信息,请参阅相关任务中的“生成文档”。

注: 在“文档生成”向导中,已注册的字体的名称(包括双字节字符集字体名称)仅以拉丁字母显示。

跟踪文件

文档生成器可以将文档生成跟踪消息写入跟踪文件中。注意:除非文档生成器发生了问题,否则不要打开此跟踪功能,这是因为进行跟踪会影响系统性能并且会占用许多磁盘空间。跟踪是在“首选项”窗口中设置的,而输出将被写入 metadata 目录(workspace-name\.metadata\.plugins\com.ibm.wbit.reporting.infrastructure\trace\)中的一个文本文件。将追加日志条目,并且决不会擦除。

相关概念
模块和库
模块和库依赖性
业务集成能力和角色
业务集成备忘单
相关任务
创建业务服务模块
创建调解模块
更改缺省名称空间
启用工具能力
对模块和库添加依赖性
创建库
生成文档

相关信息

教程:使用模块和库

反馈
(C) Copyright IBM Corporation 2005, 2006. All Rights Reserved.