Wiki Editing Hints/zh

From Qt Wiki
< Wiki Editing Hints
Revision as of 17:09, 3 March 2015 by AutoSpider (talk | contribs) (Add "cleanup" tag)
Jump to navigation Jump to search
This article may require cleanup to meet the Qt Wiki's quality standards. Reason: Auto-imported from ExpressionEngine.
Please improve this article if you can. Remove the {{cleanup}} tag and add this page to Updated pages list after it's clean.

简体中文 English Français Deutsch Polski Português Русский Italian Magyar Spanish 한국어 عربي 日本語 [toc align_right="yes" depth="3"]

注意：中文相关的东西(中文翻译、页面组织等)请访问 SimplifiedChinese

Wiki使用方法

入门

  1. 如果你有一些关于Qt的知识或心得要分享，那么本wiki正式你用来分享的地方。 但请将文章内容限制在Qt相关的主题
  2. 请确保你的想创建页面不存在。使用右上角 wiki box 里面的搜索框来完成这个。
  3. 如果有人已经创建的这个主题的页面，你将在搜索结果中看到它。
  4. 你可以编辑大多数页面的所有内容。(页面Wiki语法是关于标记的帮助)
  5. 如果没有这样的页面，你可以通过点击“Create new page”创建一个。
  6. 文章和类别的标题 都 使用空格或下划线分割。— 请参考 "论坛中相关主题":http://developer.qt.nokia.com/forums/viewthread/2262/ 在这里forum poll可以投票。
  7. 不要为了测试wiki标记而污染页面的历史，使用Playground来代替。

如何编辑一个页面

编辑器顶部栏提供了一些最常用的功能。这应该会让你感觉比较易用。

如果你喜欢直接写wiki代码你可以看一下这个 "cheat sheet":http://warpedvisions.org/projects/textile-cheat-sheet/ 并在 "Textism.com":http://textism.com/tools/textile/ 练习你的技能。他们提供一个工具将我们wiki使用的标记语言—Textile转换成HTML来预览。

请使用预览(preview)选项来检查您的修改，然后再保存，除非你120％肯定你 从不 犯错误。

C++代码会自动在wiki页面上高亮！

如何使你的页面易于使用

遵循下面几条简单的原则有助于后续的开发者理解你所分享的内容的精髓：

像编码一样书写

好的wiki，像好的代码一样，易于阅读与维护。每一篇文章应该包括一个主题(很像一个类)。每一个段落应围绕问题的一个方面(如同一个函数)。如果你改变想法它有助于改变段落，所以你不要将伟大的见解埋藏在别人很难发现的地方。

使用标题(Header)

如果你添加一些信息标题，长文章将更容易阅读。请在介绍部分使用h1级别标题，然后h2和h3勾划出你要讨论的大纲。(编辑器提供了这些按钮。) 尝试写你出你自己的各级标题，这样他们自己就可以勾划出你要说东西的轮廓，因为你可以… …

添加一个目录

当读者发现您的文章，他们将浏览第一页来弄清楚这是否是他们要寻找的。如果你的文章不超过一页，你所需要做的就是写出它。如果它远比一页长，使用目录向读者展示将会有什么。你的首段内容加上目录的内容应该让所有读者知道他是需要点击关闭或继续浏览。

你所需要的就是添加一个标签 "["toc align_right="yes" depth="3"] (移除第一个括号两边的引号) 然后wiki引擎将为你创建一个目录。这个标签可以出现在任何位置，但是如果它出现在文章的顶端将有助于维护。

添加类别(category)

添加类别标签可将你的文章的链接插入到合适的summary页面。通过将文章添加到现有的类别有助于读者找到你写的内容。

如果你想创建一个新的类别和summary页面，只需要给你的文章加上一个尚不存在的类别标签即可。

这是一些常用的类别标签:

&#91;&#91;Category:Bugs]] &#91;&#91;Category:Developing_with_Qt::Qt Quick]] &#91;&#91;Category:Developing with Qt::QtMobility]] &#91;&#91;Category:HowTo]] &#91;&#91;Category:LanguageBindings::PySide]] &#91;&#91;Category:Learning]] &#91;&#91;Category:Tools::QtCreator]]

如何翻译一个页面

如果你翻译一个wiki页面，请牢记它必须可以通过现有语言的版本访问。通过添加或扩展页面顶部的导航栏这个很容易实现。导航栏应该用下面的格式： 本页面的语言 语言1 语言2 … 依次这样并加入它们的链接.

举例来说，在本页中（去掉“[ [”中间的空格）下面的代码被使用： 

'''English''' [ [WikiHilfe|Deutsch]] [ [WikiPomoc|Polski]]<code>

在多数情况下，命名你的页面时应当将语言名加在原始标题的后面(假定原始文章是使用英文写的)。例如，页面 '''How to Foo''' ，翻译成意大利语应该命名为 '''How to Foo Italian''' 。

=== 如何给翻译的页面归类 ===

所有翻译的页面应该和原始的页面有相同的分类。('''How to Foo''' 拥有 <code>Category: How To

标签。) 通过这样做开发者浏览“How To”类别的时候可以看到字母顺序排列的所有的 How to Foo 的翻译版本。

除了初始分类，你可以自由添加其他分类 — 这是一个协作的wiki。如果你喜欢，比如说，一个包括所有翻译到Kannada语言的顶级 类别，对于查找这些内容的用户可能有极大的帮助。

协作

Wiki是用来协作编辑的。为了大家的方便请尽可能遵守一些基本规则。

  • 在 "wiki论坛":/forums/viewforum/16/ 讨论你的页面
  • 用一个可以理解的，内容翔实，但不太正式的语言写作。
  • 使用子标题和适当数量的段落的页面结构更容易理解和阅读。
  • 解释缩写，至少在第一次使用时。
  • 使用有意义的，开门见山的页面名称。
  • 不要盲目地删除的其他人的工作。
  • 使用标签按主题对页面分类。

语法高亮

在工具栏上你可发现一个代码的标签，它使得代码像这样高亮：

  1. include <QtGui>
  2. include "window.h"

int main(int argv, char **args) 

{
QApplication app(argv, args);

Window window; 

window.show();

return app.exec(); } 

行内的代码可以这样括住： &amp;lsaquo;code&amp;amp;rsaquo;someCode(here);&amp;lsaquo;/code&amp;amp;rsaquo; 结果像这样 <code>someCode(here);

当然，Qt的类也是被支持的。

分类页面

当为你的页面创建一个新的类别时，wiki软件将为其创建一个加载页面。就像任何其他页面一样该页面可编辑的。只需点击网页上显示的链接和然后编辑它。本类别中的所有网页将显示在这个页面。有什么理由不为本主题加个介绍呢？

需要帮助？

请查看我们的 "帮助论坛":/forums/viewforum/16/ 或我们的 "FAQ (Qt DN FAQ)":/faq

Retrieved from "https://wiki.qt.io/index.php?title=Wiki_Editing_Hints/zh&oldid=10832"