使用IBM Rational Web Developer编写developerWorks内容

在你开始前

关于本教程

本教程描述了为developerWorks轻松编写内容的过程,特别着重于生产力。 该过程包括为您的文章或教程创建模板,然后进行编辑,验证,预览和导出。 在整个教程中,您将找到有关IBM Rational Web Developer的若干功能的相关信息,以使您从产品的角度更好地理解这些步骤。

尽管本教程仅提及IBM Rational Web Developer,但是其他IBM Rational Software Development Platform产品(例如IBM Rational Application Developer和IBM Rational Software Architect)以相同的方式提供相同的功能。

目标

在完成本教程之后,您将可以轻松编写带有developerWorks XML模板的文章和教程。 您还将了解由IBM Rational Web Developer代表的IBM Rational软件开发平台的一些有用功能。

先决条件

本教程适合具有一般XML知识的作者。 对XML,Rational工具和IBM developerWorks作者包的更多了解将帮助作者最大程度地利用这三者的共同利益。

系统要求

为了遵循本教程中描述的步骤,您需要安装用于WebSphere Software的Rational Web Developer,用于WebSphere软件的Rational Application Developer或Rational Software Architect。 如果您还没有任何版本的副本,请下载WebSphere Web V6.0Rational Web Developer的免费试用版或WebSphere V6.0的 Rational Application Developer的免费版本。

如何运作?

图1中的图表示创作过程的工作流程中的活动顺序。

图1.工作流程
工作流程

这些活动分为两组:

  1. 准备环境

    请按照以下步骤准备您的机器以进行首次创作。 完成此操作后,您可以在以后的developerWorks文章和教程中重复使用相同的设置。

    1. 创建一个工作区或使用现有的工作区
    2. 为工作区启用XML功能
    3. 切换到“资源”透视图。
    4. 下载作者包项目并将其导入到工作区中。
  2. 进行创作活动

    每次为developerWorks撰写文章或教程时,您都需要完成这些步骤。 这些步骤介绍了如何编辑,预览和导出工作。

    1. 为您的文章或教程创建XML模板
    2. 编辑XML模板以添加您的内容,然后根据模式验证该XML并更正所有错误。
    3. 在内置或外部浏览器中预览文章或教程。
    4. 导出您的文章或教程以及所有使用的资源(图像和文件)。

以下两节描述了每个步骤的详细信息。 根据您对该工具的熟悉程度,可以跳过部分或全部“准备环境”“执行创作活动”部分。 另一方面, “ IBM Rational Web Developer的有用功能”部分向您介绍了可用于提高生产率的若干功能。

1.准备环境

一个。 创建一个工作区

启动Rational Web Developer时,“工作空间启动器”对话框会提示您输入工作空间名称。 如果您希望使用现有的工作空间,则可以在此处提供。 否则,您可以提供一个新名称来创建一个新的工作区。

图2.创建一个工作空间
工作区创建

新的工作空间显示“欢迎”视图,并为初次用户提供指向不同Rational Web Developer资源的快捷方式。 您可以关闭该视图并继续阅读本文。

b。 启用XML功能

要为工作空间启用XML功能,请选择Window> Preferences ,如图3所示。

图3.打开“首选项”对话框
首选项对话框

在左侧窗格中,展开“ 工作台”节点,然后选择“ 功能” 。 在右侧窗格中检查XML Developer ,然后单击OK

图4.启用XML功能
启用XML功能
C。 切换角度

此任务是绝对可选的。 它仅包含在此处,以确保您完全按照本文中的描述查看菜单。 要切换到资源透视图,请单击突出显示的按钮,然后选择其他...。 如果您已经看到Resource而不是J2EE,如图5所示,则无需执行此步骤。

图5.打开“选择透视图”对话框
选择视角

选择资源 ,然后单击确定

图6.切换到资源透视图
资源角度
d。 导入作者包项目

从developerWorks 下载作者包项目后,您需要通过选择File> Import将它导入到工作区中。

图7.导入文件
文件导入

选择项目交换 ,然后单击下一步

图8.导入对话框
导入对话框

浏览文件系统,以输入从developerWorks下载的作者包项目的完整路径。 检查developerWorks作者包 ,然后单击完成

图9.导入项目交换内容对话框
导入项目交换内容对话框

2.进行创作活动

一个。 创建一个模板

要为您的文章或教程创建XML模板,请展开developerWorks作者软件包,然后双击文章模板的new-article或教程模板的new-tutorial 。 将.vbs文件用于Microsoft®Windows®平台,将.sh用于基于UNIX®的操作系统。

图10.模板创建对话框
模板创建

将我的文章或我的教程替换为文章或教程的标题。

要查看为您的文章或教程创建的文件夹,请右键单击developerWorks Author Package,然后从上下文菜单中选择Refresh 。 否则,只需在选择developerWorks Author Package时按F5。

图11.刷新以查看模板文件夹
刷新以查看模板文件夹
图12.刷新后出现模板文件夹
刷新后出现模板文件夹
b。 编辑和验证XML模板

这项活动是您发挥创造力的游乐场。 幸运的是,IBM Rational Web Developer提供了一些有用的功能,使您可以专注于内容本身,而不是如何编写内容。 我在这里列出了其中一些功能:

  1. 不同的XML编辑器
  2. 源格式
  3. 拼写检查
  4. 查找和替换
  5. 比较和替换本地历史记录
  6. 团队发展
  7. 导入插图
  8. 源概述
  9. 源代码助手

有关使用每个功能的更多详细信息,请参阅“ IBM Rational Web Developer的有用功能 ”。

在修改模板时,需要验证您没有犯过XML错误。 第一道防线是XML Source Page编辑器的自动验证,它会在所有不正确的标记下划线并标记包含该标记的行。

图13.突出显示的错误
突出显示的错误

如果您错过此提示,则只需在Navigator视图中右键单击模板文件,然后选择Validate XML FileRun Validation

图14.运行验证
运行验证

如果文件具有任何无效标记,则会显示图15中的错误消息。

图15.错误消息
错误信息

此外,“问题”视图显示文件中发现的错误的列表。 如果单击列表上的任何项目,编辑器将显示出现错误的代码行。

图16.问题清单
问题清单
C。 预览您的作品

要预览您的工作,请使用作者包随附的可扩展样式表语言(XSL)样式表将XML文件转换为HTML。 为此,在Navigator视图中右键单击index.xml,然后选择Run> XSL Transformation

图17.使用内置的XSLT将XML转换为HTML
将XML转换为HTML

转换的结果是,在与index.xml相同的文件夹下创建了_index_transform.html文件。 双击该HTML文件以在默认的系统浏览器或编辑器中将其打开。 否则,您可以在内置的Web浏览器中对其进行浏览:右键单击HTML文件,然后选择Open With> Web Browser

图18.预览工作
预览您的作品

内置的浏览器可以帮助您避免在系统上使用浏览器时可能收到的安全警告,而不必同时更改两者。 如果您是脱机工作,则预览页面与最终外观略有不同,因为它引用了developerWorks Web服务器上的资源。 但是,这不应该影响您的工作。

图19.离线显示时,页面看起来略有不同
离线时页面看起来略有不同
d。 导出工作

developerWorks团队需要您在文章或教程中引用的XML文件,任何插图以及任何示例代码。 选择index.xml以及您引用的任何其他图像,然后右键单击并从上下文菜单中选择“ 导出 ”。

图20.导出文件
导出文件

选择Zip文件 ,然后单击下一步

图21.导出对话框
导出对话框

验证选定的文件,指定zip文件的名称,然后单击Finish

图22.导出到一个zip文件
导出到zip文件

IBM Rational Web Developer的有用功能

一世。 不同的XML编辑器

右键单击XML模板文件index.xml并从上下文菜单中选择“ 打开方式”时 ,您将看到内置XML编辑器的列表。 如果您已经在使用外部XML编辑器,则只需从上下文菜单中选择“ 系统编辑器 ”(前提是XML文件已在操作系统级别与该外部编辑器相关联)。 当然,如果愿意,可以选择“ 文本编辑器”来使用纯文本编辑 。 您可能希望查看列表中的每个编辑器,以确定最适合您的编辑器。

图23.可用的不同XML编辑器
提供不同的XML编辑器

本文使用XML源页面编辑器,它提供了彩色标签视图,以便在编辑时具有更好的可读性。 正如我在编辑和验证XML模板中提到的那样,该编辑器提供了清晰的错误指示。 此外,它提供了源代码助手中描述的流行的代码辅助功能。

图24.在XML Source Page Editor中打开的文件
XML源页面编辑器
ii。 源格式

为了进一步提高可读性,请右键单击XML文件中的任意位置,然后选择格式 。 这种格式修改了每个标签的缩进,以反映其在文件的XML结构中的嵌套级别。

图25.源格式
源格式

注意:避免格式化<abstract>和<abstract-extended>标记的内容。

iii。 拼写检查

您可以通过在XML文件中闪烁的光标选择“ 编辑”>“拼写检查”来检查整个文章或教程的拼写 。 如果要从特定位置开始,只需将闪烁的光标指向该位置并开始拼写检查即可。

图26.拼写检查
拼写检查

“拼写检查”对话框打开,并且每当遇到拼写错误时,该行就会突出显示。

图27.“拼写检查”对话框
拼写检查对话框
iv。 查找和替换

提供了高级查找和替换功能,例如换行搜索。 这些功能对于编辑XML文件很有帮助。

图28.查找/替换对话框
查找替换对话框
v。比较和替换本地历史记录

要将更改与以前的版本进行比较,请右键单击index.xml,然后从上下文菜单中选择“ 与以下对象进行比较”>“本地历史记录 ”。

图29.与本地历史记录比较
与当地历史比较

将打开“与本地历史记录比较”对话框,并向您显示当前版本与以前保存的所有版本之间的差异。 要浏览这些差异,请单击对话框右侧的向上和向下箭头。

“从本地历史记录替换”对话框提供了与“与本地历史记录比较”对话框相同的界面,但是它使您能够替换旧版本中所做的某些更改或所有更改。

图30.与本地历史比较对话框
与“本地历史记录”对话框比较

如果您误删除了文章,则可以使用“替换为”功能将其还原-对于不希望意外丢失工作的用户来说非常方便。

vi。 团队发展

如果您有共同作者,并且需要同时编辑文章或教程,则可以使用团队开发功能。 当然,您需要具有软件配置管理(SCM)系统,IBM®Rational®ClearCase®或并行版本系统(CVS)。 有关更多信息,请参阅“ 相关主题 ”中列出的“ Rational Application Developer V6编程指南”的“第5部分:团队开发”。

七。 导入插图

要导入插图,请选择“ 文件”>“导入” ,然后选择“ 文件系统” 。 或者,您可以简单地将图像拖放到文章或教程的文件夹下。

八。 源概述

Outline视图以树形结构显示了文章或模板的不同XML元素。 当您单击树中的这些元素之一时,其相应的XML代码在编辑器中突出显示,反之亦然。

图31.大纲视图
轮廓图

使用“大纲”视图,如果右键单击树中的项目,则可以添加标签或属性。 “添加子项”和“添加属性”的子上下文菜单分别列出了从树中选择的节点的所有可能的标记和属性。

图32.在<resources>标记内添加一个<resource>标记
从大纲视图添加标签
ix。 源代码助手

XML源页面编辑器提供了一个代码辅助功能,该功能会在您按Ctrl-space时基于光标在XML文件中的位置,为可能的标签和属性提供建议。

以下示例显示了代码助手如何在您尝试在<resources>标记下添加<resource>标记时提供帮助。 当您按Ctrl-空格键时,代码助手将建议您关闭<resources>标记或打开<resource>标记。 要选择两个动作之一,请双击它。

图33.使用代码助手添加标签
使用代码助手添加标签

如果您在具有属性的标记内调用代码助手,它将为您提供可能的属性列表以及每个属性的描述。 同样,您可以选择其中之一。

图34.使用代码助手将属性添加到标签
使用代码助手将属性添加到标签

要枚举标签中某个属性的允许值,可以将光标指向具有该属性值的双引号内,然后可以调用代码助手列出这些值以供选择。

图35.使用代码助手列出标记属性的允许值
列出允许的值

通常,您可以在XML文件中的任何位置调用代码助手以获得可能的帮助。 例如,键入与号(&),然后调用代码助手。

图36.在&符号后使用代码助手。
通用代码帮助

摘要

准备开始处理您的内容了吗?

既然您已经了解了如何使用IBM Rational Web Developer为developerWorks编写内容,那么您可以专注于表达自己的想法,而不是编写细节。 广泛地理解这些知识,您可以使用IBM Rational Web Developer或其他Rational Software Development Platform产品来编辑,转换和预览任何其他XML文件。 祝好运!


翻译自: https://www.ibm.com/developerworks/xml/tutorials/x-dwauthorrwd/x-dwauthorrwd.html

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值