Project Description
This is a tool for automatically converting existing XML comments from your project into MSDN style HTML for posting to the codeplex site. This will eventually use the MetaBlog API to post content, but can currently be used in a copy paste fashion.
The image below is an example of what the result looks like when content for a member (in this case named Extent) is pasted into the html source editing window in codeplex. Be sure that you are editing the HTML source, and not just the web designer,
or else the tags will be treated as literal text.
History
A project of similar design was created in 2006 in order to host the MapWinGeoProc content for the MapWindow project called WikiManager2. Seeing as it has a number 2, I must have written an earlier version than that one, but it was a number
of years ago, so I forget the details. At the time the needed document format was wiki. This version of the project is catering to the next generation of open source development from the DotSpatial project team. The hope was to create a tool
that would allow us to document that project a little bit more easily. So in December 2010, I rewrote the project with the new HTML syntax in mind. The same XML parsing was reused. It still needs some testing to verify that it is working
in its new form.
Warning
This project should be considered extremely experimental. I believe structures may not be supported, and generic members are not yet technically supported so they will have the literal text used in the xml file…which isn’t pretty.
You can feel free to use the product right away, but don’t expect something polished. This project will likely advance as items in
DotSpatial turn out to be not supported, and so I have to add the new functionality. One advantage of not having full scale automation in place is that if there are problems, the project won’t cause any
issues with your site. The disadvantage is that I have found the copy and paste scenario a little tedious considering that methods require their own link, and in many cases there are multiple overloads for each method and so on. So my hope is to
have semi-automatic posting available soon, where at least an entire class can be posted at once.