在 mediawiki 中嵌入 doxygen
我的大部分文档都使用 mediawiki。然而,我们最近开始使用 doxygen 来记录我们的一个 C/C++ 重型项目的 API。为了使我们的整体文档具有一致的外观和内容感觉,我想将 doxygen 的东西嵌入到 mediawiki 中。我该怎么做呢?
我已经查看了一些扩展,但到目前为止我发现的所有内容似乎都是半生不熟的。
I use mediawiki for the majority of my documentation. However, we recently started using doxygen to document the API on one of our C/C++ heavy projects. To give our overall documentation a consistent look & feel, I'd like to embed the doxygen stuff into mediawiki. How should I do that?
I've looked at some of the extensions, but everything I've found so far seems half-baked.
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(2)
我知道的唯一扩展是 DoxyWiki。我认为这就是现在所能提供的一切。
但也许这就是你所说的“半生不熟”?
(另请参阅:维基百科和维基百科)
The only extension I know of is DoxyWiki. I think that's all that is available right now.
But perhaps that is what you meant by "half-baked"?
(See also: Wikis and Wikipedia)
我还没有尝试过 DoxyWiki。
您可以编写一个 wiki 特殊页面,如 Special:FileSystem 或设置一个名称空间,其“子页面”对应于 doxygen HTML 文件文件系统。问题是 doxygen 想要渲染自己的导航,这与典型的 MediaWiki 皮肤的侧边栏等有点不兼容。
您可以将 doxygen HTML 文件放在 Web 服务器上的另一个目录中并链接到它们。为了使其更清晰,您可以为其定义一个 interwiki 前缀,例如“docs”,以及然后您可以使用常规 wiki 链接
[[docs:php/Action_8php.html|参见 Action.php 参考文档]]
链接到 doxygen 网页。您可以对 doxygen 输出进行皮肤处理,使其看起来更像您的 wiki 的皮肤。但是您的 wiki 搜索框不会返回 doxygen 匹配项。I haven't tried DoxyWiki.
You could code a wiki Special page like Special:FileSystem or set up a namespace whose "subpages" correspond to doxygen HTML files in the file system. The problem is doxygen wants to render its own navigation which is kinda incompatible with a typical MediaWiki skin's sidebar and such.
You could put the doxygen HTML files in another directory on your web server and link to them. To make this cleaner you could define an interwiki prefix for it, like "docs", and then you can link to the doxygen web pages withh regular wiki links
[[docs:php/Action_8php.html|see the Action.php reference docs]]
. You could skin the doxygen output to make it look more like your wiki's skin. But your wiki's search box won't return doxygen matches.