跳转到内容

帮助:本地风格手册

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

维基百科或维基词典不同 - 它们本质上是具有单一风格手册的非常大的书籍 - 维基教科书上发现的个别书籍可以用完全不同的风格编写,根据主题的需要和作者的偏好。

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

目的

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

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

语言

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

基本结构

扁平结构(书籍/章节)

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

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

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

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

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

示例

命名约定

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

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

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

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

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

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

示例

页面长度限制

限制页面长度

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

优势
限制页面长度将使连接速度慢的用户更容易下载章节。
为书籍设置页面长度的任意限制可能有助于使书籍具有更一致的感觉。
劣势
可能会产生否则可能不合理的任意章节断裂。

模板

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

优势
让整本书保持一致的感觉。
在模板中进行更改比手动编辑每个页面快得多。
劣势
可能有限制。
使新贡献者更难参与。

所有章节都遵循模板吗?

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

优势
便于确保每个章节都遵循相同的格式。
劣势
根据模板的不同,可能难以在各个页面之间创建多样性。
使新贡献者更难参与。

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

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

优势
允许对讨论一般主题类型的页面进行更加定制(但仍然一致)的样式。
劣势
可能使新贡献者难以习惯这本书。

复杂的模板?

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

优势
吸引人且灵活。
劣势
缺乏经验的作者难以使用。

示例

维基链接

仅使用书内管道链接?

将链接限制为仅限于书籍的章节,使书籍“自成一体”。

优势
使书籍保持一致,无需依赖外部来源。
劣势
需要为每个术语创建一个新页面。

使用跨项目链接?

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

优势
允许轻松解释术语。
劣势
使书籍依赖于其他项目。如果使用这种类型的链接,作者应定期检查以确保目标页面未被移动。

限制链接?

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

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

优势
使书籍相对自成一体,因此即使书籍被印刷或用户没有互联网连接,它仍然有用。
劣势
与包含在书籍正文中的链接相比,页面或部分末尾的链接不容易被读者找到。

使用导航模板?

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

优势
使用模板来创建专业质量的导航功能比尝试重新发明轮子更容易。
劣势
使新贡献者更难参与。

使用索引?

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

优势
便于读者找到他们想要的信息。
劣势
索引必须根据书籍中的信息进行编译,并随着信息的添加或删除进行维护。

图片

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

合理使用

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

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

仅限维基共享资源?

维基共享资源托管的媒体要么是公有领域,要么是授权由版权所有者免费供任何人重新使用。

优势
通过仅使用维基共享资源上的图片,可以更轻松地跨维基书籍(例如,如果德语维基百科想要进行翻译,他们可以将其复制过来,而无需对每张图片进行法律上的合理说明)。
这些图片通常在维基共享资源的画廊类别中进行组织,这有助于找到与书籍相关的或更好的图片。
劣势
维基共享资源不允许使用合理使用图片。

使用缩略图?

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

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

类别

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

优势
使整本书“集中在一个地方”,便于跟踪页面。
劣势
由于 MediaWiki 软件的限制,类别一次最多显示 200 个同类页面,每个组之间都有链接。对于包含 200 多个页面的较大型书籍来说,这可能是一个限制,因为链接指向前一个或下一个组。可以通过使用类似 {{CategoryTOC}} 的模板来缓解这种情况,以便在类别中进行更轻松的导航。

在书籍中使用子类别?

优势
有助于将特定书籍的相关部分分组在一起。
劣势
使难以一次看到所有章节。

数学公式

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

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

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

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

华夏公益教科书