XML - 数据交换管理/作者指南
您只需点击任何要编辑页面的顶部“编辑此页面”选项卡。您也可以只编辑一个部分或子部分 - 任何您在行上方看到一个小的“编辑”的地方,点击它来编辑该部分。章节编辑过程背后的想法将在每个章节的“讨论”选项卡中记录 - 在那里记录您分配的章节的意图。
如果您想对编委会提出任何建议,我们欢迎您。在 XML: 数据交换管理内容页面顶部有一个“讨论”选项卡,请点击该链接并使用您的评论编辑页面,确保按照条目说明进行操作。
- 在编辑页面时,使用维基代码,而不是 HTML 代码。
- 如何制作链接:[[XML: 数据交换管理/NameOfThePage(页面上)|NameOfThePage(显示为链接)]]
- 不要剽窃:请引用并参考帮助您为本书做出贡献的书籍、文章和网站。
- 所有图片和图形应该以“xml”为前缀,以避免意外覆盖其他文件(例如,xmldmcity 定义了城市的数据模型)。
- 在可能的情况下,使用 可移植网络图形 (PNG) 作为图形,因为它优于 GIF 和 JPEG。此外,PNG 是开源的。OpenOffice.org Draw 可用于创建 PNG 文件。
- 开发用于为书籍创建一致的外观和感觉
- 需要章节摘要
每个章节的底部应该包含一个章节摘要,突出显示章节的要点。请按照本页后面详细介绍的格式指南进行操作。
- 加粗新词
在每个章节中介绍新的概念和术语时,请确保在使用它们之前先对其进行定义;以便读者理解这些词和想法代表什么。加粗单词的首次出现(或在定义之前)。
- 使用句子格式作为标题
标题的首字母大写,其余字母小写,就像这个标题一样。
- 避免使用下划线和全大写单词
- 表格、图形和代码引用
为了一致性,将所有表格、图形(例如图表和照片)和代码示例标记为“展品”。将展品标签放在展品的顶部,左对齐,并对展品进行编号,后面跟着简短的标题。示例:“展品 1:XML 数据类型”和“展品 2:模式代码示例”。
- 概念胶囊和呼吸空间
将您的章节看作数据模型或一块大牛排。一个有用的数据模型被分解成它最小的属性,这些属性需要记录和维护以供将来分析。一块大牛排最好分成一口大小的块来吃,以防止窒息并促进良好消化。当您修改您的章节时,考虑您主题的基本要素;将您的主题分解,并在一个部分中呈现每个要素 - 以便读者能够轻松地跟踪和理解每个部分。您可以随意使用项目符号来表示列表。
继续使用牛排的类比,慢慢吃也很不错,在每口之间都要呼吸。在每个小节之间留出空格,在每个部分之间留出更大的空格。这将打开文本,使其不会显得过于密集和紧凑 - 从而显得令人望而生畏。
- NetBeans(或其他 XML 编辑器)示例
向下滚动内容页面到“附录”。您将看到一个指向“使用 XML 编辑器”章节的链接。当您打开此链接时 - 转到“编辑此页面”选项卡,并在 NetBeans 标题下插入一个链接,其中包含您章节的名称。这是链接的格式:[[XML: 数据交换管理/ChapterName(NetBeans)|ChapterName]] 保存您的编辑后,XML 编辑器页面将包含一个指向您的新 NetBeans 页面的链接。它将显示为红色,因为尚未向该页面发布任何信息。点击链接并将您章节中的所有 NetBeans 信息粘贴到编辑框中。在您分配的章节中,在您刚剪切并粘贴到 XML 编辑器页面中的 NetBeans 信息所在的位置 - 放置一个指向 XML 编辑器 - 您的章节页面的链接。
- 帮助:维基教科书 <= 此链接将提供几个维基指南 - 此页面也可以从左侧栏中每个维基教科书页面的导航框中的“帮助”链接访问。它包含有关插入图片、使用维基语言(比编写和阅读容易得多)创建表格的信息。
此帮助页面还包含一个指向“沙盒”的链接。这是一个空白页面,允许您在不影响真实页面的情况下尝试维基。
- 使所有代码示例都使用统一的颜色(黑色)——有些是全黑的;有些是多色的。请将那些多色的代码示例改为全黑色。
- HTML 代码为小写。
- 保留代码中的注释,但在每个注释之上和之下留出空格。
- 在注释标签中包含代码的文件名。如果您是代码的作者,请在注释中包含您的姓名和您创作代码的日期。请参见示例
<!-- Document : city.xsd Created on : March 1, 2005 Author : Tim Jones -->
- 将章节中所有关于同一主题的示例代码都放在 TOURGUIDE 中。如果您的章节中有偏离此主题的示例,请更改它们以显示 TOURGUIDE 中的示例。
- 如果您的代码包含 HTML 或 XML 声明,则您需要添加 <pre> ... </pre> 标签。
- 为了使那些“pre”标签显示出来,我必须使用 <nowiki> ... </nowiki> 标签。
如果您在插入代码时遇到麻烦,上面提到的两个标签中的一个可能能够帮助您解决问题。
- 您无需在代码示例周围创建表格;通常只需在每行前面添加几个空格就会创建带有蓝色虚线的框
- 使用“stylesheet”的拼写,而不是“style sheet”。
- 使用“opening tag”的拼写,而不是“opening-tag”。
- 使用拼写检查器检查您的维基文本(例如,复制并粘贴到支持拼写检查的文本编辑器中)。
在您章节的底部创建两个链接,一个指向练习页面,另一个指向已创建的答案页面(您可以在内容页面的底部找到此答案页面链接)。
在练习页面中,将您的章节练习剪切并粘贴到一个新页面中。创建新页面的一个简单方法是,只需转到您的主章节页面,在 URL 的末尾键入“exercises”,然后按回车键。如果页面不存在,维基百科将要求您通过转到“编辑此页面”来创建页面。
在练习页面的顶部和底部,提供一个指向章节和答案页面的链接 - 反之亦然,答案页面也是如此。
摘自风格要素 - 威廉·斯特朗克和 E.B.怀特著
- 使段落成为构成的单位 - 主题需要分解成主题,主题需要分解成概念和子概念。每个概念都应该在自己的段落中进行探索。
- 以肯定形式陈述 - “做出明确的断言。避免使用温和、犹豫、模棱两可的语言。使用“not”一词作为否定手段或用于对立,切勿将其作为逃避手段”。
- 使用明确、具体、具体的语言 - “偏好具体而非一般,明确而非模糊,具体而非抽象”。
- 省略不必要的词 - “一个句子不应该包含不必要的词,一段不应该包含不必要的句子...许多表达违反了这一原则:‘the fact that’,他是一个男人... - 他...”。
- 避免使用一系列松散的句子
- 用类似的形式表达协调的思想
- 将相关词语放在一起
- 将句子的强调词语放在句末
为了在书中插入源代码(例如,XML 或 Java),请使用以下格式
<country> <code>au</code> <country>Australia</country> <flag>au.gif</flag> </country>
使用以下维基代码
<pre><nowiki> <country> <code>au</code> <country>Australia</country> <flag>au.gif</flag> </country> </nowiki></pre>
章节摘要应以以下格式出现
章节摘要 |
使用以下维基代码
{| style="background:linen; border: 1px solid black; padding: 1em; width: 100%;" |- | A chapter summary |- |}
故事/案例研究应以以下格式出现
一个故事 |
使用以下维基代码
{| style="background: lightyellow; border: 1px solid black; padding: 1em; width: 100%;" |- | A story |- |}