Geek Answers Handbook

PowerShell MAML Help Generator

Does anyone know a utility for creating PowerShell help files? Doing this manually seems a little tedious ...

I found: http://blogs.msdn.com/powershell/archive/2007/09/01/new-and-improved-cmdlet-help-editor-tool.aspx

Any updated versions? I can not select a module. I have a binary module.

+5
source share
5 answers

I created a Powershell script that will generate MAML for cmdlets and functions, regardless of whether they are part of modules. It is not ideal, because the generated MAML will require some manual editing, but it also refers to the cmdlet's help editor. I have a blog post about it here

If you use it and find fixes, feel free to update the script on PoshCode .

+4
source

I had to document my module and did not find a better solution than to create my own mechanism for creating MAML. Here: https://github.com/nightroman/Helps

PowerShell MAML PowerShell. WYSIWYG, . , , . - .

(, , ) :

### Command help data

@{
    command = 'Name'
    synopsis = '...'
    description = '...'
    sets = @{
        Set1 = '...'
        #...
    }
    parameters = @{
        Param1 = '...'
        #...
    }
    inputs = @(
        @{
            type = '...'
            description = '...'
        }
        #...
    )
    outputs = @(
        @{
            type = '...'
            description = '...'
        }
        #...
    )
    notes = '...'
    examples = @(
        @{
            title = '...'
            introduction = '...'
            code = {
            }
            remarks = '...'
            test = {
                . $args[0]
            }
        }
        #...
    )
    links = @(
        @{
            text = '...'
            URI = '...'
        }
        #...
    )
}

### Provider help data

@{
    provider = 'Name'
    drives = '...'
    synopsis = '...'
    description = '...'
    capabilities = '...'
    tasks = @(
        @{
            title = '...'
            description = '...'
            examples = @(
                @{
                    title = '...'
                    introduction = '...'
                    code = {
                    }
                    remarks = '...'
                    test = {
                        . $args[0]
                    }
                }
            )
        }
        #...
    )
    parameters = @(
        @{
            name = '...'
            type = '...'
            description = '...'
            cmdlets = '...'
            values = @(
                @{
                    value = '...'
                    description = '...'
                }
                #...
            )
        }
        #...
    )
    notes = '...'
    links = @(
        @{
            text = '...'
            URI = '...'
        }
        #...
    )
}
+1

/ # PoshBuild . (, ), - .

0

XML PowerShell (PSMAML) :

0

open-source XmlDoc2CmdletDoc PowerShell ( #) #, , ( PowerShell): .

MAML ! , # , . dll, . dll-Help.xml. PowerShell Get-Help.

XmlDoc2CmdletDoc -strict, ; , - , , .

, XmlDoc2CmdletDoc ( "" , Get-Help):

  • .
  • .
  • .
  • .
  • , .
  • , .
  • - , . ( .)

, , . PowerShell, Simple-Talk.com.

0

More articles:


All Articles