SDB:Howto

跳转到:导航搜索

情况

这篇文章 SDB(支持数据库)解释了如何编写 SDB 文章。

流程

SDB 文章旨在为 openSUSE 的问题提供解决方案,同时也提供对某些主题的更详细的解释。 如果您在使用 openSUSE 时遇到问题,SDB 应该是您寻求帮助的第一个地方。

SDB 文章应细分为以下几个部分

  • 情况
  • 流程
  • 链接

  • 症状
  • 原因
  • 解决方案
  • 链接

请注意,SDB 文章 - 如果可能的话 - 应该始终描述最简单的解决方案。 但是,也希望展示使用命令行或编辑配置文件可以实现的更快解决方案。 在这种情况下,应该将“解决方案”部分细分为几个子部分。 在深入研究语法细节之前,这里有一个例子:(创建新的 SDB 文章时,可以使用模板 Template:SDB_article


创建新文章

在您的网络浏览器中,在 URL 行中输入新文章的标题后加上 SDB:。 如果文章尚不存在,请单击“编辑”以创建和编辑它。

所有 SDB 文章都必须以 SDB: 开头,这使得搜索它们更容易,并且在 Wiki 中构成一个单独的部分。

翻译

目前 openSUSE wiki 支持多种语言。 如果您愿意并且知道其中一种语言,请翻译您的文章。 如果您不确定是否精通外语,请向 opensuse-web 邮件列表发送电子邮件,并要求有人翻译您的文章。

如果您翻译了一篇文章,请在文章末尾添加“Interwiki”链接。 例如,如果您将一篇文章从德语翻译成英语,请在德语文章末尾添加以下内容

[[en:SDB:<articlename>]]

添加到英文版本,添加以下内容

[[de:SDB:<articlename>]]

修改现有文章

SDB 命名空间包含在我们的审核过程中。 如果您编辑一篇文章,您的更改将被审核,并在审核后对所有用户可见。


分类

每篇 SDB 文章都应该可以通过类别访问。 您可以在 Category:SDB 找到可用的类别列表。 在文章的底部添加类别

[[Category:SDB:8.0|C]]
[[Category:SDB:Network|C]]

类别后跟一个竖线字符和标题的第一个字符。 在上面的例子中,文章名为“Changing NTP Servers”,因此竖线字符后跟一个“C”。

语法

请阅读我们的 wiki 风格 指南 以了解如何格式化内容。

风格

如何称呼您的读者

德语 SDB 文章应使用“Sie”的礼貌称谓,因为这是技术文档的标准。 如果这适用于您的语言,请也使用礼貌称谓。 当然,英语作者没有这个问题 ;-)。

外语术语

在英语以外的语言中,有时很难避免原始的英语技术术语。 请尝试以一种最广泛的 SDB 用户群体会觉得您的文章有用的方式来编写,但不要尝试在目标语言中普遍理解和使用的英语术语上寻找翻译。 一个好的折衷方案可能是同时使用两者,例如这个德语例子:“gehen Sie auf die zweite console (Kommandozeile) mit STRG-ALT-F2"

简单!

即使使用 shell 有时似乎更容易,特别是对您而言,也请尝试记住 Linux 初学者,并解释如何使用 YaST2 或其他工具解决问题。

一篇好的 SDB 文章应该描述每个步骤或链接到提供特定说明的另一篇文章。 因此,不要写

In /etc/inittab, change the default runlevel to 3.

而是

Log in as the root user and open the file /etc/inittab with the
editor of your choice (e.g. vi or pico). Change the line
id:5:initdefault: to id:3:initdefault: so that the system won't boot
into the graphical user interface any more.

这并不是一个硬性要求! 但请记住,许多 Linux 新手也使用 openSUSE。

维护

通常需要根据 openSUSE 的新版本调整 SDB 文章,或者如果更改过于根本,甚至需要编写新的文章。 请尝试维护您的 SDB 文章。 例如,如果您发现您的文章不再适用于最新版本的 openSUSE,请更改“version”行。

链接