如何从反射和xml注释生成mediawiki-ready文档

时间:2011-06-22 00:58:37

标签: c# mediawiki xmldocument tooling

有人可以建议一个好的工作流程,

  • 独立于数量 可能的不同工具 需要
  • 以及手动工作量 要进行,

可以让我将我的项目文档(反射+ xml注释)合并到mediawiki语法中,然后我会将其用于我的开发团队wikia吗?

3 个答案:

答案 0 :(得分:3)

将涉及一些体力劳动,但使用下面列出的资源应该可行。

我的第一个念头只是做了一些谷歌搜索,我遇到了http://www.mediawiki.org/wiki/Alternative_parsers。所有这些解析器似乎都采用数据并将其转换为XML,而不是XML,也没有一个是基于.NET的,如果不涉及编码,从长远来看这可能不是非常重要。谁知道,这里可能有值得关注的东西。

然后我找到了http://www.mediawiki.org/wiki/Manual:Importing_XML_dumps。我想如果你能以XML格式导入数据,那么你真正需要知道的是模式是什么,这样你就可以以适当的方式重新格式化你的数据。 最好的事情是这个页面有http://www.mediawiki.org/wiki/Manual:XML_Import_file_manipulation_in_CSharp的链接,这是一个如何使用Media Wiki XML导入文件的C#示例。在这个示例中,创建从头开始生成所需xml并转储数据所需的类似乎只是一小步。以下是官方模式文档的链接:http://www.mediawiki.org/xml/export-0.3.xsd

根据您是否要编写PHP,可以使用其他选项。您可以编写XMLTransform扩展,如下所述:http://www.ehartwell.com/TechNotes/MediaWikiXmlExtension.htm。该网站似乎表示您可以将XML保留为原生格式,并编写自定义XSL表以显示所需格式的内容。

祝你好运!

答案 1 :(得分:1)

您可以使用sandcastle从源代码http://documentation.sandcastle.codeplex.com

创建网页

您必须在项目设置中启用项目的XML生成。 生成的XML可以在sandcastle中使用,以生成一些很酷的文档,例如作为网页。

答案 2 :(得分:0)

我会考虑使用doxygengenerate XML,然后将生成的XML(XSLT或您选择的工具[s])处理成适合您需求的内容。

如果你安装了graphviz,doxygen也可以使用dot工具generate various diagrams。以下是doxygen生成的类层次结构图的示例(来自KDE文档):http://api.kde.org/playground-api/graphics-apidocs/cirkuit/src/lib/html/inherits.html

另一个,略显不那么华丽的(来自IBM):http://www.icu-project.org/apiref/icu4c/classUMemory.html