Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
Markdown/appendix
Add-BaseTemplate.ps1
Add-ItemAcl.ps1
Add-ItemVersion.ps1
Add-Rendering.ps1
Add-RoleMember.ps1
Clear-ItemAcl.ps1
Close-Window.ps1
ConvertFrom-CliXml.ps1
ConvertFrom-ItemClone.ps1
ConvertTo-CliXml.ps1
Disable-User.ps1
Enable-User.ps1
Expand-Token.ps1
Export-Item.ps1
Export-Package.ps1
Export-Role.ps1
Export-UpdatePackage.ps1
Export-User.ps1
Find-Item.ps1
GenerateHelp.ps1
Get-Archive.ps1
Get-Cache.ps1
Get-Database.ps1
Get-Domain.ps1
Get-ItemAcl.ps1
Get-ItemClone.ps1
Get-ItemCloneNotification.ps1
Get-ItemField.ps1
Get-ItemReference.ps1
Get-ItemReferrer.ps1
Get-ItemTemplate.ps1
Get-ItemWorkflowEvent.ps1
Get-Layout.ps1
Get-LayoutDevice.ps1
Get-Package.ps1
Get-Preset.ps1
Get-Rendering.ps1
Get-Role.ps1
Get-RoleMember.ps1
Get-ScriptSession.ps1
Get-SearchIndex.ps1
Get-Session.ps1
Get-SpeModule.ps1
Get-SpeModuleFeatureRoot.ps1
Get-TaskSchedule.ps1
Get-UpdatePackageDiff.ps1
Get-User.ps1
Get-UserAgent.ps1
Import-Function.ps1
Import-Item.ps1
Import-Role.ps1
Import-User.ps1
Initialize-Item.ps1
Initialize-SearchIndex.ps1
Initialize-SearchIndexItem.ps1
Install-Package.ps1
Install-UpdatePackage.ps1
Invoke-JavaScript.ps1
Invoke-Script.ps1
Invoke-ShellCommand.ps1
Invoke-Workflow.ps1
Lock-Item.ps1
Login-User.ps1
Logout-User.ps1
Merge-Layout.ps1
New-Domain.ps1
New-ExplicitFileSource.ps1
New-ExplicitItemSource.ps1
New-FileSource.ps1
New-ItemAcl.ps1
New-ItemClone.ps1
New-ItemSource.ps1
New-ItemWorkflowEvent.ps1
New-Package.ps1
New-Rendering.ps1
New-Role.ps1
New-SecuritySource.ps1
New-User.ps1
New-UsingBlock.ps1
Out-Download.ps1
Protect-Item.ps1
Publish-Item.ps1
README.md
Read-Variable.ps1
Receive-File.ps1
Receive-ItemCloneNotification.ps1
Receive-ScriptSession.ps1
Remove-BaseTemplate.ps1
Remove-Domain.ps1
Remove-ItemVersion.ps1
Remove-Rendering.ps1
Remove-Role.ps1
Remove-RoleMember.ps1
Remove-ScriptSession.ps1
Remove-SearchIndexItem.ps1
Remove-Session.ps1
Remove-User.ps1
Reset-ItemField.ps1
Reset-Layout.ps1
Restart-Application.ps1
Resume-SearchIndex.ps1
Send-File.ps1
Send-SheerMessage.ps1
Set-HostProperty.ps1
Set-ItemAcl.ps1
Set-ItemTemplate.ps1
Set-Layout.ps1
Set-Rendering.ps1
Set-User.ps1
Set-UserPassword.ps1
Show-Alert.ps1
Show-Application.ps1
Show-Confirm.ps1
Show-FieldEditor.ps1
Show-Input.ps1
Show-ListView.ps1
Show-ModalDialog.ps1
Show-Result.ps1
Show-YesNoCancel.ps1
Start-ScriptSession.ps1
Start-TaskSchedule.ps1
Stop-ScriptSession.ps1
Stop-SearchIndex.ps1
Suspend-SearchIndex.ps1
Test-Account.ps1
Test-BaseTemplate.ps1
Test-ItemAcl.ps1
Test-Rule.ps1
Unlock-Item.ps1
Unlock-User.ps1
Unprotect-Item.ps1
Update-ItemReferrer.ps1
Update-ListView.ps1
Wait-ScriptSession.ps1
Write-Log.ps1

README.md

The process of generating a maml xml file has never been easier. The following instructions list what dependencies are needed and the steps to generate the help.

Dependencies:

  1. In the Libraries directory inside the project folder copy the PowerShell.MamlGenerator.dll. This should be alongside the referenced Sitecore libraries.

Generating Help:

  1. Assuming the following folder structure:
+ Console Project Folder
  + Documentation
  |  + GenerateDocumentation.ps1
  |  + Other ps1 help files
  + Libraries
  |  + PowerShell.MamlGenerator.dll
  + bin
    + Debug
      + Cognifide.PowerShell.dll
      + Required Sitecore files are copied here during compilation
  1. Ensure the Documentation folder has the ps1 documentation files.
  2. The ps1 files should be named after the intended command (i.e. Get-Role.ps1) and the content of the file follows the comment based help like you would write for functions. Execute the following command to learn about the format:
help about_Comment_Based_Help
  1. Open a PowerShell console and dot source the GenerateHelp.ps1, then run.
  • PS C:\Users\Michael> . C:\inetpub\wwwroot\Console72\Documentation\GenerateHelp.ps1