The wikis are now using the new authentication system.
If you did not migrate your account yet, visit https://idp-portal-info.suse.com/

OpenSUSE风格约定

Jump to: navigation, search


Geeko Please adhere to the following guidelines when creating or editing articles in openSUSE wiki, if in doubt please see Wikipedia guide. We will try to give here basics, and distinction to Wikipedia. Any suggestions how to improve guide are very welcome. Please use discussion link at the top for the comments.
Geeko 当在openSUSE wiki上创建或编辑文章时请遵守下面的准则,如果您有任何疑问请参阅 Wikipedia 指南. 我们 将在此介绍些基本的风格和与Wikipedia的区别。如果您提出任何能改进风格的建议,我们十分欢迎,并请使用在本文顶部的'讨论'链接通知我们。

Article Titles

文章标题


The name of your article is also its headline:

  • make it clear,
  • do not use cryptic abbreviations,
  • do not use CamelCase, ie. ThisIsMyGreatArticle (that no search function can find)
  • do not repeat the title in the text right below article title,
  • do not create your own namespaces.
  • use the same style capitalization as Wikipedia. The Mediawiki software works best with this style.

您的文章的名字也是它的大标题:

  • 明确简洁
  • 不要使用含意模糊的缩写
  • 在英文词语中不要使用驼峰词,即第个单词的第一个字母大写,如ThisIsMyGreatArticle(因为搜索功能无法找到)
  • 不创建您自己的名字空间
  • 使用与Wikipedia相同样式的大写。Mediawiki在这个样式下工作的比较好。

Headings


  • Use the = (Heading) markup, not the ''' (bold) markup to create a heading. This way, the table of contents is automatically generated from the headings and that helps readers to go directly to the section of interest.
  • Start with double equal sign == not a single =.
Note: single equal sign produces the same text size as the article title, which is not used in any common writing style.
Example:
 ==heading 1==
 ===subheading 1.1===
 ===subheading 1.2===
 ==heading 2==
 ===subheading 2.2===
 ====subheading 2.2.1====
 =====subheading 2.2.1.1=====
  • If your text becomes too long, see if it is possible to divide it into subheadings.
  • again, use the same style capitalization as Wikipedia.

Mark Up Your Text


Use the MediaWiki formatting and markup features to make your text easier to read.

Filenames and shell commands

  • If filename is part of text use a fixed font, source:
<tt>fixed font</tt>
  • If it is whole listing, you can use <pre> and </pre> pair of tags, or
  • see new features described in Skin Management.

Exploit MediaWiki's Feature Set


Use general HTML formatting sparingly.

Using MediaWiki formatting gives articles a consistent look and feel and makes their source code easier to write, read, and edit. Have a look at the MediaWiki editing help to find out what formatting and markup tools you can use. You may also want to have a look at the source code of a few Wikipedia articles.

Comments

注释


Use the article's discussion page for your comments. Do not clutter the article text. 使用文章的讨论页面来添加您的注释。不要混杂在文章的文本中。

If you want to communicate with other editors, make comments invisible to the ordinary article reader. To do so, enclose the text that you intend to be read only by editors within tags <!-- --> 如果您想要与其它的作者交流,对文章的普通读者应该不可见,把您所要交流的内容放在标签 <!-- --> 中。 Example:

 hello <!--This is a comment.--> world

is displayed as:

hello world

例子:

 hello <!--这是一个注释--> world

显示为:

hello world

Work in Progress

The openSUSE wiki is work in progress. Comments "Under construction", "not finished" etc. in this context should be used only in seldom occasions when it is important to tell the reader that article doesn't contain complete set of information. For that purpose was created template Expand

This article needs to be expanded. If you can help please do so in line with the openSUSE Style Guide.

If you are looking for something to do, see the other articles that need expanding

Template will give uniform layout across the wiki and list article in Category:Pages_that_need_expanding that is used by volunteers looking for something to do.

Syntax:

        {{Expand}}

Templates


See the Templates list of few often looked for templates.

No Artificial Bloating


Do not create articles that do not contain at least a minimum of relevant information. The Wiki way to suggest that somebody should write an article is to create a link to it. If there are at least two links to the same nonexistent article, it appears on Wanted Pages.

Broom-icon.png 本文需要注意!

本文目前尚不符合 openSUSE Wiki 期望的标准。
欢迎您帮助改善本文。详细信息请参阅 Wiki 团队.