跳转到内容

帮助:本地风格手册

This page is semi-protected.
来自维基教科书,为开放世界提供开放书籍
(重定向自 Wikibooks:LMOS)

与维基百科或维基词典不同 - 它们本质上是具有单一风格手册的非常大的书籍 - 在维基教科书上找到的各个书籍可以以截然不同的风格编写,根据主题的需求和作者的偏好。

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

目的

维基教科书通常是由许多贡献者创建的,他们维护着单一的 "声音" 和风格,为了为用户提供一致的使用体验,这变得极其重要。这在它成为协作的负担和决定作品整体质量的决定性因素之前,应该加以考虑。

虽然 Wikibooks:风格手册 有一些适用于所有书籍的提示,但每本维基教科书通常都有自己的本地风格手册,试图描述所需的 "声音",并解释如何使用特定于书籍的模板和其他有用的工具,这些工具只适用于那本书。

语言

在可能的情况下,书籍应该尝试对所有英语使用者保持中立,不依赖于特定于某个地区的习语或语言。书籍要求一致使用语言,因此,在它们发展的某个阶段,需要决定书籍将依赖于英国英语还是美国英语,或者是否使用这两种语言中的任何一种的简单子集(如儿童的小词,简体英语,或E-Prime 等)。

基本结构

扁平结构(书籍/章节)

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

优点
允许在书内以及从其他书籍和项目中轻松链接。
  • 从主页,可以使用 [[/Chapter/]] 链接到章节。
  • 在书内,可以使用 [[../Chaptername/]] 链接到章节,而不是使用完整的标题。
  • 从其他书籍和项目,如果只需要输入一个变量,模板就会简单得多,例如 {{See also [[Book/{{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)。这样,印刷版本就可以生成自己的目录。

华夏公益教科书