Powershell V2外部MAML帮助

Question

我正在尝试为脚本模块创建外部MAML帮助文件。作为一个测试，我创建了一个名为“ModTest”一个简单的模块保存在一个名为.psm1文件2个功能：

function Test-SqlScript2 
{ 
} 
function Out-SqlScript2 
{ 
} 

我在用户模块目录保存在模块〜\文档\模块\ ModTest 接下来，我创建了一个MAML文件的子目录〜\ Documents \ Modules \ ModTest \ en-US 我用于测试的MAML文件可用于here。然后我启动PowerShell并使用Import-Module导入模块。

不像编译cmdlet的文件的放置本身并不工作

所以，下次我尝试添加的帮助链接到脚本模块，顶部也不起作用：

<# 
.ExternalHelp C:\Users\cmiller6\Documents\WindowsPowershell\Modules\ModTest\en-US\ModTest.help.xml 
#> 


function Test-SqlScript2 
{ 
} 
function Out-SqlScript2 
{ 

然后我尝试添加的帮助信息，以每个功能，这不工作：

function Test-SqlScript2 
{ 
<# 
.ExternalHelp C:\Users\cmiller6\Documents\WindowsPowershell\Modules\ModTest\en-US\ModTest.help.xml 
#> 
} 
function Out-SqlScript2 
{ 
<# 
.ExternalHelp C:\Users\cmiller6\Documents\WindowsPowershell\Modules\ModTest\en-US\ModTest.help.xml 
#> 

两个问题：

1. 是否有可能创建一个脚本 模块级外部MAML帮助或 你需要指定每个功能的帮助链接 ？
2. 虽然 文件要求和博客 表明，语言特定的文件夹 即EN-US将成为指定的路径（〜/ ModTest \ ModTest.help.xml）我 不能得到MAML时自动 搜索除非我包含 显式路径（〜/ ModTest/en-US/ModTest.help.xml），否则将文件解压到 。这是一个错误？请参阅以下 链接的文档上获取帮助和特定语言 文件夹：

Writing Help for Windows PowerShell Modules PowerShell V2 External MAML Help

Answer 1

关于＃1，在我看来，你必须指定每个命令的ExternalHelp注释标记（脚本或功能）。 更新：我得到了PowerShell团队的确认，您必须为每个命令指定注释标记。我提交了一个suggestion on MSConnect，如果您希望在未来版本的PowerShell中看到此内容，您可以对其进行投票。

关于＃2，它确实有效，从我的测试中不必指定完整路径（这非常好）。下面是模块目录的内容，我创建测试：

~\Documents\WindowsPowerShell\Modules\ModTest\ModTest.psm1 
~\Documents\WindowsPowerShell\Modules\ModTest\en-US\ModTest.psm1-Help.xml 
~\Documents\WindowsPowerShell\Modules\ModTest\fr-FR\ModTest.psm1-Help.xml 

我ModTest.psm1文件的内容是：

# .ExternalHelp ModTest.psm1-Help.xml 
function Add-BitsFile([object[]]$BitsJob, [string[]]$Destination, 
         [string[]]$Source) 
{ 
    Write-Host "Add-BitsFile" 
} 

# .ExternalHelp ModTest.psm1-Help.xml 
function Complete-BitsTransfer([object[]]$BitsJob) 
{ 
    Write-Host "Complete-BitsTransfer" 
} 

两个ModTest.psm1-Help.xml文件只是副本：

“$ pshome \ Modules \ BitsTransfer \ en-US \ Microsoft.BackgroundIntelligentTransfer.Management.dll - 帮助。xml“

测试这个最大的PITA是为了得到一个有效的MAML文件，所以我只复制了一个已知的工作文件:-)顺便说一句法语版本我只是在前面加上了”Parlez vous“的简介，所以我可以。测试它的工作

接下来，你需要一个快速的方法来改变线程的CurrentUICulture来测试不同，本地化的帮助文件，这是一个功能Jeffrey Snover wrote some time ago我更新它也改变了的CurrentUICulture：

function Using-Culture (
[System.Globalization.CultureInfo]$culture = ` 
    (throw "USAGE: Using-Culture -Culture culture -Script {scriptblock}"), 
[ScriptBlock]$script= ` 
    (throw "USAGE: Using-Culture -Culture culture -Script {scriptblock}")) 
{ 
    $OldCulture = [System.Threading.Thread]::CurrentThread.CurrentCulture 
    $OldUICulture = [System.Threading.Thread]::CurrentThread.CurrentUICulture 
    try { 
     [System.Threading.Thread]::CurrentThread.CurrentCulture = $culture 
     [System.Threading.Thread]::CurrentThread.CurrentUICulture = $culture 
     Invoke-Command $script 
    } 
    finally { 
     [System.Threading.Thread]::CurrentThread.CurrentCulture = $OldCulture 
     [System.Threading.Thread]::CurrentThread.CurrentUICulture = $OldUICulture 
    }  
} 

现在我们来测试它：

PS> gmo|rmo 
PS> ipmo ModTest 
PS> Add-BitsFile -? 

NAME 
    Add-BitsFile 

SYNOPSIS 
    Adds one or more files to an existing Background Intelligent Transfer 
    Service (BITS) transfer job. 

<snip> 

PS> using-culture fr-FR {gmo|rmo; ipmo ModTest; Add-BitsFile -?} 

NAME 
    Add-BitsFile 

SYNOPSIS 
    Parlez vous adds one or more files to an existing Background 
    Intelligent Transfer Service (BITS) transfer job.