Skip to content

How to edit XML Help

Sean McNellis edited this page Mar 29, 2016 · 2 revisions
  1. Create a local repo of your fork
  2. Once downloaded ensure the repo's Microsoft.Xrm.Data.Powershell folder is in your Powershell path (so that it can be loaded by the help editor. A test for this is to open PowerShell and run import-module Microsoft.Xrm.Data.PowerShell. It should load the version you have in you repo automatically if it's configured correctly.
  3. Download and install PS Cmdlet Help Editor - https://pscmdlethelpeditor.codeplex.com/
  4. To edit the help open up Microsoft.Xrm.Data.PowerShell.Help.pshproj using the PS Cmdlet Help editor
  5. Once completing your edits, export the help XML to: Microsoft.Xrm.Data.PowerShell.Help.xml within the repo
  6. once you re-load the module (Import-Module Microsoft.Xrm.Data.PowerShell -verbose -force) you should now see your help xml edits.

Note: Please do not edit the Help xml directly at this time as we'd like to continue to use the Cmdlet help editor to generate the xml.

Clone this wiki locally