Fedora

此页面翻译不完整。

2008-09-06 Wiki structure rules now in place
Help:Wiki_structure describes how to structure the wiki, including page naming.

Additional markup resources
Help:Editing from Mediawiki.org is a good source for markup help. There is also a handy reference card image.

对Fedora项目维基页面的编辑不需要具有很强的编辑技能。然而，开始使用维基时应该有一个小型的学习曲线。我们有一些所有编辑者都应该遵循的准则。此网页提供这些指导方针和一些提示，以便帮助您方便的编辑维基。

本文件分为三个部分：获得编辑权限，基本的维基编辑和更高级的编辑功能。

获得编辑权限

为了避免用户恶意更改 Fedora 项目的维基页面，我们不得不限制编辑维基的权限。要获得编辑维基页面的权限，您需要遵循几个简单的步骤。任何人都可以得到编辑权限。

1. 熟悉一下本网页和相关链接上的信息。整个维基都应遵守的基本准则在这些链接中。未遵守这些准则，造成不必要的工作，编辑维基的权力可能会被撤销。
2. 通过Fedora Account System完成贡献者许可协议(CLA)。签署 CLA 协议

使得 Fedora 项目授予您编辑维基的权力，您必须遵守 开放出版许可协议 1.0'。 这可确保您的贡献将永远免费为全社会使用，修改和分发，就像 Fedora 的分发。更多信息见 法律 部分。按照 Infrastructure/AccountSystem/CLAHowTo 的提示完成 CLA。

If you are interested in more general website maintenance, or wish to be part of the Fedora Websites team, please see the Websites page.
Information on writing new formal Fedora documentation using the wiki is available from Writing Wiki Documentation.

操作指南和维基准则

您更改维基时应该遵循一些简单的规则。以下是一些例子。一般情况下，要有礼貌和使用常用的词语。无视这些准则并导致一些问题将会剥夺您的编辑权限。如果您有任何疑问，请在 freenode 上的 #fedora-websites 上提出。

自我介绍

在你开始编辑任何页面前,请将您的自我介绍加到您的维基页面中. 在您在维基注册您的帐号以后，您自动的获得了一个个人维基页面，位于http://fedoraproject.org/wiki/User:<username>，其中<username>用你的 Fedora 帐户系统中的用户名替代. 你可以很容易的进入你的维基页面通过点击在顶端右侧的你的用户名.

例如, 看看我们的一些贡献者的维基页面.

其中至少要包含您的电子邮箱，如果您经常在 IRC 上， 您的 IRC 昵称和你经常进入的频道.

总是监视您建立或编辑的页面

跟踪您创建或更改过的页面是重要的,这样您就能与其他人更好的合作.编辑维基的人通常将便签添加到页面中,向其他编辑人员传达信息共同工作,和帮助跟踪页面的更改.

当你登录维基以后,在页面上方的标签栏处有一个监视的链接.点击此处将会将当前页面加入到您的监视列表.

勇于更新页面

请大胆的做出更改. 维基页面是被监视的，可以在必要的时候恢复对维基页面做出的更改. 这并不是说你可以不计后果的做出编辑, 尤其是对关键文档.

更多信息查看维基上的 cn.wikipedia:Wikipedia:勇于更新页面。

尽量避免修改有关法律问题的页面

这些网页都经过精心撰写，并且用词也是精心选择的。当改变这些文件时，最好是提交修改时先进行审查。您可以向 Fedora的咨询委员会寻求帮助。

不要提供被法律禁止条款的细节

不要添加任何违反法律的信息. 记住 Fedora 项目是一个在美国的实体, 需要受到法律的管理. 避免链接到或添加非免费、非开源以及法律担保的软件的信息. 如果你认为你这是一个特例, 请与 Websites 团队讨论. 更多应该避免的例子请查看 ForbiddenItems 页面.

请将问题带到 Websites 讨论. 如果需要, 他们会得到官方的用词.

Be careful when editing key guides or pages

Large and important guides, such as the Packaging Guidelines , are generally managed by a specific individual or small group. It is best to work with them when you feel that changes are needed.

Important pages, like the FedoraMain or Download pages, are the first thing that many visitors see. Changes to such pages should generally be left to experienced contributors. If you feel that something on such a page should be altered, bring the issue to the Websites team for discussion.

不要为了编辑页面而编辑页面

应该避免粗心大意的编辑。对一个页面做出改变只是为了将你的名字添加到编辑日志中去，是不受欢迎的一件事。有大量的具有真正错误病却需要改正的页面。不要做出无意义的编辑，诸如移动添加空白页面，或者将链接 fedoraproject.org 更改为 www.fedoraproject.org(前者是首选)；取而代之的应该是找到拼写、语法或标点错误并更正它。并且，当更正一个小的错误时，在保存前请钩选“这是一个小修改”。

Avoid renaming pages or moving content without coordination

Wiki pages are generally referred to and linked to from various other locations. It is important that you coordinate with the appropriate groups before moving content or renaming existing pages. It would be better to avoid doing that without strong rationale. If you wish to discuss moving a particular item, bring your questions to the Websites team.

删除页面

不再需要的维基页面可以通过添加{{Delete|Reason}}到页面，可以为此页张贴删除标签, 这使得维基管理员确认重要内容不会丢失.

Follow the ideals that Fedora holds important

For example, try to remain desktop-neutral and user-friendly, especially for non-technical users who are new to Linux and to Fedora. Users may use GNOME, KDE, the console, or some other environment. Try to keep that in mind when writing instructions. Make sure that Fedora's devotion to free and open source technology is also represented properly.

Sign your attachments

When you attach a file to a wiki page, you should create a detached signature with your GPG key. Some file formats, such as RPM packages, support GPG keys, in which case you do not need to create a detached signature -- a signature in the file will be enough. A detached signature can be attached to the page alongside the original attachment, or can be included in the page itself.

GPG signatures allow others who download your file to verify that it came from you and has not been modified or corrupted. They do not violate your privacy in any way, they simply allow others to have confidence in the origin of your files.

Images and simple documents are safe to leave without a signature, but there would be no harm in adding one anyway to verify that you were the author.

If you do not have a GPG key or want to learn more, see the Cryptography page.

Review your changes for errors

Whether you are a skilled writer, or your English skills are not strong, invite someone else to review. Well-written documents are important to Fedora's image. Even the best writers are prone to typos or other errors. Take a moment to review your changes to catch small errors. Use the Show preview button when editing a page to check your syntax.

Fedora is a community

When writing content, for the wiki or elsewhere, remember that Fedora is a community. We operate as one, unified group, moving towards common goals. We do not need to distinguish one group or class against another. For example, there is no need to distinguish between contributors who work for Red Hat and those who do not. All contributors are part of the same community. There will be cases where classification is necessary, but it can be avoided otherwise.

If you aren't sure about something, feel free to ask

Other community members will be happy to assist you. The #fedora-websites channel on freenode is the perfect place to discuss the wiki or other Fedora websites.

Watch your pages, and other ones, too

Two details make a Wiki successful as an open content collaboration tool. First is being able to watch content you are responsible for, to make certain it stays true to its mission. Second is being able to watch other content develop, grow, and occasionally need your help.

To watch any page on the wiki, after logging in, click the watch link in the tab bar at the top of a page. It should change to unwatch after it has finished. If a page has unwatch at the top, you are already watching that page. You can click unwatch to unwatch a page.

To receive emails for every edit, go to my preferences (at the top of the page by your name) and make sure to check the appropriate boxes in the User profile tab, under Email.

Using Special:Watchlist

Special:Watchlist (available by clicking my watchlist at the top of each page when you are logged in) displays pages you are currently watching. For more information on how to use this special page, please the manual page at Mediawiki.org.

We are now maintaining a stand-alone Watchlist_How-To to help Fedora contributors with specific suggestions and tools.

Summarize your changes (aka commit log message) -- this is the rule

We all need to be able to quickly glance at a change and know the substance of it. A full diff is not always available. You must supply a summary of your change (Summary: field when editing). This is akin to a changelog message. Explain what you did and why, as well as other useful links and details.

If you choose to not put in a summary, it should be the rare exception. One reason is when doing a minor edit. In that case, be sure to check This is a minor edit when saving.

使用 Mediawiki 语言进行编辑

If you need help with syntax that is not listed here, the Mediawiki Help should contain it.

基本语法

'''粗体 bold'''

''斜体 italics''

'''''粗斜体 bold italics'''''

<code>宽文 Monospace text</code>

列表

* 一个列表项
* 又一个列表项
** 太有趣了，又一个列表项！

# 一个编号列表项
# 又一个编号列表项
## 子项
## 更多子项
# 第三个编号列表项

* 一个无编号的列表项...
*# 有一个带编号的子列表
*# 更多梯级
* 回到第一层列表
*# 又一个带编号的列表
*#* 有其自己的特点

链接

浏览 [[DocsProject]] 了解更多关于 Fedora 的文档信息.

我们的 [[Websites|websites 团队]] 提供许多能够帮助 fedora 的个人.

查看 [[Artwork#Join]] 获得关于加入美工团队的信息.

[[伦敦天气]] 是一个不存在的页面. 

http://fedoraproject.org/ 

这里有一些网站:
[http://www.deviantart.com]
[http://www.flickr.com]

[http://fedoraproject.org 我们的主页]
有许多有趣的信息. 

在链接中使用':'以链接到一个[[:Image:Growth_wide.jpg|图片]].

[[:Category:Documentation]] 列出了所有终端用户的文档.

[[Category:Documentation]] 链接将当前页面加入到相应的
分类; 这个链接自动显示在页面的底部,而不是在段落中显示. 

使用分类链接有两种方法
当你打算链接到一个分类页面时, 在单词 Category 前使用 ':' . 当想要将页面添加到想也的分类中时省略 ':' . 参考上面的例子.

表格

应该保守的使用表格,只有在必要的时候才使用表格.

关于表格的高级应用, 请阅读 Mediawiki.org's page on tables.

{|

! 第一列 !! 第二列 !! 第三列

|-

| 单元格 1 || 单元格 2 || 单元格 3

|}

IRC Logs

IRC logs can either be surrounded in <pre> tags, or converted into MediaWiki pipe-tables with irclog2html and Ian's MediaWiki patch for irclog2html.

维基页面的结构

这一小节描述了维基页面的一般结构。请在每一个维基页面上遵循这些准则。有关 Fedora 正式文档的额外的规则，位于DocsProject/WritingUsingTheWiki。这些规则 This section describes the common structure of a wiki page. Follow these guidelines for every wiki page. There are additional rules used for formal Fedora documentation, covered in DocsProject/WritingUsingTheWiki ; those rules are only required for content written to follow the procedures of the Fedora Documentation Project. Pages that are templates of standard content that are drawn into other pages may have a different structure.

Header 1 (h1) deprecated for use in markup
The header 1 is defined by the page title. When making new or migrating pages, either re-nest or re-structure the page to have only header 2 and below.

• 页面的题目是第一级标题。
• 小节由成对的等号创建:

== Header 2 ==
=== Header 3 ===
==== Header 4 ====
===== 不要这样做，5层以上的嵌套意味着需要更多新的页面 =====

• 目录会被自动创建，当页面足够长的时候会自动隐藏目录。
• Anchors to sections are automatically created, with specific symbols used in place of punctuation and spaces:

This page ==> This_page
This, that, and the other page ==> This%2C_that%2C_and_the_other_page

You can use .2C instead of %2C for anchors
The substitute of '.' for '%' works for anchors against a specific section.

快速提示

这些是编辑维基需要的最基本的东西.

关于在维基上撰写文档的更多信息, 参阅 Writing Wiki Documentation.

通过例子学习

学习如何编辑维基的一个比较好的方法是查看已存在页面的代码. 这非常容易去做:

1. 找到一个你想要查看源文件的页面.
2. 在导航栏, 有一个'更多动作:'的组合框, 单击它.
3. 选择'显示存文本'的选项.

维基会以存文本的形式显示页面. 这对于学习其他维基编辑者的一些技巧是很有价值的. 这些技巧使你可以完成你从未想过的独特的, 有趣的, 强大的东西. 你可以试着查看 Fedora 的主页.

注意, 提示和其他的警告信息

以下这些警告信息被用在 These are collectively known as admonitions, and DocBook 中. 将一个段落转化为一个警告信息, 使用特定的警告模板. 推荐使用一个简短的标题和一个稍微长一些的描述文字.

{{admon/note|标题|这里有关于这一标题的更多信息, 包括对标题和原始段落的更深刻的理解.}}

缩进原始 Indent the initial and second paragraph by one space, to ensure that the box aligns correctly.

These are the standard types of admonition:

What you type	What you see
{{admon/note|This is a note|Informational paragraph that tells more about what is going on.}}	This is a note Informational paragraph that tells more about what is going on.
{{admon/tip|This is a tip|Informational paragraph that tells more about what is going on.}}	This is a tip Informational paragraph that tells more about what is going on.
{{admon/important|This is important|Informational paragraph that tells more about what is going on.}}	This is important Informational paragraph that tells more about what is going on.
{{admon/caution|This is a caution|Informational paragraph that tells more about what is going on.}}	This is a caution Informational paragraph that tells more about what is going on.
{{admon/warning|This is a warning|Informational paragraph that tells more about what is going on.}}	This is a warning Informational paragraph that tells more about what is going on.

Admonition examples

Examples showing context for using these admonitions:

Cliffs can be very high
Wikipedia can vouch for this.

Standing away from cliff edges is a way to stay safe
For more information, read the cliffs(1) man page.

Keep your children away from the cliff edge to your right
Children move around quite a bit and can easily fall off. You should hold their hand.

You are getting near the cliff edge
As mentioned earlier, cliffs can be very high, and it would be bad to fall.

You are about to fall off the cliff
Move away as quickly as possible to avert falling.

Refer to the Fedora Documentation Guide for descriptions of the types of admonition: http://docs.fedoraproject.org/documentation-guide/en_US/sn-xml-admon.html

Marking Technical Terms

Use the code markup (<code>) to mark the names of applications, files, directories, software packages, user accounts, and other words that have a specific technical meaning. This displays the marked words as monospace.

Use two single-quotes () to mark the names of menu items and other elements of the graphical interface. This displays the marked words in italic.

 '''boldface''' 

 <code>inline code tags</code> 

 <code>package name</code> 

 <code>username</code> 

 <code>technical term</code> 

 ''Menu name'' 

 ''two single-ticks'' 

 <code>command -option</code> <code>daemon</code>

 <pre>whitespace preserved< /pre> 

whitespace
    is preservered
  here

 <code>inline whitespace not preserved</code> 

 ''term'' 

 '''[Key]''' 

For example:

The <code>thunderbird</code> package installs the '''Mozilla Thunderbird'''
e-mail application. To start '''Thunderbird''', select:
  ''Applications > Internet > Thunderbird Email''.

Which produces:

The thunderbird package installs the Mozilla Thunderbird e-mail application. To start Thunderbird, select: Applications > Internet > Thunderbird Email.

Writing Example Commands

Example commands are one or more commands set apart from the body of the explanation. Do not use prompt symbols or any other content that shows machine name, user, directory, etc. (which are details set in the $PS1 environment variable.)

Enclose any example command in <pre></pre> tags:

<pre>
su -c "yum install awesome-application"
</pre>

Enter the <code>root</code> password when prompted.

Which produces:

su -c "yum install awesome-application"

Enter the root password when prompted.

Command examples and root
Many commands require root privileges. The reader should not be logged into their system as root, and so you must specify either su -c or su - when explaining such commands.

If the command requires elements to be quoted, nesting should be " ", with the single quote marks surrounded by one containing set of double quote marks. For example:

su -c "command -o 'Some Text' -file 'More text' foo/bar"

If you need to have a series of commands or su -c is not responding as expected, have the user switch to root and warn the user to return to a normal user shell afterward.

su -
Password:
service food stop
cp /etc/foo.d/foo.conf /etc/foo.d/foo.conf.backup
vi /etc/foo.d/foo.conf
food --test-config
...
service food start
exit

Example command output

When the example shows a command as part of showing the output to the screen, you may use a command prompt to clarify commands and output.

$ su -c "ls -l /root"
Password: 
total 148
-rw------- 1 root root  1961 2007-09-21 02:46 anaconda-ks.cfg
-rw-r--r-- 1 root root 46725 2007-09-21 02:46 install.log
-rw-r--r-- 1 root root  6079 2007-09-21 02:42 install.log.syslog
-rw-r--r-- 1 root root  3699 2008-07-28 17:24 scsrun.log
-rw-r--r-- 1 root root 45038 2008-01-10 10:21 upgrade.log
-rw-r--r-- 1 root root  1317 2008-01-10 10:20 upgrade.log.syslog

Try it Out Yourself

Try new things in the Fedora Wiki Sandbox . It is also a good place to see lots small samples at work.

Creating New Pages in the Wiki

The Fedora Project Wiki is large, and so there is a need to maintain a proper hierarchy and organization. The best way to learn about these is to review Help:Subpages and Help:Categories, and then to review the existing layout of the wiki.

Redundant names (such as Foo/FooBar/FooBarGrue) should be avoided. Remember that including 'Fedora' in the page name is redundant. Major Fedora projects do not need to have 'Project' in their page names, either. For example, the Fedora Websites Project has its page named 'Websites', not 'FedoraWebsitesProject'.

For the most part, pages should be grouped as subpages by the projects or programs they are part of. Categories will generally be created for different projects and programs, and should be created sparingly. Most pages you create should be part of a category, and many should also have appropriate tags. If you are thinking about creating a new category or tag, please ask the Websites team for advice first.

If you have questions, feel free to ask the Websites team.

重要页面

编辑关键页面时应该保持谨慎, 例如主页。对这些页面做出更改前，通常要在邮件列表或IRC频道上面讨论。维基的某些部分可能需要不同的权限。例如，文档项目有一个用于创建新文档的部分，对这部分的编辑需要更高的权限。为了取得对这些页面的编辑权限，你需要完成额外的步骤。您经常会在那些页面上找到提示。

获得帮助

关于编辑 Fedora 项目 wiki 页面任何疑问请联系Websites团队, 通过 IRC 频道(#fedora-websites on freenode) 以及邮件列表(fedora-websites-list).

如果您想要做很多编辑的维基，你可以考虑 joining the Websites team.