Home Wiki > SDB:Howto
Sign up | Login

SDB:Howto

tagline: From openSUSE



情况

本文介绍如何编写SDB(Support DataBase:支持数据库,在此简称同下)文章。

步骤

编写SDB文章是为了给SUSE Linux问题提供解决方案, 同时为某些topics给予更为详细的解释。如果你对SUSE Linux有什么问题,应首先查阅SDB的以获得帮助。

一篇SDB文章应细分为如下部分:

  • 现状
  • 步骤
  • 链接

  • 特征(症状)
  • 原因
  • 解决方案
  • 链接

请注意,SDB文章 -如果可能的话- 应尽可能地描述最为简单的方案。与此同时通过提供命令行或编辑配置文件的方式来解决问题的方案

也是可取的。在这种情况下,这部分“解决方案”应该被细分成几小块。 在详细说明具体的SDB文章语法前,这里有一个很不错的例子(

来自mediawiki的语法,详见 SDB:Changing NTP Server - SDB Example。)


编写新文章

在您的网页浏览器,在URL地址栏中“SDB:”后输入文章标题。如果文章不存在,请点击 “编辑”或"edit"来创建编辑。 请不要覆盖已有的文章,如果需要,请在文章前添加一个版本编号或“(新)”或“(NEW)”.

所有SDB文章必须以SDB:开头,这将方便搜索以及构成wiki上的单独分页 and constitutes a separate section in the Wiki.

总结

历史

当你完成文章的编辑, 请将它添加到SDB:History. 使用如下语法:

YYYYMMDD [[SDB:<articlename>]]

例如:

20051016 [[SDB:Howto]]

请使用国际日期格式。目录以降序排列,这样一来新文章将会被列在顶部。

如果你在对某文章进行了较大的变更,比如将其更新至新版本,同样也请你再编辑历史中提及。非常小的更新和补充请勿添加至历史。

翻译

目前openSUSE wiki 支持英语(English), 德语(Deutsch),法语(Français) and 西班牙语(Español),如果你愿意,并且你知道其中的一种语言,请翻译你的文章。如果不是这样或者你不是很确定你对外语是否足够

流畅,请写E-mail到 opensuse-wiki 邮件列表(opensuse-wiki mailing list)上请别人帮助你翻译。

如果你已经翻译好文章,请在文章末尾添加"Interwiki"链接。例如,你将某德语文章翻译成英语, 那么请在你的德语文章末尾添加:

[[en:SDB:<articlename>]]

在英文译文,添加:

[[de:SDB:<articlename>]]

目前仅支持如下缩写

de German
en English
fr French
es Spanish

修改现有的文章

随着SDB逐渐整合到openSUSE Wiki中,编辑所有的文章成了可能。 如果你希望大幅度地修改一篇文章 最好先点击显示在文章底部

的"discussion" 链接,与原作者进行修改前讨论。

这不是必须做的,但这使wiki合作更简单愉快,如果你无法认同某解决方案,此时给邮件列表opensuse-wiki mailing list发邮件将帮助

澄清疑惑。

小的改变可能不需要讨论


SDB 标签

目录

一旦一篇文章包含超过三个以及三个以上标以=== Section ===的章节 , wiki软件将会自动 生成一个目录列表。也就是说如果你使用了标准的SDB文章框架"情况,步骤, 链接", 这部分工作将是完全自动的。

SDB信息栏

请在新文章的顶部包含如下信息栏(将会隐藏)。

<!-- SDB information
SDB:title: Changing NTP Servers - SDB Example 
SDB:author: mlasars
SDB:date: 2005-10-17 -->

如果你对某文章做了主要的修改 请在作者列表一栏添加你的名字以逗号分开。不要改变任何现存的信息栏中的信息,特别是日期信息

(SDB:date) 从而所有的修改都能在历史文章中显示出来。为方便未来的系统重组,SDB信息栏尽可能的直接在文章中保存重要信息。

版本

在文章开始请标明文章解决方案所针对的SUSE Linux 的版本信息,如:

Version: 8.0
Version: - 8.0
Version: 8.0 -
Version: 8.0 - 8.1

如果某文章并不针对特定版本的Linux,那么对那部分留空即可如果只针对特定构架的版本,那么也请标明,如:

Version: 9.2 x86_64
Version: 9.1 DVD
Version: 10.0 ppc

目前SUSE Linux 支持如下构架: i386, x86_64 (64bit, AMD64 and Intel EM64T) and ppc (PowerPC (Mac)).

如果你也可以再加上如下方框标签: Box (the retail version), FTP, CD, DVD, Torrent and OSS.

请在必须添加的时候添加。

注: 为了在版本信息旁绘出漂亮的方框,请必须在版本信息前以空格键开始。

分类

每篇文章必须能够在其分类中找到,你能够找到可选的分类在 Category:SDB中。 在文章的开始处( at the beginning )添加:

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

分类以管道符(“|”)(pipe character)以及文章标题的第一个字母结尾。比如在以上的例子中,文章标题是"Changing NTP Servers", 所以管道符(“|”)跟以"C"。

关键字

在文章的结尾处添加与文章关联的关键字:

<keyword>ntp,time,xntp,synchronize</keyword>

关键字由你决定。

语句法则

Wiki -语法不同的是, 只要可能的话,MediaWiki还支持纯HTML标记

。 请使用wiki标记从而使文章资源更为方便阅读和编辑,最重要的标记元素下面将会给出。 详见:

wiki编辑手册 [http://zh.wikipedia.org/w/index.php?title=Help:%E7%BC%96%E8%BE%91%E6%89%8B%E5%86%8C&variant=zh-hans 

http://zh.wikipedia.org/w/index.php?title=Help:%E7%BC%96%E8%BE%91%E6%89%8B%E5%86%8C&variant=zh-hans] .


章节

  • Level 1: == 一级标题 == (对于情况,步骤与链接)
  • Level 2: === 标题 === (z.B. for YaST2, Command line)
  • Level 3: ==== one level below ==== (更多的款项,例如不同的版本)

情况和步骤应总是一级标题 其他标题在下一级,以此类推。

格式

你并不需要将段落标以 <p>paragraph</p> ,不像在HTML中。 它会自动添加,段落之间以两空行分开。

Wiki 标记 显示
  
这是第一段,可以分成几行。


这是第二段

这是第一段 ,同样可以写成几行。


这是第二段

文本 (黑体bold, 印刷体italic, code)

对于高亮显示的语句请用如下语句法则:

Style Wiki 标记 Display
bold '''Please use sparingly and only for important paragraphs/words''' Please use sparingly and only for important paragraphs/words
italic ''Example for italics'' Example for italics
code For commands or variables please use: <code>rcapache2</code> For commands or variables please use: rcapache2

枚举 / 列表

枚举如:

Wiki 标记 Display
* 星球
** 火星
** 地球
*** 月球
  • 星球
    • 火星
    • 地球
      • 月球
#旅行
## 飞机
## 车厢
### 的士
  1. 旅行
    1. 飞机
    2. 车厢
      1. 的士

文章末尾的链接请只使用 * Link

命令行及配置文件摘录

文章中单独包含命令行的行请以空格开始:

rcapache2 restart

对于高亮的命令,如果命令行是常规单词 : <code>command</code>.

对于代码列表或配置文件请使用如下句法:

Wiki-markup Display
<pre>
## Path:        Network/Remote access/SSH
## Description: SSH server settings
## Type:        string
## Default:     ""
## ServiceRestart: sshd
#
# Options for sshd
#
SSHD_OPTS=""
<nowiki>
</nowiki>

</pre>

## 路径:        Network/Remote access/SSH
## 描述: SSH server settings
## 类型:        string
## 默认:     ""
## ServiceRestart: sshd
#
# sshd 选项
#
SSHD_OPTS=""

nowiki

在某些情况下你可能需要禁用wiki 标记:

Wiki标记 Display Without nowiki

<nowiki>no '''Bold''', no ''Italic''</nowiki>

no '''Bold''', no ''Italic''

no Bold, no Italic

链接

链接到其他SDB文章请以此开头:SDB: [[SDB:howto]], 但在链接列表中并不需要被如此清楚地表明。

跳转至文章的某位置也是可能的,如: [[SDB:howto#Stil]], 这将以 SDB:howto#Stil 显示。如果

你直接链接到文章的部分章节请添加链接标签: [[SDB:howto#Stil|Stil]] 将会如下显示

Stil 

如果某链接的指向不是很明显请用填写在链接表格中, 或者适用如下简写。

[[http://www.suse.de SUSE]]以 [SUSE] 显示,因此链接和链接列表只是简单的以一

格空格隔开

请注意,在某些国家,某些外部链接可能与当地法律冲突。例如, 比如在德国,链接到某些绕过版权的软件是不允许的。如果你不清楚你

使用了合适的链接。 请向opensuse-wiki邮件列表咨询(见 Communicate ).

表格

详见: [http://en.wikipedia.org/wiki/Wikipedia:How_to_use_tables

http://en.wikipedia.org/wiki/Wikipedia:How_to_use_tables]

图片

到目前为止, SDB 文章还未适用图片。请只在必须适用的地方添加图片以便不打乱版面以及文章的流畅性。 可能的话,只需在文章右边的空栏处添加图片的缩略图。对于如何上传图片,详见:

http://en.wikipedia.org/wiki/Wikipedia:Image_markup .

风格

如何称呼你的读者

德文的SDB文章应该以礼貌的 "Sie"称谓称呼读者,因为这是技术型文档的标准。请你使用礼貌称谓。

外语中的专业用语

对于英语之外的语种,有时不使用原始技术用语是非常难以表述的,请尽量使用标准的英语的专业用语,以方便广泛的SDB作者群找到你

的文章,而不是在某英语用语被广泛理解的情况下努力地去翻译。更为中庸的做法就是两者都适用,如:终端(terminal)

简单化!

尽管使用Shell有时候看起来更简单,特别是对你而言,请尽量提示Linux初学者,同时解释如何使用YaST2或其他工具解决问题。

一篇好的SDB文章应该描述每个单独步骤,所以请不要这样写:

在 /etc/inittab中, 将 default runlevel 改成 3.

而是:

以管理员帐户登陆,使用你喜欢的编辑器(如 vim 或 emacs)打开 /etc/inittab,将此行:
id:5:initdefault: 改成:id:3:initdefault: 从而系统不会默认以图形界面启动。

这个要求并不难!请记住很多新手在使用Linux。

维护

不断地将SDB文章调整到适合新版本的SUSE Linux是必须的,有时甚至是直接写篇新的,如果所需修改是基础性的话。请努力维护你的文

章。例如你发现你的文章不再对新版的SUSE Linux适用,请修改“版本”一行。

链接


cn:SDB:Howto