• 5311阅读
  • 2回复

[转载]Enhanced Qt Documentation going live on Qt Developer Network [复制链接]

上一主题 下一主题
离线XChinux
 

只看楼主 倒序阅读 楼主  发表于: 2011-06-16
原文见:http://blog.qt.nokia.com/2011/06/15/enhanced-qt-documentation-going-live-on-qt-developer-network/


For decades Qt developers all over the world have been praising the quality of our documentation. The online versionis by far the most popular of  our websites, visited by hundreds ofthousands developers every month. The content is fantastic and we wantto take it even further by carefully adding a bouquet of modern webfeatures.
Up until now, our documentation team published the content for usersto read and there were no easy options to add additional information.With the Qt Developer Networkwe now have a collection of useful features at our disposal ready toenhance the current online documentation. Some features are available toregistered users only, others don’t require a sign-up.
So, while we have  added some features to our docs content as part ofputting it on Qt Developer Network, no changes are being made to thedocumentation itself. Also, the style of documentation that Qtdevelopers know today will remain on doc.qt.nokia.com for many months to come.

Documentation Notes


The most exciting new feature we are adding for Docs on Qt DeveloperNetwork is the possibility to comment on each and every page. Everyregistered DevNet user now has the option to add extra content to thedocumentation, be it “informative”, “best practice” or a “cool hack”. Weapply a rating and reporting system to ensure the quality and validityof these notes.
By opening up this new channel to our users, we want to grow aQt-centric knowledge base connected to our documentation and also helpyour feedback and corrections reach the team writing our documentationin a more direct manner.

Docmarks


All registered DevNet users can now bookmark classes directly on thesite and their references are shown in the personal sidebar forconvenient access. We believe that this feature will make it easy fordevelopers to access the documentation for classes they work with mostfrequently without a lot of typing.

Search


With the new release of Docs on the Qt Developer Network, we alsomake an improved search engine available to Qt developers. All classesare accessible as auto-suggestions taking users to the right page in asingle click.
In addition, the documentation pages are also included in thesite-wide search which returns all results for a query sorted by contenttype.

Site-Wide Features


Like all other content on the site, each documentation page can betagged and rated by registered users. The tagging functionality isparticularly important for content discovery and we already make use ofit for auto-suggesting related content.
Every activity on the Qt Developer Network is rewarded with pointswhich are tied to a series of ranks. With this release, we extend thesystem to contributions to the documentation as well.

Simple Mode


For users wanting a purer version of the documentation on the QtDeveloper Network, we have implemented an option we call “Simple Mode”.Once this is enabled, the tagging and rating box as well as theDocumentation Notes will be hidden.
Currently, this functionality is only available to users logged in but will be extended to all visitors soon.

More Information


If you want to learn more, take a look at a more detailed article on the blog over at the Qt Developer Network or read about the inner workings and changes under the hood that made all of this possible in Morten’s blog on Qt Labs.
As usual, let us know what you think in the comments or in the forums!
二笔 openSUSE Vim N9 BB10 XChinux@163.com 网易博客 腾讯微博
承接C++/Qt、Qt UI界面、PHP及预算报销系统开发业务
离线alexltr

只看该作者 1楼 发表于: 2011-06-17
Hi,XChinux,为什么从其它地方贴过来的东西断词总是有问题呢?如: thedocumentation  ofthousands mostfrequently 等,文章里还有很多。

我昨天发的那个帖子,从QT ASSISTANT里复制了一些东西,贴过来也是一样问题。
我不从事IT,只是喜欢Qt。
我不是程序员,只是与程序有缘。
我写程序,只是为了让工作变得简单有序!

                      ----  一个一直在入门的编程学习者
离线XChinux

只看该作者 2楼 发表于: 2011-06-17
也发现了这个问题,直接粘过来就会出现断词错误的情况。
二笔 openSUSE Vim N9 BB10 XChinux@163.com 网易博客 腾讯微博
承接C++/Qt、Qt UI界面、PHP及预算报销系统开发业务
快速回复
限100 字节
 
上一个 下一个