使用 developerWorks XML 验证工具

适合作者创作在 developerWorks上发表的文章和教程的可选工具

如果您找不到自己喜欢的 XML 验证编辑器或者不愿意花时间学习,那么您可以使用您偏好的文档编辑器来编辑 XML developerWorks 文章和教程。本文的作者开发了很好的工具来帮助您验证、转换和预览您的文章或者教程。本文展示了在 Microsoft® Windows® 或 Linux® 中使用这些工具有多么简单。

编 辑, developerWorks, EMC

本内容由 developerWorkds 的编辑提供。



2010 年 9 月 13 日

开始

创作一篇在 developerWorks 上发表的文章或者教程包括以下步骤:

  1. 下载文件制作工具包并解压缩。
  2. 复制文章或者教程的 XML 模板。
  3. 编辑 XML 模板,以添加您的内容,然后根据模式验证 XML 并纠正错误。
  4. 在浏览器中预览您的文章或者教程,获知它在 developerWorks 网站上的显示效果。

首先阅读并完成文章 “使用 developerWorks XML 模板写作” 中的第 1 步和第 2 步。这篇文章详细介绍了怎样下载您所需的工具和文件。其中还详细介绍了如何写作和提交文章的详细信息。

然后,当您完成了第 1 步和第 2 步,回到本文。您将下载文件制作工具包,并解压到您的机器中。接着,用上篇文章中描述的新教程或者新文章工具复制一个模板。到这里,您就可以按照下面的说明完成剩下的步骤:编辑、验证和预览您的内容。


使用 Microsoft Windows

您需要:

  • 一个能够保存纯文本文件的文本编辑器或文字处理软件。虽然不是必需的,但是由于在验证阶段发现的错误是按行号报告的,所以编辑器能够显示行号是非常方便的。 如果您选中了View > Status Bar 菜单项,Windows XP 中的记事本(Notepad)可以显示行号。注意:早期版本的 Windows 中,记事本的这个菜单项是不可用的。
  • 最新版本的 Microsoft XML 解析器(MSXML),本文中指的是 MSXML 4.0 Service Pack 2(Microsoft XML Core Services)。(要获取解析器,请参阅 参考资料 中的链接。)使用 msxml.msi 链接安装 MSXML 4.0 SP2 和 SDK。 您也可以先将 maxml.msi 保存到您的电脑,稍后再安装。
  • Internet Explorer Version 6 或其他 Web 浏览器,例如 Mozilla、Firefox、Opera。

第 1 步. 编辑 XML 文件

使用您喜欢的文本编辑器浏览新建的文件夹并编辑文件(index.xml)。如果没有其他偏好的编辑器,您可以使用记事本。index.xml 模板文件中的详细注解可以帮助您了解需要做什么。

如果您使用文字处理软件,请确保您的文件是以纯文本格式保存的。同样,如果您把含有格式的文本(例如 Microsoft Word 文件)剪切和粘贴到您的编辑器,也需要确保将 XML 文件保存成纯文本格式。不要改变 index.xml 的文件名,不要编辑使用我们的工具生成的 HTML 文件(index.html),因为 developerWorks 编辑将只会处理 XML 版本。保存您为文章或教程创建的目录(示例中的 my-article)中的所有图片,例如照片或者屏幕快照。

第 2 步. 验证 XML

编辑文章和教程时,您需要根据模式验证 XML。如果您对 XML 不是特别熟悉,我们建议您随时验证文件。这样将更容易发现错误。

创建新文章或教程时,验证 XML 的工具将安装到您的项目目录里。单击您的文章或教程目录中的 dw-transform.vbs 脚本。根据您的 Windows 设置情况,此文件可能仅显示为 dw-transform。此时您将看到图 1 所示的窗口 。

图 1. 用 dw-transform 脚本验证您的文章
用 dw-transform 脚本的验证

第 3 步. 纠正验证出的问题

如果您发现了一个 XML 编码错误,您将看到一个输出错误。使用 dw-transform 脚本时,您应看到一个如图 2 所示的窗口。

图 2. 有问题的文章(VB 脚本检查器)
有问题的文章(VB 脚本检查器)

在这个例子中,我们特意包含了 <u>加下划线的短语</u>,从而引入了一个错误。由于链接是加下划线的,所以在 developerWorks 文章和教程中我们不能把下划线文本用作其他用途。因此模式不允许使用 <u></u> 标签。工具会标记第一个错误出现的位置,并给出错误原因。而这些错误原因是由 MSXML 解析器生成的。尽管有点含糊,但它们通常能帮助您定位问题。如果原因中包含 Expecting a, b, br, ... 等一长列其他标记名,您可能是漏写了一个标记名或者是使用了不被 developerWorks 模式支持的标记(前面的例子正是这种情况)。显示行号的编辑器能帮助您快速找到错误。请参见图 3。

图 3. 使用记事本定位 XML 中的错误
使用记事本定位 XML 中的错误

查找和更正完错误之后,保存文件并运行 dw-transform.vbs 以再次验证。重复这个过程,直到不再出现错误。

第 4 步. 预览您的文章或教程

不再出现错误时,您就可以预览您的文章或教程在 developerWorks 中的效果。您的目录中会有一个名为 index.html 的文件。用您的浏览器打开并预览这个文件。如果您使用的是 Windows XP Service Pack 2 中的 Internet Explorer,您可能会看到一个弹出窗口和一个信息栏:Internet Explorer 已经限制此文件显示可能访问您的计算机的活动内容。单击信息栏并选择允许阻止的内容...预览您的文章或教程。

图 4. 预览您的文章
预览您的文章

注意:

  • 有些样式表位于服务器上,所以您预览的格式可能和 developerWorks 工作人员生成、发布在服务器上的有一些出入。
  • 最终发布的教程是一些分开的页面,但预览时教程在一个独立的页面上。在这个页上,可以看到每个新段从哪里开始。然而,教程左导航区和教程内容的交叉链接在预览时不起作用。developerWorks 工作人员会纠正这些分页和链接问题。

后续步骤

祝贺您!您已经完成了文章或教程的编辑、验证和预览。 现在,回到 “使用 developerWorks 模板写作”,完成并提交您的内容给您的 developerWorks 编辑。


使用 Linux 或者其他操作系统

您需要:

  • 一个能够保存纯文本文件的文本编辑器或文字处理软件。虽然不是必须的, 但是由于在检查阶段发现的错误是按照行号报告的,所以编辑器能够显示行号将非常方便的。许多 Linux 和 UNIX® 编辑器(包括 viemacs)都能够显示行号。
  • 一个 1.4 或更高版本的 Java 运行时或开发工具包。我们推荐使用 IBM Runtime Environment for Java 2(JRE)。因为它包含必需的 Xalan 和 Xerces 功能。并且能够随其他 Java 实现一起安装。请参阅本文 参考资料 内容中的下载链接。如果您使用其他的 Java 运行时或开发工具包,还需要 Apache Xalan Version 2.6 package(它包含Xerces 函数)。您还需要更改 developerworks/tools/dwxmlxslt.sh 脚本或设置 CLASSPATH 环境变量。
  • 一个图形化浏览器,例如 Mozilla、Firefox、Opera。

第 1 步. 编辑 XML 文件

使用您喜欢的文本编辑器浏览新建的文件夹并编辑 XML 文件。根据 index.xml 文件中的详细注释操作。如果您使用文字处理软件,请确保您的文件是以纯文本格式保存的。 不要更改变 index.xml 的文件名。在为文章或教程(本例中的 my-tutorial)创建的目录中保存所有图片,例如照片或者屏幕快照。

第 2 步. 验证 XML

编辑文章和教程时,您需要根据模式验证 XML 的更改。如果您是 XML 新手,我们建议您随时验证您的文件。这样更容易发现错误。

创建新的文章或教程时,验证 XML 的工具将安装到您的项目目录中。 运行您的目录中的 dw-transform.sh 脚本。 如果您运行了 KDE 或者 GNOME 桌面,您会在一个像 Nautilus 或者 Konqueror 的图形管理器中运行;否则应在一个终端窗口中运行。

如果一切正常,几分钟后,您将会看到一个如图 5 所示的消息框。

图 5. 用 dw-transform shell 脚本验证您的教程
用 dw-transform shell 脚本验证您的教程

第 3 步. 纠正验证出的错误

如果发现了一个 XML 编码错误,您将看到如图 6 所示的消息框。

图 6. 一篇有错的教程(shell 脚本检查程序)
一篇有错的教程(shell 脚本检查程序)

在这个例子中,我们特意包含了 <u>加下划线的短语</u>,从而引入了一个错误。由于链接是加下划线的,所以在 developerWorks 文章和教程中我们不能把下划线文本用作其他用途。因此模式不允许使用 <u></u> 标签。工具会标记第一个错误出现的位置,并给出错误原因。而这些错误原因是由 MSXML 解析器生成的。尽管有点含糊,但它们通常能帮助您定位问题。如果原因中包含 Expecting a, b, br, ... 等一长列其他标记名,您可能是漏写了一个标记名或者是使用了不被 developerWorks 模式支持的标记(前面的例子正是这种情况)。显示行号的编辑器能帮助您快速找到错误。请参见图 7。

图 7. 使用 gedit 编辑器定位教程中的错误
使用 gedit 编辑器定位教程中的错误

查找和更正完错误之后,保存文件并运行 dw-transform.vbs 以再次验证。重复这个过程,直到不再出现错误。

注意:

  • 有些错误,例如正确的开始标记没有匹配的结束标记,可能会产生不提示行号的错误。验证时经常出现这种错误。
  • 如果您在文章或教程中使用制表符缩进,那么编辑器中显示的行号可能与报告错误的行号不匹配。

第 4 步. 预览您的文章或教程

不再出现错误时,您就可以预览您的文章或教程在 developerWorks 网站上的效果。 您的目录中会有一个名为 index.html 的文件。 用您的浏览器打开这个文件预览您的文章或教程。

图 8. 预览您的教程
预览您的教程

注意:

  • 有些样式表位于服务器上,所以您预览的格式可能和 developerWorks 工作人员生成、发布在服务器上的有一些出入。
  • 最终发布的教程是一些分开的页面,但预览时教程在一个独立的页面上。在这个页上,可以看到每个新段从哪里开始。然而,教程左导航区和教程内容的交叉链接在预览时不起作用。developerWorks 工作人员会纠正这些分页和链接问题。。

后续步骤

祝贺您!您已经完成了文章或教程的编辑、验证和预览。 现在,回到 “使用 developerWorks XML 模板写作”,完成并提交您的内容给您的 developerWorks 编辑。

参考资料

学习

获得产品和技术

  • Microsoft XML 解析器(MSXML):为了使用 dw-transform.vbs 脚本来转换您的文章或教程,您需要最新版本的 MSXML 解析器。还需要 msxml.msi 文件。
  • IBM Developer Kit for Java, Version 1.4.2:在 Linux 中使用 dw-transform.sh 脚本转换您的文章或教程,您需要版本 1.4.2 或更新的 IBM Developer Kit for Java。
  • Apache Xalan:如果您使用 Linux 工具(dw-transform.sh)并且没有用 IBM Developer Kit for Java,您可能需要 Apache Xalan。
  • 可下载的 IBM 试用软件:使用IBM 试用软件构建您的下一个开发项目,这些软件可以从 developerWorks 直接下载。

讨论

条评论

developerWorks: 登录

标有星(*)号的字段是必填字段。


需要一个 IBM ID?
忘记 IBM ID?


忘记密码?
更改您的密码

单击提交则表示您同意developerWorks 的条款和条件。 查看条款和条件

 


在您首次登录 developerWorks 时,会为您创建一份个人概要。您的个人概要中的信息(您的姓名、国家/地区,以及公司名称)是公开显示的,而且会随着您发布的任何内容一起显示,除非您选择隐藏您的公司名称。您可以随时更新您的 IBM 帐户。

所有提交的信息确保安全。

选择您的昵称



当您初次登录到 developerWorks 时,将会为您创建一份概要信息,您需要指定一个昵称。您的昵称将和您在 developerWorks 发布的内容显示在一起。

昵称长度在 3 至 31 个字符之间。 您的昵称在 developerWorks 社区中必须是唯一的,并且出于隐私保护的原因,不能是您的电子邮件地址。

标有星(*)号的字段是必填字段。

(昵称长度在 3 至 31 个字符之间)

单击提交则表示您同意developerWorks 的条款和条件。 查看条款和条件.

 


所有提交的信息确保安全。


static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=10
Zone=XML
ArticleID=195189
ArticleTitle=使用 developerWorks XML 验证工具
publish-date=09132010