Zh/帮助:编辑

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

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

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

使得 Fedora 项目授予您编辑维基的权力，您必须遵守 开放出版许可协议 1.0'. 这可确保您的贡献将永远免费为全社会使用，修改和分发，就像 Fedora 的分发. 更多信息见 法律 部分. 按照 Infrastructure/AccountSystem/CLAHowTo 的提示完成 CLA.
 * 1) 熟悉一下本网页和相关链接上的信息. 整个维基都应遵守的基本准则在这些链接中. 未遵守这些准则，造成不必要的工作，编辑维基的权力可能会被撤销.
 * 2) 通过Fedora Account System完成贡献者许可协议(CLA). 签署 CLA 协议

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

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

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

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

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

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

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

更多信息查看维基上的勇于更新页面.

尽量避免修改有关法律问题的页面
这些网页都经过精心撰写，并且用词也是精心选择的. 当改变这些文件时，最好是提交修改时先进行审查. 您可以向 Fedora的咨询委员会寻求帮助.

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

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

编辑关键指南和关键页面时要格外小心
大型的重要指南(例如 Packaging Guidelines. )通常由一个特别的个人或小的群组管理. 当你认为需要更改时, 最好与他们合作.

重要页面是许多浏览者较先看到的页面(例如 Fedora 主页,  Download的页面). 这些页面通常由具有经验的贡献者做出更改. 如果你认为这些页面上具有需要替换的内容, 请将这一提议提交到 Websites 团队进行讨论.

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

避免未经协调就重命名页面或移动页面
维基页面通常参考或链接至许多其他的地方. 在重命名页面或移动页面之前, 与相应的组群协调一致是重要的. 在没有充分理由的情况下, 最好避免那样做. 如果你希望讨论移动某一特别项, 将你的问题提交给 Websites 网页团队.

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

接受 Fedora 认为重要的思想
例如, 尽量保持桌面中立和用户友好的界面, 尤其对于非技术用户和刚刚接触 Linux 和 Fedora 的人. 用户可以使用 GNOME, KDE, 终端, 或其他环境. 当撰写用法说明时, 要牢记这一点. 确保 Fedora 对免费开源技术做出的努力是值得的.

为你的附件签名
当你在维基页面上链接一个文件时, 你应该用你的 GPG 密钥建立附加签名. 某些文件的格式支持 GPG 密钥 (例如 RPM 包), 在这种情况下不需要创建附加签名 -- 在文件中的签名就已经足够. 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.

审阅你的更改
不管你是一个熟练的作家, 还是一个英语技能不是很强的人, 邀请其他人进行审阅. 书写良好的文档对 Fedora 的形象很重要. 即使是最好的作家也会犯一些拼写错误或其他错误. 花一点时间审阅你的更改, 挑出一些小错误. 当编辑完一个页面检查错误时, 请使用 显示预览 按钮.

Fedora 是一个团队
当为维基或其他地方撰写相关内容时, 请记住 Fedora 是一个团队. 我们作为一个人, 统一的组群来管理, 朝向一个共同的目标努力. 我们不需要严格区分一个小组或类别, 区分为 Red Hat 工作的贡献者和其他贡献者是不需要的, 所有的贡献者都是整个团队的一部分. 分类在某些情况下是必要的, 但是在其他情况下是可以避免的.

如果你对某些事情没有把握, 请随时提问
其他社区成员很乐意帮助你. 位于 freenode 的 #fedora-websites 频道是最好的讨论维基和其他 Fedora 网页的地方.

监视你的页面和他人的页面
维基作为一个内容开放的合作工具如此成功取决于两个重要的细节. 第一, 你可以监视你所负责的页面, 这使得页面保持特定的正确功能. 第二, 可以监视其他正在开发, 正在完善以及需要你帮助的内容.

在登录以后, 点击标签栏上的监视链接. 成功监视以后, 监视会改变为取消监视, 这时你已经开始监视那个页面了. 你可以点击取消监视来取消监视一个页面.

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.

使用 Special:Watchlist 监视列表
Special:Watchlist 页面 (登录后, 点击页面顶部的我的监视列表) 显示你当前监视的页面. 关于如何使用这个特别页面, 请查看 Mediawiki.org 上的用户手册(英文).

我们正在维护一个卓越的 Watchlist_How-To 以此为 Fedora 的贡献者提供特别的建议和工具.

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.org's page on tables.

IRC 日志
IRC 日志可以插入到  标签之间, 或利用 irclog2html 和 Ian's MediaWiki patch for irclog2html 转换为 MediaWiki 管道表格.

维基页面的结构
这一小节描述了维基页面的一般结构. 请在每一个维基页面上遵循这些准则. 有关 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.


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

不要这样做，5层以上的嵌套意味着需要更多新的页面
This page ==> This_page This, that, and the other page ==> This%2C_that%2C_and_the_other_page
 * 目录会被自动创建，当页面足够长的时候会自动隐藏目录.
 * Anchors to sections are automatically created, with specific symbols used in place of punctuation and spaces:

快速提示
这些是编辑维基需要的最基本的东西.

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


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

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

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

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

These are the standard types of admonition:

警告信息的例子
使用这些警告信息的文本的例子:

参考 Fedora 文档指南, 获得各类警告信息的描述: http://docs.fedoraproject.org/documentation-guide/en_US/sn-xml-admon.html

标记技术术语
使用 code 标记 标记应用软件, 文件, 目录, 软件包, 用户帐户, 和其他的具有特定技术含义的词汇. 被标记的文本将显示为.

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.

For example:

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

Which produces:

The  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  tags:

su -c "yum install awesome-application" &lt;/pre>

Enter the  password when prompted.

Which produces:

su -c "yum install awesome-application"

Enter the  password when prompted.

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  is not responding as expected, have the user switch to   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

命令输出的例子
当需要将运行一个命令所产生的屏幕输出作为一个例子时, 你可以使用一个命令提示符来区分命令和输出.

$ 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

亲自尝试它
在  Fedora Wiki Sandbox 上尝试新的东西. 这同时也是查看小型例子的一个好地方.

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 ) 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.