内容


使用 developerWorks Word 和 Writer 模板写作

指导作者编写和发表 developerWorks 文章的逐步指南

Comments

入门

developerWorks 的编辑们期待与您共同努力来发表您的文章。请确保您已经阅读过 developerWorks 投稿指南中的信息,并已经使用我们的 内容提交表格 来提交您的想法,并在使用本文中的这些指导完成写作之前已经获得他或她的同意。这些都将帮助我们以最快的速度处理您的稿件

文章在 developerWorks 上是以 HTML 格式发布的,但其生成的格式是 XML(Extensible Markup Language)。developerWorks 的编辑具有将 Microsoft Word 和 OpenOffice.org Writer 文件转换为 XML 源格式的工具。转换成 XML 成功与否取决于所提交的 Word 或 Writer 文档是否严格遵从所使用模板的指导原则。

如果您对 Word 处理程序的样式很熟悉,就会发现我们的模板用起来很容易。如果不熟悉,我们的模板中亦包含详细的说明,解释了如何应用样式以符合本文描述的 排版技巧突出显示约定

基本步骤

创建一篇文章要经过以下步骤:

  1. 下载针对 Word 或 Writer 的作者工具包(请参看本文后面的 下载 部分)并解压缩此文件。
  2. 通过借助模板文件或复制示例文章,在 Word 或 Writer 内创建自己的文章模板。
  3. 编辑新文章,添加所需内容,但要确保符合模板或示例中的指导原则。
  4. 将文章与其他文件(如图片或代码)一起发送给 developerWorks 编辑。

步骤 1. 下载作者工具包

如果使用的是 Windows® 系统上的 Word,需要下载 Word 作者工具包 zip 文件,将此文件放在一个合适的位置(比如,Windows 中的 C:\ )并解压缩此文件。

在解压缩文件后,将会看到一个 developerworks 目录(或文件夹),内含一个 word-templateswriter-templates 子文件夹,究竟是哪个子文件夹取决于所下载的作者工具包。

作者工具包中所包含的这些文件或工具是为在 Linux 或 Windows 中使用而设计的。如果使用的是 Windows 或 Linux 以外的其他操作系统,可以联系 developerWorks 编辑 获取帮助。

步骤 2. 创建文章

在这一步,您将从一个模板开始构建自己的文章。模板包括了在 developerWorks 投稿时所能用到的大多数文档元素的样例,比如如何实现正确的格式和如何应用合适的样式。

模板
通过使用模板,您就能够立即开始构建文章的内容。developerWorks 的必要信息将被填上默认值,所以,在将内容发送给编辑前,您需要更新这些字段。

要创建自己的文章,打开表 1 中列出的相应文件。

表 1. 文章模板
模板程序文件
文章Microsoft Wordsample-article-word-5.12.doc
文章OpenOffice.org Writersample-article-writer-5.9.odt

第一次打开模板时,需要填写表 2 中所示的字段。如果暂时还没有这些信息,您尽可以使用它们的默认值,以后再进行更新。

表 2. 要填写的提交字段
字段可选或 必需内容
日期必需撰写文章内容的日期。
提交的类型必需文章,从下拉菜单中选择。
标题必需文章的标题。
子标题可选文章的子标题。可选但推荐。
关键字可选文章的搜索引擎关键字。
前缀可选名字的前缀。示例: Dr.、Mr. 或 Ms。
必需您的姓名。示例: 李明。
中名无需填写您的中名或中名的首字母。示例: D。
无需填写姓氏。
后缀可选您名字的后缀。示例: Jr. 或 IV。
职位必需您的职位。示例: 高级程序员。
电子邮件必需您的电子邮件地址。
个人简介必需您对自己的简单介绍。最好表明自己的经验以及能够就这一主题发表文章的权威性。
公司必要公司的名称。示例:IBM。
照片文件名可选适合连同个人简介一起显示的 “头到肩” 照片的文件名。
摘要必要您文章的摘要。把文章的要点和关键术语放在摘要的开始处,因为摘要会在搜索结果中被截短。用三到五句话说说为什么读者要关注文章的内容(动机)以及他或她看完文章后能得到什么(收获)。

可以使用任意您喜欢的名字保存新文档。

步骤 3. 编辑文章

编辑文章需要遵从示例文章中的指导原则。这些指导原则展示了应该使用何种样式才能成功完成到 developerWorks XML 格式的转变。根据这些指导原则格式化内容是非常重要的

排版技巧

表 1 中给出的示例文件是获得全面的文章编写技巧的最佳资源。示例中大量的注释对编写文章的各个方面提供了指导。下面列出了其他一些有用的技巧 :

  • 可以从已有的其他文件中剪切和粘贴。但需要对比粘贴文本所导入的样式,看是否与我们的示例相匹配。
  • 这些示例包含了 developerWorks 文章中经常使用的结构样例。如果您的内容不需要任何清单或图这类的东西,那么就不要因为示例中有这类内容而将自己不需要的东西添加到文章中。
  • 当需要包含示例代码的清单时:
    • 将代码行的长度限制在 90 个字符以内,包括空格。
    • 要避免在示例代码行的结尾用硬编码空格或制表符。
    • 避免在示例代码行的开始使用制表符。如果必须要有缩进,请使用空格。
    • 不要使用颜色。如果想要突出显示示例代码中的某部分,请使用粗体。
  • 当提供可下载的示例代码时,请将代码打包并发给编辑。
  • 用.jpg 或 .gif 格式创建图形文件,包括屏幕截屏,并要确保图形的宽度不超过 572 像素。将图形文件发送给编辑。有关如何创建和提交有效图形的更多信息,请参阅 “developerWorks 投稿图片处理”。

突出显示的约定

书的标题使用斜体还是引号?究竟何时需要使用粗体 — 何时又根本无需进行任何突出显示呢?表 3 给出了 developerWorks 文章推荐使用的突出显示约定。

表 3. 推荐的突出显示
突出显示的元素推荐的突出显示
“文章标题”引号
书的标题斜体
C/C++ 代码Courier 或 Courier New 字体
Courier 或 Courier New 字体
代码示例
HTML 预格式化的样式(Courier 或 Courier New 字体,8pt)
正文中引用的代码片段(少于一行)Courier 或 Courier New 字体
专栏或系列的名称斜体
命令的名称Courier 或 Courier New 字体
目录的名称无突出显示
强调斜体。例如:“使用 that 来引入一个限定性从句。 要输入……"
异常的名称Courier 或 Courier New 字体
文件的名称无突出显示
函数调用Courier 或 Courier New 字体
GUI 控件粗体。例如,“在 Installation 菜单,单击 Install a new feature > Finish。”
HTML 标记或节的示例Courier 或 Courier New 字体
界面Courier 或 Courier New 字体
关键字(比如 static)Courier 或 Courier New 字体
杂志的标题斜体。例如 “参见 LinuxToday 上的相关文章。”
消息文本或给用户的提示符Courier 或 Courier New 字体
方法Courier 或 Courier New 字体
对象Courier 或 Courier New 字体
路径名无突出显示
在上下文中定义的术语斜体
用户输入的文本Courier 或 Courier New 字体
“文章标题”引号
类型(例如 int 或 long)Courier 或 Courier New 字体
URL无突出显示
变量斜体。例如 “其中,myname 代表您的用户 ID。”
XML 标记或节Courier 或 Courier New 字体

步骤 4. 将文章提交到 developerWorks

准备好内容之后,就可以将其发送给 developerWorks 编辑了。可以通过 E-mail 将文章的 Word 文件(以及所有相关的图形或示例代码)发给编辑。有关如何为文章创建和提交图形的详细指导原则和技巧,请参阅 “developerWorks 投稿图片处理”。


下载资源


相关主题

  • 您可以参考本文在 developerWorks 全球站点上的英文原文
  • 使用 developerWorks XML 模板写作”(developerWorks,2007 年 7 月):如果更愿意使用 XML 模板,在这个面向作者的可下载工具包中能够找到完整的操作指导和模板。
  • developerWorks 投稿图片处理”(developerWorks,2007 年 11 月):获得有关为文章创建和提交插图的详细指导和提示。
  • developerWorks 投稿指南:在向 developerWorks 提交写作意向或稿件之前,请仔细阅读 developerWorks 投稿指南中的信息,这将帮助我们以最快的速度处理您的稿件。
  • developerWorks 征稿列表:了解每个 developerWorks 编辑的内容期望列表。

评论

添加或订阅评论,请先登录注册

static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=10
Zone=XML, Java technology, Linux
ArticleID=269592
ArticleTitle=使用 developerWorks Word 和 Writer 模板写作
publish-date=11082016