跳转到内容

帮助:本地样式手册

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

与维基百科或维基词典不同——它们本质上是具有单个样式手册的非常大的书籍——维基教科书中发现的各个书籍可以根据主题的需要和作者的喜好,以截然不同的风格撰写。

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

目的

维基教科书通常是许多贡献者的产物,为了保持单一的“声音”和风格,以便在使用该作品时为用户提供一致的体验,这变得极为重要。这在它成为协作的负担和作品整体质量的决定性因素之前,就应该考虑进去。

虽然 Wikibooks:样式手册 有些技巧适用于所有书籍,但每本维基教科书通常都有自己的本地样式手册,该手册试图描述所需的“声音”,并解释如何使用特定于书籍的模板和其他仅适用于该书籍的有用工具。

语言

在可能的情况下,书籍应该尽量做到对所有英语使用者保持中立,不要依赖于特定于某个地区的习惯用语或语言。书籍需要一致使用语言,因此,在其演变过程中,需要做出决定,即书籍是依赖于英式英语还是美式英语,或者是否使用其中任何一种语言的简单子集(如儿童用的小词,简体英语,或 E-Prime 等)。

基本结构

扁平结构 (书/章节)

扁平结构通常是首选,因为它更容易保持组织并进行链接。“扁平”意味着只有一级子页面 (书/章节1,书/章节2)。

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

深层结构 (书/章节/子章节/子子章节/等等)

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

优点
组织结构是“内置”的,因此子章节会自动链接到主章节,从而简化书籍内的导航。
缺点
在章节、其他书籍和其他项目之间进行链接可能变得更加费力。
更改书籍中章节的位置比对主书籍页面进行单个编辑要困难得多。参见 元维基:意外链接和硬编码的分类方案
打印出来时,看起来并不那么“整洁”。

示例

命名约定

使用 "本节名称","小节名称"

大多数书籍(包括维基教科书和印刷书籍)都将所有单词的首字母大写,除了冠词和介词。

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

使用 "章节名称","小节名称"

一些书籍(包括维基教科书和印刷书籍)只将书籍和章节标题的第一个字母大写。

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

示例

页面长度限制

限制页面长度

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

优点
限制页面长度将使章节更容易下载,尤其对连接速度慢的用户来说。
设置页面长度的任意限制可能有助于使书籍更具一致性。
缺点
可能导致一些原本没有必要的任意分节。

模板

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

优点
使书籍更具一致性。
修改模板比手动编辑每个页面快得多。
缺点
可能会限制。
使新贡献者更难参与。

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

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

优点
使确保每个章节都遵循相同格式变得更容易。
缺点
根据模板的不同,跨页面创建多样性可能更难。
使新贡献者更难参与。

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

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

优点
允许对讨论一般类型主题的页面进行更定制化(但一致)的样式。
缺点
可能使新贡献者难以适应书籍。

复杂的模板?

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

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

示例

维基链接

只使用书内管道链接吗?

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

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

使用跨项目链接吗?

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

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

限制链接?

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

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

优点
使书籍相对自成一体,因此即使书籍被印刷或用户没有网络连接,它仍然有用。
缺点
页面或章节末尾的链接不像文本中包含的链接那样容易被读者发现。

使用导航模板吗?

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

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

使用索引吗?

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

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

图片

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

合理使用

“合理使用”图片是受版权保护的作品,根据美国法律,在某些情况下允许使用。这些图片存储在维基百科上,并且必须为每次使用提供法律依据。

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

仅使用维基共享资源吗?

维基共享资源托管着 公共领域 或由版权持有者 授权 供任何人免费重新使用的媒体。

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

使用缩略图吗?

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

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

类别

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

优点
将整本书“放在一个地方”,以便于跟踪页面。
缺点
类别一次最多显示 200 个相同类型的页面,并在每个组之间添加链接,这是 MediaWiki 软件的限制。对于超过 200 页的大型书籍来说,这可能是一个限制,因为链接是到前面或后面的组。可以使用像 {{CategoryTOC}} 这样的模板来缓解这个问题,以便更容易地在类别中导航。

在书籍中使用子类别吗?

优点
有助于将特定书籍的相关部分分组在一起。
缺点
使一次查看所有章节变得更困难。

数学公式

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

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

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

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

华夏公益教科书