The objective of the Wiki Toolbox is to simplify common development tasks such as including Windows PowerShell script code into a Wiki article.

This article lists main features that are supported by the Wiki Toolbox, how to use them, how to install and to configure the Wiki Toolbox and how to provide feedback.

 


Short URL

http://aka.ms/WikiToolbox

 


Including Excel Spreadsheets into a Wiki Article

To include Excel spreadsheets into your Wiki article, perform the following steps:

  1. To open the Open Excel Spreadsheet dialog, in the Load menu, select Excel Spreadsheet.
  2. Select your Excel spreadsheet file, and then click Open to close the file dialog and to display a HTML representation of the spreadsheet in the main window.
  3. From the Tasks menu, select Copy to copy the HTML representation of your Windows PowerShell script code into your clipboard.
  4. In your Wiki article, right-click the place where you want the script code to appear, and then select Paste from the context menu.

 

 Note
When the HTML representation of your Excel spreadsheet has been loaded, you can apply some format settings to the header and the data rows.

To change the alignment of a table header, in the main window, click Header to display the header dialg, select the affected column and the desired alignment, and then click Set.

To change the alignment of a of your data rows, in the main window, click Data to display the data dialog, select the affected column and the desired alignment, and then click Set.

In addition to the column alignment, you can also specify whether you want to set Top as vertical alignment and no break for the cell data of a data column.

 

Back to top


Including PowerShell Script Code into a Wiki Article

To include PowerShell Script Code into your Wiki article, perform the following steps:

  1. To open the Open PowerShell Script dialog, in the Load menu, select PowerShell Script.
  2. Select your Windows PowerShell script file, and then click Open to close the file dialog and to display a HTML representation of the script code in the main window.
  3. From the Tasks menu, select Copy to copy the HTML representation of your Windows PowerShell script code into your clipboard.
  4. In your Wiki article, right-click the place where you want the script code to appear, and then select Paste from the context menu.

 

 Note
Load Powershell Script creates a clipboard representation of your PowerShell script code that is embedded in a scrollable box ("<div>") with height of 500px.

However, especially for smaller scripts, this is not necessary.

 

If you don't want a scrollable box around your script code, select No Height in the main window:

 

Back to top


Including a Highlight-Box into a Wiki Article

There are cases where you need to draw a reader's attention to a specific fact.

Typically, this kind of information is encapsulated within a "Note" box.

The Wiki toolbox supports a Caution box, a Note box and a Important box.

To include a highlight-box into your Wiki article, perform the following steps:

  1. From the Templates menu, select a highlight-box to copy the related HTML code into your clipboard.
  2. In your Wiki article, right-click the place where you want the script code to appear, and then select Paste from the context menu.

 

Back to top 


Including the ScriptBox Template into a Wiki Article

To include the ScriptBox template into your Wiki article, perform the following steps:

  1. From the Templates menu, select ScriptBox to open the Load ScriptBox Template dialog.
  2. From the Forum list, select a forum.
  3. In your Wiki article, right-click the place where you want the script code to appear, and then select Paste from the context menu.

 

↑ Back to top 


Including the Troubleshooting Template into a Wiki Article

To include the Troubleshooting template into your Wiki article, perform the following steps:

  1. From the Templates menu, select Troubleshooting to open the Load ScriptBox Template dialog.
  2. From the Forum list, select a forum.
  3. In your Wiki article, right-click the place where you want the script code to appear, and then select Paste from the context menu.

 

Back to top


Including the TechNet Forum Announcement Template into a TechNet forum Post

To include the TechNet Forum Announcement template into a TechNet forum post, perform the following steps:

  1. From the Templates menu, select Announcement to open the Load Announcement Template dialog.
  2. Select start a discussion.
  3. In the Title box, type the title of the Wiki article.
  4. In the URL box, type the URL of the Wiki article.
  5. From the Forum list, select a forum..
  6. On the TechNet forum, click Ask a question to open the Start a New Question or Discussion dialog.
  7. In the Title box, type the title of the Wiki article.
  8. In your Body, right-click the place where you want the script code to appear, and then select Paste from the context menu.
  9. Click Submit to post your announcement.

 

Back to top 


Installing the Wiki ToolBox

The Wiki Toolbox project is located at: http://wikitoolbox.codeplex.com.

The recommended download is a ClickOnce Installer.

When you start the tool, you get a notification if a newer version of the tool is available.

 

To install the Wiki toolbox on your computer, perform the following steps:

  1. To start the installation process, click ClickOnce Installer.
  2. On the Application Install - Security Warning dialog, click Install.
  3. On the Windows protected your PC dialog, click More info.
  4. To complete the installation, click Run anyway.

NB: if you receive an error citing a missing DLL named "Microsoft.Management.Infrastructure", you first need to install WMF3.0 from here: http://www.microsoft.com/en-us/download/details.aspx?id=34595

 

Back to top


Configuring the Wiki Toolbox

To keep the configuration simple and easily extensible moving forward, the Wiki Toolbox uses a delimited file structure to track configuration data.

The elements of each configuration line are separated by a vertical bar (|) - also known as "pipe" symbol.

The following items are tracked in each configuration line:

  1. The shortcut for a techology
  2. The display name of a technology
  3. A link to the Community Information Center - a page on a TechNet forum with information about community related content
  4. A link to a technologies ScriptBox  - a wiki page that lists all PowerShell scripts for a technology

 

 Note
For an example of a configuration file, select Configuration in the main menu.

 

Back to top


Providing Feedback

To start a discussion or report an issue, use the related links on CodePlex:

 

Back to top


See Also

 

↑ Back to top