• 5876阅读
  • 0回复

Qt文档已生成到DevNet [复制链接]

上一主题 下一主题
离线XChinux
 

只看楼主 倒序阅读 楼主  发表于: 2011-06-16
水平有限,将就这看吧。

原文:http://hi.baidu.com/xchinux/blog/item/366a0846f54546116a63e570.html


        在Qt Labs上看到的文章,翻译了一下,原文地址:http://labs.qt.nokia.com/2011/06/15/the-qt-documentation-has-made-it-into-devnet/

        似乎像昨天一样,我在设想关于新的Qt文档设计创意,以将其带入新时代。反应很不错,结果被接受并且很受欢迎,然而,我们还想做更多。我们想将Qt文档从纯HTML格式转化过来,并且演变成一个能够帮助你尽可能简单快速的找到有质量的内容的有用的工具。它应该反映更多相关的使用示例给你,并且它应该让你添加你自己的关于如何获取Qt之外的内容特殊的调整和提示。基本上,我们的目标是创建一个能够使得你阅读文档的时间尽可能的短些的工具。
        对于我们来说,就是Mimir项目的启动,其目标是创建一个XML版本的文档,然后将文档带入到一个新的频道。不需要进入太多细节,我们在QDoc3(Qt文档工具)中创建了一个新的XML生成器,输出Dita XML。(http://dita.xml.org/)DitaXML是一个为在WEB上书写和发布信息而设计的标准化的XML结构。这个生成器在两个月之前就已完成,从那时开始,我们所需要的就是一个将整个文档转换为设计格式的XSLT。


        DevNet上的结果更加强大,DevNet上的Qt文档(昵称为"Facedoc")提升了导航,完全搜索,书签,内容评价、分类、最新的评论等功能。每个文档页顶部的"Add note"功能使得你可以写提示信息和代码示例以丰富文档,并且评价系统向你展示其它DevNet用户所写的最佳示例。可从下面网址获取:http://developer.qt.nokia.com/doc/qt-4.7/



        我前面提到过QDoc3;我们用它来从Qt包中生成Qt文档。现在,这个工具将成为Qt包中的一部分,可以用来为自己的Qt产品生成文档,为QtAssistant工具生成HTML。对于他们来说的一个好消息是他们可以自己来将文档生成Dita XML格式,你也同样能。
像下面一样从命令行运行QDoc:

../../bin/qdoc3 ./yourConfigFile.qdocconf

补充一点,在yourConfigFile.qdocconf中,你还要设置了输出格式为DITAXML。如何设置?请参考QDoc文档。
        这里所有的内容,你可以在从QDoc manual中获得。
        So now that you know what you can do; Go mad! Make it your documentation!

二笔 openSUSE Vim N9 BB10 XChinux@163.com 网易博客 腾讯微博
承接C++/Qt、Qt UI界面、PHP及预算报销系统开发业务
快速回复
限100 字节
 
上一个 下一个