帮助：样式

Wiki

概念 - 命名空间 - 分类 - 门户 - 模板 - 图标 - 视频 - 编辑 - 样式 - 备忘单

样式指南涵盖了创建或编辑文章的基本要点，以确保整个网站的一致外观和感觉。它们基于类似的维基百科指南。以下指南包含有关设置openSUSE wiki文章样式的详细信息。

通用可用性

中立风格

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

简洁明了

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

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

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

结构

标题

标题应该清晰且简短。请参阅帮助：糟糕的文章标题示例
除非确定目标受众广泛了解，否则不要使用晦涩的首字母缩略词。
不要使用驼峰式大小写。而是使用空格。
使用与维基百科相同的首字母大小写风格。
不要在标题中使用冒号，因为它被用于在MediaWiki中指定命名空间。
避免使用特殊字符。仅使用[aA-zZ][0-9]字符。

章节标题

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

标题

使用=标记创建标题。这样，目录将从标题自动生成，这有助于读者直接转到感兴趣的部分。
从双等号==开始，而不是单个=。

禁止：单个等号=产生与文章标题相同的大小，这在任何常见的写作风格中都没有使用。

不要在标题中放置链接。相反，在章节中首次出现该单词或短语时进行链接。
将非常长的部分分成几个子部分，使用子标题。
在任何二级标题（==）之前使用----标记创建一个水平分隔符，这有助于文章的流畅阅读。

示例

 ==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软件无法处理小写wiki页面标题，因此在编写标题以“openSUSE”开头的wiki页面时，请使用模板：小写标题。
不要使用商标字符（如©或®），因为这会妨碍文章阅读。
请注意，“SuSE Linux”和“SUSE Linux”已弃用。除非明确引用openSUSE（10.1及更早版本）的旧版本以供历史参考，或者SUSE Linux Enterprise Server (SLES) 或 SUSE Linux Enterprise Desktop (SLED)，请使用“openSUSE”。

重复

不要重复劳动。

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

首字母缩略词和缩写

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

变量

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

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

新手用户安全

警告：在提供必须以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发行版和网站颜色的颜色表。

待创建页面

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

元素

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

Wiki 标记

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

命令键

示例：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=输出}}