跳转到内容

Trainz/本地风格手册

来自维基教科书,开放的世界,开放的书籍

“Trainz”的目标是作为学习工具和参考。我们的受众包括希望填补手册空白的新用户。另一方面,我们也有希望提升技能的经验丰富的用户。如此广泛的受众可能会带来挑战。

我们采用了类似教科书的结构。我们引导读者从他们通常的起点逐步学习越来越高级的主题。作者应牢记,每个部分都应以类似的方式进行。此外,作者不应假设读者拥有本书以外的任何先验知识。

维基教科书由许多作者编写。每本书都应该具有统一的“声音”和风格。这为读者提供了使用本书的一致体验。本文档的其余部分提供指南,帮助作者和编辑创建面向所有 Trainz 用户的连贯且有价值的资源。

书籍要求一致地使用语言。至少目前,可以使用英国英语或美国英语。无论如何,贡献者必须记住,英语不是许多 Trainz 用户的母语。使用朴素语言原则,尤其是在词语选择和句子结构方面。在可能的情况下,贡献者应尝试对所有英语使用者保持中立,而不是依赖于特定地区的习惯用语或语言。

Trainz 将计算机软件和铁路运输结合在一起。每个领域都有其自己的术语。作者不应假设读者已经掌握了这两个领域的术语。在第一次使用时定义专业术语,并在词汇表中列出。

基本结构:深层结构(书籍/章节/部分/小节/主题)

[编辑 | 编辑源代码]

深层结构具有更强的内在组织性。“深层”意味着存在多个子页面级别。“Trainz”使用深层结构,但贡献者应避免定义超过四级的页面(章节、部分、小节、主题)。

命名约定

[编辑 | 编辑源代码]

使用“本章名称”,“部分名称”

[编辑 | 编辑源代码]

大多数书籍(包括维基教科书和印刷版)都将所有单词的首字母大写,除了冠词和介词。不要在标题中使用“章节”、“部分”、“小节”或“主题”等词。

页面长度限制

[编辑 | 编辑源代码]

限制页面长度

[编辑 | 编辑源代码]

有些书籍可能对页面长度有限制(例如,维基百科人试图限制文章的页面长度)。

优点
限制页面长度将使连接速度较慢的用户更容易下载章节。
可能有助于为页面长度设置任意限制,以使书籍更加一致。
缺点
可能会导致不必要的任意部分划分。

使用模板为每个章节或页面创建一致的结构通常很有帮助。模板可以使用标题、信息框和其他功能来创建大纲,使书籍的每个章节都类似于其他章节。

所有章节都遵循一个模板吗?

[编辑 | 编辑源代码]

有些书籍可能受益于使用标准化的章节模板。

优点
使书籍更加一致。
缺点
可能具有限制性。
使新贡献者更难上手。

不同类型的章节使用不同的模板?

[编辑 | 编辑源代码]

有些书籍可能对不同类型的页面使用不同的模板。例如,《食谱》使用不同的模板来显示食谱、食材等。

优点
允许为讨论一般主题类型的页面提供更定制(但一致)的风格。
缺点
可能会使新贡献者难以上手。

复杂的模板?

[编辑 | 编辑源代码]

一些非常有用且美观的模板可以使用解析器功能来创建。

优点
美观且灵活。
缺点
缺乏经验的作者难以使用。

维基链接

[编辑 | 编辑源代码]

只使用书内管道链接?

[编辑 | 编辑源代码]

将链接限制在书籍的章节内,会使书籍“自成一体”。

优点
使书籍保持完整,无需依赖外部资源。
缺点
需要为每个术语创建一个新页面

使用跨项目链接?

[编辑 | 编辑源代码]

可以使用方括号内的前缀在维基媒体项目之间创建链接。w: 指向维基百科,wikt: 指向维基词典,等等。

优点
允许对术语进行简单解释
缺点
使书籍依赖于其他项目。如果进行了这种链接,作者应该定期检查以确保目标页面没有被移动。

受限链接?

[编辑 | 编辑源代码]

书籍可能只在某些情况下使用维基链接,当链接到的信息远远超出书籍的范围时。

优点
缺点

使用导航模板

[编辑 | 编辑源代码]
关于
优点
缺点

使用索引?

[编辑 | 编辑源代码]
关于
优点
缺点

合理使用

[编辑 | 编辑源代码]

"合理使用" 图像是指那些受版权保护,但被认为是公众使用范围内的图像。

优点
允许使用比不接受合理使用图像的书籍更多的图像。
缺点
这绝对是法律上的灰色地带,也许最好干脆避免使用这些图像。

仅限维基共享资源?

[编辑 | 编辑源代码]

在维基教科书中使用的图像可以存储在维基教科书图像命名空间中,也可以存储在维基共享资源中。

优点
通过仅使用维基共享资源上的图像,可以更容易地将书籍进行跨维基转存(例如,如果德语维基教科书想要进行翻译,他们可以将它复制过来,而不需要追查图像)。
这些图像可能会在维基共享资源上被组织到图库或分类中,这可能会引导作者找到与书籍相关或更适合的图像。
缺点
维基共享资源不允许使用合理使用图像。


使用缩略图?

[编辑 | 编辑源代码]

缩略图是图像的小版本,可以通过点击进行展开。

优点
允许在页面上放置许多图像,而不会占用太多空间或带宽。
缺点
缩略图通常太小,在印刷版本中无法使用。

对所有书籍章节使用单个分类?

[编辑 | 编辑源代码]
优点
将整本书“放在一个地方”,因此易于跟踪。
缺点
对于包含超过 200 页的较大型书籍,分类页面将被分解。
限制了书籍的组织方式

在书籍中使用子分类?

[编辑 | 编辑源代码]
优点
有助于组织特定书籍的相关部分
缺点
使得难以一次看到所有章节。

交叉分类到主要主题?

[编辑 | 编辑源代码]
优点
使书籍更“可见”,对于使用分类系统进行导航或查找其他书籍的源材料的读者而言。
缺点
可能会用很长的分类列表弄乱页面底部。

数学公式

[编辑 | 编辑源代码]

数学、科学和工程类书架中的许多书籍都使用了数学公式。此外,这些书籍还经常依赖各种符号来表示不同的数学概念。只要书籍使用这些公式或符号,就应该在整本书中保持一致。

其他风格问题

[编辑 | 编辑源代码]
  • 在所有页面上使用 __NOTOC__ 吗?(这在印刷版本中看起来更好)
[编辑 | 编辑源代码]

许多书籍都有可打印版本,有些书籍甚至有多个可打印版本。许多书籍还包含 PDF 版本,便于阅读和下载。印刷版本应使用页面转录,以便主书籍页面上的所有更新自动反映在印刷版本文本中。PDF 版本可能需要定期更新,以保持与文本的一致性。

有一些专门的模板可用于印刷版本和 PDF 版本。有关更多信息,请参阅 帮助:印刷版本

印刷版本通常可能希望使用 __NOTOC__ 魔术词来抑制书籍中自动生成的 TOC。这样,印刷版本就可以生成自己的 TOC。[[category:Trainz Admin|*风格指南}}

华夏公益教科书