Wikis - Page Details

First published by Vadims Podans (6MVP, Microsoft Community Contributo)
When: 4 Mar 2010 11:10 AM
Last revision by Benoit Jester
When: 13 Sep 2013 8:13 AM
Revisions: 27
Comments: 21

Options

Can You Improve This Article?

Positively! Click Sign In to add the tip, solution, correction or comment that will help other users.

Report inappropriate content using these instructions.

Wiki: How to Insert Formatted Windows PowerShell Code on TechNet Wiki

This topic is a how to.
Please keep it as clear and simple as possible. Avoid speculative discussions as well as deep dive into underlying mechanisms or related technologies.

You might want to insert formatted and colored code syntax (the colorized and formatted script code is easier to read on Web pages and stands out a lot more). This will help readers understand the syntax faster when they read it.

Inserting code into the Wiki-editor can be a little tricky if you want Windows PowerShell code syntax formatting. This article assumes that you are using Windows PowerShell ISE (that is a part of PowerShell V2) or PowerGUI Script Editor from Quest Software.

Using PowerShell ISE
Using PowerGUI
See Also
Other Languages

Using PowerShell ISE

Click here to go to the PowerShellPack Web site (opens in a new window). Download and install PowerShellPack.
Run the Windows PowerShell ISE editor.
In Windows PowerShell ISE command prompt type the following command: Import-Module PowerShellPack.
In the menu bar will appear new element named Add-Ons.
In the Windows PowerShell ISE editor, open the already saved Windows PowerShell script or just type your code manually.
Select a code part that you want to insert into the Wiki editor.
In Add-Ons menu click IsePack, click Edit and then click Copy-ColoredAsHTML.
Now the selected code is saved to clipboard in to HTML format.
Return back to the Wiki editor.
Click the HTML button in the toolbar and paste the HTML code into the window in the appropriate location.
Paste HTML code from clipboard to editor.
It is a good idea to use good fonts for pasting source code in the editor. Therefore change leading <pre> tag to the following:

<pre style="font-family: consolas; font-size: 12px" class="PowerShellColorizedScript">
The result should be something like this:

#####################################################################            
# Test-Me.ps1            
# Version 0.63            
#            
# This script just tests something            
#            
#####################################################################            
#requires -Version 2.0            
            
function Test-Me {            
[CmdletBinding()]            
 param (            
  [Parameter(Mandatory = $true, ValueFromPipeline = $true, Position = 0)]            
  [string]$Argument            
 )            
 Write-Host "You have passed the following argument to me:"            
 Write-Host $Argument            
}

Using PowerGUI

Click here to go to web site http://powergui.org/downloads.jspa (opens in a new window). Download and install PowerGUI Script Editor
Run PowerGUI Script Editor
In PowerGUI Script Editor open already saved Windows PowerShell script or just type your code manually.
Select code part which you want to insert into the Wiki editor
In Edit menu click Copy As and click HTML
Now selected code is saved to clipboard in to HTML format
Return back to the Wiki editor
Click the HTML button in the toolbar and paste the HTML code into the window in the appropriate location
Paste HTML code from clipboard to editor
It is a good idea to use good fonts for pasting source code in the editor. Therefore change leading <pre> tag to the following:

<pre style="font-family: consolas; font-size: 12px">
The result should be something like this:

#####################################################################
# Test-Me.ps1
# Version 0.63
#
# This script just tests something
#
#####################################################################
#requires -Version 2.0

function Test-Me {
[CmdletBinding()]
    param (
        [Parameter(Mandatory = $true, ValueFromPipeline = $true, Position = 0)]
        [string]$Argument
    )
    Write-Host "You have passed the following argument to me:"
    Write-Host $Argument
}