6

Is it possible to generate a set of wiki pages from XML comment file generated by Visual Studio?

I'm talking about something like Sandcastle, but for wiki format instead of compiled CHM.

Edit: I'm using MediaWiki which can import/export articles in XML. So I hope that it is possible to write a transformation converting XML comments to MediaWiki XML.

Dmitriy Zhukov
  • 372
  • 2
  • 12
  • As in a one time migration from inline XML to MediaWiki XML? Because I don't see how you are going to keep both in sync if you are going to keep the inline XML comments AND allow users to edit the MediaWiki. – Wim Coenen Jul 13 '09 at 16:49
  • Wiki pages with technical documentation should not be edited by users except core classes developed years ago and not going to be changed anymore. There are general articles describing classes and their usage, I just want to add a link to detailed programming reference. – Dmitriy Zhukov Jul 14 '09 at 11:33
  • What do you gain by having it in a wiki? The main benefit of a wiki is that it is easily editable. However, you're not intending to actually ever edit the pages manually. It really sounds like the best approach is just to not use a wiki and directly place the files on the server in a folder near the wiki. – Yuliy Jul 15 '09 at 16:15
  • The most important things that I wnat to get using wiki: 1) Discussions. I cannot discuss static html files generated by Doxygen or Sandcastle. 2) Better integration with general project documentation which is stored in wiki. – Dmitriy Zhukov Jul 16 '09 at 11:18
  • Please check out my comment. I suspect you're actually thinking about MediaWiki & API reference integration, and I just posted a solution for this. – Alex Yakunin Jul 16 '09 at 16:56
  • I had the same problem and saw this post. So, I created the CS2Wiki.awk script to translate my libraries XML files. The AWK scripts is a hack and got me 70% of the way to creating the MediaWiki file. [CS2Wiki.awk](https://github.com/PHuhn/NSG.Library) – Phil Huhn May 02 '18 at 11:10

2 Answers2

3

I'd recommend a bit different solution:

This is not exactly what you wanted, but I hope this will be helpful.

Alex Yakunin
  • 6,330
  • 3
  • 33
  • 52
0

If the items mentioned above do not suffice, have you tried to simply build your own XSLT transform into the wiki markup of your choice?

You can write a simple application in .NET (or pick your platform of choice) to transform the doc XML format to wiki XML format. You'd still have to keep the wiki updated with the output files manually.

nopuck4you
  • 1,730
  • 14
  • 20