帮助：样式

(重定向自 )
跳转到：导航，搜索
Wiki
概念 - 命名空间 - 分类 - 门户 - 模板 - 图标 - 视频 - 编辑 - 风格 - 备忘单
风格指南涵盖了创建或编辑文章的基本要点，以确保整个网站的一致外观和感觉。它们基于类似的 维基百科指南。以下指南包含有关设置openSUSE wiki文章样式的详细信息。

通用可用性

中立风格

使用中立的写作风格。避免使用人称代词“我”、“我们”等。

简洁明了

在写作时，请考虑您决定继续阅读或不阅读的速度。写得不好且冗长的文章不会被阅读。

  • 不要添加无关或冗余的内容。人们会阅读简短、清晰的文章，提供他们所需的信息。但他们会逃离那些充斥着无关内容的文章。
  • 使用一致的、不杂乱的格式从上到下。没有人会阅读一篇冗长的文章，该文章被不匹配的布局或颜色分成几个部分。那些只会让阅读速度变慢，并驱赶读者。
  • 为了使您的文章有用且受欢迎，请保持简洁明了！

请参阅维基百科上的 文章开发。

结构

标题

章节标题

  • 上述所有标题指南也适用于章节标题。
  • 由于章节标题构成目录，因此简短的电报式风格有助于提高可读性和页面导航。
  • 不要在第一个章节中重复文章标题。冗余不会鼓励进一步阅读。
  • 不要使用关于或介绍作为第一个章节的名称。任何文章的第一部分都是主题的介绍，因此明确说明这一点不会给读者带来任何新的信息。

标题

  • 使用 = 标记创建标题。这样，目录将从标题自动生成，这有助于读者直接转到感兴趣的部分。
  • 从双等号 == 开始，而不是单个 =。
Icon-forbidden.png
禁止：单个等号 = 与文章标题产生相同文本大小，这在任何常见的写作风格中都没有使用。
  • 不要在标题中放置链接。相反，在章节中首次出现该单词或短语时链接它。
  • 将非常长的章节分成几个子章节，使用子标题。
  • 使用 ---- 标记在任何二级标题 (==) 之前创建一个水平分隔符，这有助于文章的流畅阅读。
示例
 ==heading 1==
 ===subheading 1.1===
 ===subheading 1.2===

 ----

 ==heading 2==
 ===subheading 2.2===
 ====subheading 2.2.1====
 =====subheading 2.2.1.1=====

 ----

 ==heading 3==

内容

openSUSE 拼写

  • openSUSE 是拼写 openSUSE 的唯一正确方法。“OpenSUSE”、“openSuSE”、“OpenSuse”和其他变体都是拼写错误的。由于 MediaWiki 软件无法处理小写维基页面标题，因此在编写标题以“openSUSE”开头的维基页面时，请使用 模板：小写标题。
  • 不要使用商标字符（如 © 或 ®），因为这会妨碍文章阅读。
  • 请注意，“SuSE Linux”和“SUSE Linux”已弃用。除非明确引用 openSUSE 的较早版本（10.1 及更早版本）以进行历史目的，或者 SUSE Linux Enterprise Server (SLES) 或 SUSE Linux Enterprise Desktop (SLED)，请使用“openSUSE”。

重复

不要重复劳动。

  • 请查看 openSUSE 的 HOWTO 列表。那里已经有大量的文章。如果有一个涵盖您想要撰写的主题的文章，请花时间阅读它，看看是否可以改进它。
  • openSUSE 论坛在论坛 高级 HOWTO/FAQ 中收集了 HOWTO。
  • 在 Linux 文档项目 中也有大量的 HOWTO 文章。

首字母缩略词和缩写

  • 在文章中引入新的首字母缩略词时，请在首次出现时使用全名，后跟括号中的缩写形式。例如：章节标题自动形成目录 (TOC)。
  • 避免使用复杂的缩写，因为这会使文章更难阅读。
  • 始终使用标准且被广泛理解的缩写，因为创新可能会导致错误的解释。

变量

有时，命令输入特定于用户的系统，例如系统设备或用户名。应使用以下约定

  • <用户名>，例如在路径命令 /home/<用户名> 中
  • sdX 用于存储设备；重点是字母 X 大写，复制粘贴会产生执行错误而不是损坏。
  • 告诉您的读者应该代替 <用户名> 或 sdX 放置什么，因为并非每个人都熟悉此处提到的写作约定。

新手用户安全

Icon-warning.png
警告：在提供必须以 root 用户权限运行的说明时，请格外小心。像dd, rm, fdisk这样的命令，如果不懂得如何使用，可能会造成很大的损害。新手通常不理解，只是复制粘贴命令

使用直接复制并粘贴到命令行界面会导致执行错误而不是灾难的代码示例。

错误！
root # dd if=openSUSE-11.2-KDE4-LiveCD-i686.iso of=/dev/sda
 /dev/sda 是第一块硬盘，存在于每台计算机上。
正确！
root # dd if=openSUSE-11.2-KDE4-LiveCD-i686.iso of=/dev/sdX
 /dev/sdX 在正常安装中不存在，并且 dd 将返回有关不存在的 /dev/sdX 的错误

图片

放置

有关使用最佳标记的建议，请参阅 图像标记。有关如何放置图像的示例，请参阅 图片教程。

格式

  • 绘图、图标和其他此类图像（基本上具有大块、简单且连续的颜色块的图像）应采用 PNG 格式。
  • 照片应采用 JPEG 格式。
  • 动画应采用动画 GIF 格式。

版权

请注意：这不是 官方版权政策 - 它只是一个带有有用提示的提醒

在您上传图像之前，请确保：您拥有该图像；它属于公共领域；或者版权所有者已同意根据 openSUSE 版权 的条款在 openSUSE.org 上使用它。始终在图像描述页面上注明图像的来源。如果您创建了该图像，例如，请写图像由 John Doe 于 2000 年 1 月 1 日创建（将 John Doe 替换为您的姓名，并将 2000 年 1 月 1 日 替换为图像创建日期）。不要只是写图像由我创建。

请注意，文章的旧版本不会显示图像的相应旧版本，而是最新的版本，除非图像的文件名已更改。

颜色

如果您对某些内容进行着色，请参阅 帮助：颜色，了解带有标准 openSUSE 分发版和网站颜色的颜色表。

评论

  • 不要用编辑评论/问题来杂乱文章文本。而是使用文章的讨论页面。
  • 如果您想与其他编辑者交流，请使用评论标签使评论对普通文章读者不可见。
 <!-- This is an invisible comment.  -->

所需页面

要指示需要一个尚不存在的文章，请在现有文章的文本中创建指向所需文章的链接。如果至少有两个链接指向相同的非存在文章，它将列在 所需页面 上，这是许多新维基作者的灵感来源。虽然并非所有内容都真正需要，但您的常识和专业知识会告诉您从列表中选择哪些内容。

元素

在写作时，请确保使用以下约定。

维基标记

虽然可以使用 HTML 标签来格式化页面，但使用 MediaWiki 标记将使源代码文本更易于阅读和编辑。您还可以查看 维基参考卡和一些文章的源代码。

命令键

  • 示例： F5 和 Tab
  • 代码： <code>要按下的按钮</code>
  • 描述：要按下的键盘按钮。
  • 位置：任何地方

命令路径

  • 示例： /usr/src/linux 和 /usr/lib/os-release
  • 代码： <code>/路径/到/目录/或/文件</code>
  • 描述：目录路径和文件路径描述。
  • 位置：任何地方

命令

有各种模板可用于 shell 命令，具体取决于是应该以用户身份还是以 root 身份运行它们。

{{Usershell|command=用户命令}}

user $ user command

{{Usershell|command=用户命令|output=输出}}

user $ user command

output

{{Rootshell|command=root 命令}}

root # user command

{{Rootshell|command=root 命令|output=输出}}

root # user command

output

还有一个通用版本：{{Shell|# root 命令}}

# root 命令

会议记录

... 内容 ...
  • 代码： <div class="minutes"> ... 内容 ... </div>
  • 描述：显示会议记录。
  • 位置：任何地方

表格

标题 1 标题 2 标题 3 标题 4 标题 5 标题 6
高亮文本 高亮文本 高亮文本 文本 文本 高亮文本
文本 文本 文本 文本 文本 高亮文本
文本 文本 文本 文本 文本 高亮文本
  • 代码：查看页面源代码。
  • 描述：显示带有可选高亮文本的表格。
  • 位置：任何地方

模板

请参阅 模板指南。

参见

外部链接

从 "https://en.opensuse.net.cn/index.php?title=Help:Style&oldid=198684#openSUSE_spelling" 检索