Documentation

Documentation

Below is the online documentation for WikiPlex. It includes markup samples of all the macros as well, integrating WikiPlex into an existing application, and ways of extending the API.

Note: If you are looking for the API documentation, I recommend visiting the latest release ([release:51732]) to download the CHM.

Writing WikiPlex Markup

The following macros are supported by WikiPlex. For usage of each macro, please see the Markup Guide.

• Text Formatting
  • Bold
  • Italics
  • Underline
  • Strikethrough
  • Superscript
  • Subscript
• Headings
• Images
• Links
• Tables
• Left / Right Aligned and Indented text
• Ordered and Unordered Lists
• RSS / Atom Feeds
• Source Code Blocks (both syntax highlighted, and not)
• Silverlight
• Videos (Flash, Quicktime, Real, Windows Media, YouTube, Channel9, and Vimeo)

Integrating WikiPlex into an Application

Integrating WikiPlex is fairly trivial. Simply add a reference to WikiPlex.dll and use the following code to render markup

var engine = new WikiPlex.WikiEngine();
string output = engine.Render("This is my wiki source!");

If you would like to see a more complete sample, download (or browse under trunk/WikiPlex.Web.Sample) the sample application.

Extending the WikiPlex API

There are several ways you can extend WikiPlex. Below are walkthroughs on how to extend WikiPlex to add new macro / rendering functionality.

• Custom Macros
• Scope Augmenters
• Custom Renderers