Summary

This WikiTopic and its children discuss FlexWiki as a documentation delivery vehicle and technical review tool for software documentation and other technical content. -- KorbyParnell

Note

This page is very much under construction. -- KorbyParnell

FlexWiki As a Tech Review Tool for Specs and Documentation

WikiAsTechReviewTool

FlexWiki As Documentation Delivery Vehicle

Examples of Uses

.Text: http://dottextwiki.scottwater.com/
FlexWiki
User Documentation - DotNetNuke Project: http://docnetnuke.my-asp.net

Converting Source Documentation to WikiText

Wiki topics are written in WikiText, which FlexWiki converts into HTML and serves up in a dynamic, server-side ASP.NET Web page (*.aspx) when an end user requests the page. WikiText is a simple markup language that does not descend from the SGML family as do HTML and XML. For an example of WikiText, click the Edit control in the righthand pane.

Publishing existing content to a Wiki from any format, be it SGML, HTML, XML, WordML, plain text, rich text, or any other format is fairly straightforward. Converting a binary file might be a bit more challenging.

Manual Conversion

To manually convert your source docs into WikiText, create a new WikiTopic (by typing a CamelCased word in an existing WikiTopic and then cliking on the link) and overwrite the template text in the new topic with your source content. You can then approximate the formatting of the source content by applying wiki formatting markup (see Formatting Tips in the righthand pane for tips).

Programatic Conversion

To programatically publish multiple source files/topics to a wiki, you must transform it (for example, if the source is xml, use XSLT), copy the transformed content to memory (eg, write to a FileStream Object), create a new WikiTopicName.wiki topic in the WikiBase (requires Admin access to the Wiki virtual server) and then write the content from memory to and save the new file. Alternatively, perform the translation to a local disk and use FwSync to get it to the server.

Conversion Tips and Tools

Use the following tools, utilities, code snippets, and humble words of advice to devise your own strategy for publishing existing documentation to a Wiki.

Tools of the Trade

FwDocGen might be helpful