跳转到内容

帮助:本地风格手册

This page is semi-protected.
来自维基教科书,开放世界中的开放书籍

与维基百科或维基词典不同——维基百科和维基词典本质上是具有单一风格手册的非常大的书籍——维基教科书上的个别书籍可以根据主题的需要和作者的偏好以截然不同的风格编写。

  1. 有一个通用的 Wikibooks:Manual of Style,在为新书编写本地风格手册之前应阅读此手册。
  2. 强烈建议在开始之前或作为 用户页面子页面 创建草稿时考虑 书籍结构
  3. 如果书籍应该具有独特的重复 风格元素,例如练习或轶事的方框,这些元素应该作为 模板 提供,并在本地风格手册中列出并解释。
  4. 如果书籍应该具有 内容分组导航 的策略,则应在本地风格手册中解释该策略。
  5. 如果书籍应该对创建进一步的 艺术作品或图片 具有特定要求,则应在本地风格手册中提及。
  6. 如果许多作者参与的书籍,如果一些作者就某种 写作风格 达成一致,而其他作者没有遵循该风格,就会变得不一致。应在本地风格手册中描述特定的写作风格。
  7. 旨在遵循某种教学方法的书籍可能需要来自贡献编辑的特殊考虑。应在本地风格手册中详细解释教学方法。

目的

维基教科书通常是许多贡献者的作品,为了为用户提供一致的体验,维护单一的“声音”和风格,这在使用作品时变得至关重要。这在它成为合作的负担和工作整体质量的决定性因素之前应该考虑的东西。

虽然 Wikibooks:Manual of Style 有几个适用于所有书籍的提示,但每本维基教科书通常都有自己的本地风格手册,试图描述所需的“声音”并解释如何使用仅适用于该书籍的特定于书籍的模板和其他有用的工具。

语言

只要有可能,书籍应该尝试对所有英语使用者保持中立,并且不依赖于特定于某个地区的习惯用语或语言。书籍需要一致使用语言,因此,在它们发展的某个阶段,需要做出决定,即书籍将依赖于英式英语还是美式英语,或者是否使用这两种语言的简单子集(例如儿童的小字,简单英语,或 E-Prime 等等)。

基本结构

扁平结构(书籍/章节)

扁平结构通常更受欢迎,因为它更容易保持组织和链接。“扁平”意味着只有一级子页面(书籍/第 1 章,书籍/第 2 章)。

优点
允许在书籍内部以及从其他书籍和项目中轻松链接。
  • 从主页面,可以使用 [[/Chapter/]] 链接到章节。
  • 在书籍中,可以使用 [[../Chaptername/]] 互连章节,而不是使用完整标题。
  • 从其他书籍和项目,如果只需要输入一个变量,例如 {{See also [[Book/{{1}}]]}} 等等,模板会简单得多。
缺点
页面顶部的自动标题仅指向主书籍页面,而不是指向节标题。

深度结构(书籍/章节/子章节/子子章节/等等)

深度结构具有更强的内在组织。“深度”意味着存在多个子页面级别(书籍/第 1 章,书籍/第 1 章/第 2 节,书籍/第 2 章/第 5 节/第 9 页)。

优点
组织结构是“内置”的,因此子章节自动链接到主章节,从而更便于在书籍中导航。
缺点
章节、其他书籍和其他项目之间的链接可能会变得更加繁琐。
更改书籍中章节的位置比对主书籍页面进行一次编辑要困难。参见 Meta: Accidental linking and hard-wired category schemes
打印出来时看起来不像“整洁”。

示例

命名规范

使用“本章名称”,“节名称”

大多数书籍(无论是在维基教科书上还是印刷出版)都将所有单词大写,除了冠词和介词。

优点
打印出来时看起来更好,因为它遵循大多数出版书籍的标准。
缺点
链接可能更难。

使用“章节名称”,“节名称”

一些书籍(无论是在维基教科书上还是印刷出版)只将书籍和章节标题的第一个字母大写。

优点
更熟悉的“维基”式命名方式,如维基百科中所建立的那样。
缺点
不符合正常的书籍出版风格。

示例

页面长度限制

限制页面长度

一些书籍可能对页面长度有限制(例如,维基百科人试图限制文章的页面长度)。根据 MediaWiki 软件的定义,每个页面的绝对限制为 2,097,152 字节(2,048 kB)。

优点
限制页面长度将使用户更容易下载连接速度较慢的章节。
对页面长度设置一个任意限制可能有助于使整本书的感觉更加一致。
缺点
可能会导致不必要的任意章节断裂。

模板

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

优点
使整本书的感觉更加一致。
修改模板比手动编辑每一页都要快得多。
缺点
可能存在限制。
使新贡献者更难上手。

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

有些书籍可能会从使用标准化的章节模板中获益。

优点
更容易确保每一章都遵循相同的格式。
缺点
根据模板的不同,可能难以在页面之间创建多样性。
使新贡献者更难上手。

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

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

优点
允许针对讨论一般主题类型的页面创建更个性化的(但一致的)样式。
缺点
可能会使新贡献者难以习惯这本书。

复杂模板?

一些非常有用且吸引人的模板可以使用解析器函数创建。

优点
吸引人且灵活。
缺点
对于没有经验的作者来说很难使用。

示例

维基链接

只使用书内管道链接?

将链接限制在书籍的章节内,使书籍“自包含”。

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

使用跨项目链接?

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

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

受限链接?

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

许多书籍将书外链接限制在每页的“进一步阅读”部分。有些甚至更进一步,将书外链接限制在唯一的“参考书目和资源”页面。

优点
使书籍相对自包含,因此即使书籍被印刷或用户没有互联网连接,它仍然有用。
缺点
页面或章节末尾的链接不如包含在书籍文本本身中的链接容易找到。

使用导航模板?

可以使用导航模板创建索引、目录或其他书籍功能。

优点
使用模板创建专业级别的导航功能比重新发明轮子更容易。
缺点
使新贡献者更难上手。

使用索引?

索引是一个详细的列表,通常按字母顺序排列,包含书籍中的特定信息。

优点
读者更容易找到他们想要的信息。
缺点
索引必须根据书籍中的信息进行编译,并在添加或删除内容时进行维护。

图片

维基百科中使用的图片存储在文件:命名空间中,可以存储在维基百科或维基共享资源中,维基共享资源是一个独立但密切相关的维基。

合理使用

“合理使用”图片是受版权保护的作品,根据美国法律,在某些情况下可以被使用。这些图片存储在维基百科中,每个使用都必须有法律上的正当理由。

优点
如果合理使用图片对书籍不可接受,则允许使用更多图片。
缺点
这是一个法律灰色地带,尤其影响从美国以外访问维基百科的人,因为使用此类资料可能违反当地法律。

仅限维基共享资源?

维基共享资源托管的媒体要么属于公共领域,要么由版权持有人授权,任何人都可以免费使用。

优点
通过仅使用维基共享资源上的图片,更容易转维基书籍(例如,如果德国维基百科想要制作翻译,他们可以复制它,而无需为每一张图片提供法律上的正当理由)。
这些图片通常在维基共享资源的画廊类别中进行组织,这有助于找到与书籍相关的或更好的图片。
缺点
维基共享资源不允许使用合理使用图片。

使用缩略图?

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

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

类别

对所有书籍章节使用一个类别?

优点
将整本书“集中在一个地方”,方便跟踪页面。
缺点
由于 MediaWiki 软件的限制,类别一次最多显示 200 个相同类型的页面,并在每个组之间进行链接。对于包含 200 多页面的大型书籍来说,这可能是一个限制,因为链接指向前面的和/或后面的组。可以使用类似 {{CategoryTOC}} 的模板来缓解这种情况,以简化类别内的导航。

在书籍中使用子类别?

优点
有助于将特定书籍的相关部分归类在一起。
缺点
难以一次看到所有章节。

数学公式

数学、科学和工程类书架上的许多书籍都包含数学公式,并使用特殊符号来显示数学概念。当使用此类公式或符号时,它们应在整本书中保持一致。例如,一些书籍的 LMOS 建议使用 2+3i 矢量符号,而其他书籍的 LMOS 建议使用 2+3j 矢量符号。

另见:帮助:印刷版 和 使用维基百科/印刷版和 PDF

书籍可以有一个或多个可打印版本,并且可以包含 PDF 版本,以便于阅读和下载。印刷版应使用页面转包,以便主书籍页面上的所有更新自动反映在印刷版文本中。应定期更新 PDF 版本,以保持与主书籍页面的 consistency。

有一些专门的模板和神奇字词可用于印刷版和 PDF 版本。例如,印刷版可以使用 __NOTOC__ 来抑制书籍中自动生成的目录 (TOC)。这样,印刷版就可以生成自己的 TOC。

华夏公益教科书