This project is read-only.

Export-HelpTemplate

Synopsis

Exports an empty template generated from the given module.

Syntax

Export-HelpTemplate [-Module] <string> [-Path] <string> [-IncludeSchema] [-Encoding <string>] [-Force] [-PassThru] [<CommonParameters>]

Description

Given the path to a module, all functions and cmdlets currently defined in the module are used to generate an abstract source document. This is the source document you would normally check in with your source code and maintain as you add, remove, or modify commands.

This document can then be compiled into an intermediate format to be transforms later.

Parameters

-Encoding <String>

The output encoding to use. The default is UTF-8.

Required? false
Position named
Default value|
Accepts pipeline input? false
Accept wildcard charactrs? false

-Force <SwitchParameter>

Whether to overwrite any existing document specified by the Path parameter.

Required? false
Position named
Default value|
Accepts pipeline input? false
Accept wildcard charactrs? false

-IncludeSchema <SwitchParameter>

Whether to include the XML schema inline with the source document.

Required? false
Position named
Default value|
Accepts pipeline input? false
Accept wildcard charactrs? false

-Module <String>

The path to the PowerShell module that contains the commands you want to document.

Required? true
Position 0
Default value|
Accepts pipeline input? false
Accept wildcard charactrs? false

-PassThru <SwitchParameter>

Returns the output path to the source document to the pipeline.

Required? false
Position named
Default value|
Accepts pipeline input? false
Accept wildcard charactrs? false

-Path <String>

The output path for the template source document.

Required? true
Position 1
Default value|
Accepts pipeline input? false
Accept wildcard charactrs? false

Outputs

  • System.IO.FileInfo: When the PassThru parameter is set, the object representing the output Path parameter.

Related Links

Last edited Jan 29, 2014 at 6:17 PM by heaths, version 1