diff --git a/ITG.Readme.psm1 b/ITG.Readme.psm1 index 8911f8a..6e6137c 100644 --- a/ITG.Readme.psm1 +++ b/ITG.Readme.psm1 @@ -767,14 +767,14 @@ Function Get-Readme { .Outputs String. Содержимое readme.md. + .Link + https://github.com/IT-Service/ITG.Readme#Get-Readme .Link [MarkDown]: "MarkDown (md) Syntax" .Link about_comment_based_help .Link [Написание справки для командлетов](http://go.microsoft.com/fwlink/?LinkID=123415) - .Link - https://github.com/IT-Service/ITG.Readme#Get-Readme .Example Get-Module 'ITG.Yandex.DnsServer' | Get-Readme | Out-File -Path 'readme.md' -Encoding 'UTF8' -Width 1024; Генерация readme.md файла для модуля `ITG.Yandex.DnsServer` @@ -788,7 +788,8 @@ Function Get-Readme { #> [CmdletBinding( - DefaultParametersetName='ModuleInfo' + DefaultParametersetName = 'ModuleInfo' + , HelpUri = 'https://github.com/IT-Service/ITG.Readme#Get-Readme' )] param ( @@ -1250,6 +1251,8 @@ Function Set-Readme { System.Management.Automation.FunctionInfo. Описатели функций, для которых будет сгенерирован readme.md. Получены описатели могут быть через Get-Command. + .Link + https://github.com/IT-Service/ITG.Readme#Set-Readme .Link Get-Readme .Link @@ -1258,8 +1261,6 @@ Function Set-Readme { about_comment_based_help .Link [Написание справки для командлетов](http://go.microsoft.com/fwlink/?LinkID=123415) - .Link - https://github.com/IT-Service/ITG.Readme#Set-Readme .Example Get-Module 'ITG.Yandex.DnsServer' | Set-Readme; Генерация readme.md файла для модуля `ITG.Yandex.DnsServer` @@ -1277,6 +1278,7 @@ Function Set-Readme { DefaultParametersetName = 'ModuleInfo' , SupportsShouldProcess = $true , ConfirmImpact = 'Low' + , HelpUri = 'https://github.com/IT-Service/ITG.Readme#Set-Readme' )] param ( @@ -1420,21 +1422,22 @@ Function Get-AboutModule { .Outputs String. Содержимое about.txt. + .Link + https://github.com/IT-Service/ITG.Readme#Get-AboutModule .Link [MarkDown]: "MarkDown (md) Syntax" .Link about_comment_based_help .Link [Написание справки для командлетов](http://go.microsoft.com/fwlink/?LinkID=123415) - .Link - https://github.com/IT-Service/ITG.Readme#Get-AboutModule .Example Get-Module 'ITG.Yandex.DnsServer' | Get-AboutModule; Генерация содержимого about.txt файла для модуля `ITG.Yandex.DnsServer`. #> [CmdletBinding( - DefaultParametersetName='ModuleInfo' + DefaultParametersetName = 'ModuleInfo' + , HelpUri = 'https://github.com/IT-Service/ITG.Readme#Get-AboutModule' )] param ( @@ -1495,6 +1498,8 @@ Function Set-AboutModule { System.Management.Automation.PSModuleInfo. Описатели модулей, для которых будет сгенерирован readme.md. Получены описатели могут быть через Get-Module. + .Link + https://github.com/IT-Service/ITG.Readme#Set-AboutModule .Link Get-AboutModule .Link @@ -1503,8 +1508,6 @@ Function Set-AboutModule { about_comment_based_help .Link [Написание справки для командлетов](http://go.microsoft.com/fwlink/?LinkID=123415) - .Link - https://github.com/IT-Service/ITG.Readme#Set-AboutModule .Example Get-Module 'ITG.Yandex.DnsServer' | Set-AboutModule; Генерация `about_ITG.Yandex.DnsServer.txt` файла для модуля `ITG.Yandex.DnsServer` @@ -1515,6 +1518,7 @@ Function Set-AboutModule { DefaultParametersetName='ModuleInfo' , SupportsShouldProcess = $true , ConfirmImpact = 'Low' + , HelpUri = 'https://github.com/IT-Service/ITG.Readme#Set-AboutModule' )] param ( @@ -1747,21 +1751,22 @@ Function New-HelpXML { .Outputs System.Xml.XmlDocument Содержимое XML справки. + .Link + https://github.com/IT-Service/ITG.Readme#New-HelpXML .Link about_Comment_Based_Help .Link about_Updatable_Help .Link [Creating the Cmdlet Help File](http://msdn.microsoft.com/en-us/library/bb525433.aspx) - .Link - https://github.com/IT-Service/ITG.Readme#New-HelpXML .Example Get-Module 'ITG.Yandex.DnsServer' | New-HelpXML; Генерация xml справки для модуля `ITG.Yandex.DnsServer`. #> [CmdletBinding( - DefaultParametersetName='ModuleInfo' + DefaultParametersetName = 'ModuleInfo' + , HelpUri = 'https://github.com/IT-Service/ITG.Readme#New-HelpXML' )] param ( @@ -2027,12 +2032,12 @@ Function Get-HelpXML { .Outputs System.Xml.XmlDocument Содержимое XML справки. + .Link + https://github.com/IT-Service/ITG.Readme#Get-HelpXML .Link about_Updatable_Help .Link [Creating the Cmdlet Help File](http://msdn.microsoft.com/en-us/library/bb525433.aspx) - .Link - https://github.com/IT-Service/ITG.Readme#Get-HelpXML .Example Get-Module 'ITG.Yandex.DnsServer' | Get-HelpXML; Возвращает содержимое xml файла справки для модуля `ITG.Yandex.DnsServer` @@ -2040,7 +2045,8 @@ Function Get-HelpXML { #> [CmdletBinding( - DefaultParametersetName='ModuleInfo' + DefaultParametersetName = 'ModuleInfo' + , HelpUri = 'https://github.com/IT-Service/ITG.Readme#Get-HelpXML' )] param ( @@ -2140,12 +2146,14 @@ Function Set-HelpXML { System.Management.Automation.CmdletInfo Описатели командлет. Именно для них и будет сгенерирована XML справка. Получены описатели могут быть через `Get-Command`. + .Link + https://github.com/IT-Service/ITG.Readme#Set-HelpXML + .Link + Get-HelpXML .Link about_Updatable_Help .Link [Creating the Cmdlet Help File](http://msdn.microsoft.com/en-us/library/bb525433.aspx) - .Link - https://github.com/IT-Service/ITG.Readme#Set-HelpXML .Example Get-Module 'ITG.Yandex.DnsServer' | Set-HelpXML; Генерация xml файла справки для модуля `ITG.Yandex.DnsServer` @@ -2153,9 +2161,10 @@ Function Set-HelpXML { #> [CmdletBinding( - DefaultParametersetName='ModuleInfo' + DefaultParametersetName = 'ModuleInfo' , SupportsShouldProcess = $true , ConfirmImpact = 'Low' + , HelpUri = 'https://github.com/IT-Service/ITG.Readme#Set-HelpXML' )] param ( @@ -2350,12 +2359,12 @@ Function New-HelpInfo { .Outputs System.Xml.XmlDocument Содержимое XML манифеста (HelpInfo.xml) справки. + .Link + https://github.com/IT-Service/ITG.Readme#New-HelpInfo .Link about_Updatable_Help .Link Set-HelpInfo - .Link - https://github.com/IT-Service/ITG.Readme#New-HelpInfo .Link [HelpInfo XML Sample File](http://msdn.microsoft.com/en-us/library/windows/desktop/hh852750.aspx) .Example @@ -2364,7 +2373,8 @@ Function New-HelpInfo { #> [CmdletBinding( - DefaultParametersetName='ModuleInfo' + DefaultParametersetName = 'ModuleInfo' + , HelpUri = 'https://github.com/IT-Service/ITG.Readme#New-HelpInfo' )] param ( @@ -2443,14 +2453,14 @@ Function Get-HelpInfo { .Outputs System.Xml.XmlDocument Содержимое XML манифеста (HelpInfo.xml) справки. + .Link + https://github.com/IT-Service/ITG.Readme#Get-HelpInfo .Link about_Updatable_Help .Link Set-HelpInfo .Link New-HelpInfo - .Link - https://github.com/IT-Service/ITG.Readme#Get-HelpInfo .Link [How to Name a HelpInfo XML File](http://msdn.microsoft.com/en-us/library/windows/desktop/hh852748.aspx) .Link @@ -2461,7 +2471,8 @@ Function Get-HelpInfo { #> [CmdletBinding( - DefaultParametersetName='ModuleInfo' + DefaultParametersetName = 'ModuleInfo' + , HelpUri = 'https://github.com/IT-Service/ITG.Readme#Get-HelpInfo' )] param ( @@ -2521,10 +2532,14 @@ Function Set-HelpInfo { Получены описатели могут быть через `Get-Module`. .Outputs None. + .Link + https://github.com/IT-Service/ITG.Readme#Set-HelpInfo .Link about_Updatable_Help .Link - https://github.com/IT-Service/ITG.Readme#Set-HelpInfo + Get-HelpInfo + .Link + New-HelpInfo .Link [HelpInfo XML Sample File](http://msdn.microsoft.com/en-us/library/windows/desktop/hh852750.aspx) .Example @@ -2533,9 +2548,10 @@ Function Set-HelpInfo { #> [CmdletBinding( - DefaultParametersetName='ModuleInfo' + DefaultParametersetName = 'ModuleInfo' , SupportsShouldProcess = $true , ConfirmImpact = 'Medium' + , HelpUri = 'https://github.com/IT-Service/ITG.Readme#Set-HelpInfo' )] param ( diff --git a/readme.md b/readme.md index 6537315..07b0790 100644 --- a/readme.md +++ b/readme.md @@ -559,6 +559,8 @@ HelpInfo.xml в каталоге модуля, либо создаёт новы - [Online версия справки](https://github.com/IT-Service/ITG.Readme#Set-HelpInfo) - [about_Updatable_Help][] +- [Get-HelpInfo][] +- [New-HelpInfo][] - [HelpInfo XML Sample File](http://msdn.microsoft.com/en-us/library/windows/desktop/hh852750.aspx) #### Get-HelpXML @@ -856,6 +858,7 @@ HelpInfo.xml в каталоге модуля, либо создаёт новы ##### См. также - [Online версия справки](https://github.com/IT-Service/ITG.Readme#Set-HelpXML) +- [Get-HelpXML][] - [about_Updatable_Help][] - [Creating the Cmdlet Help File](http://msdn.microsoft.com/en-us/library/bb525433.aspx) diff --git a/ru-RU/ITG.Readme-help.xml b/ru-RU/ITG.Readme-help.xml index d41ff11..b692bd5 100644 --- a/ru-RU/ITG.Readme-help.xml +++ b/ru-RU/ITG.Readme-help.xml @@ -100,6 +100,9 @@ + + https://github.com/IT-Service/ITG.Readme#Get-AboutModule + [MarkDown]: <http://daringfireball.net/projects/markdown/syntax> "MarkDown (md) Syntax" @@ -109,9 +112,6 @@ [Написание справки для командлетов](http://go.microsoft.com/fwlink/?LinkID=123415) - - https://github.com/IT-Service/ITG.Readme#Get-AboutModule - @@ -188,6 +188,9 @@ + + https://github.com/IT-Service/ITG.Readme#Get-HelpInfo + about_Updatable_Help @@ -197,9 +200,6 @@ New-HelpInfo - - https://github.com/IT-Service/ITG.Readme#Get-HelpInfo - [How to Name a HelpInfo XML File](http://msdn.microsoft.com/en-us/library/windows/desktop/hh852748.aspx) @@ -306,13 +306,13 @@ - about_Updatable_Help + https://github.com/IT-Service/ITG.Readme#Get-HelpXML - [Creating the Cmdlet Help File](http://msdn.microsoft.com/en-us/library/bb525433.aspx) + about_Updatable_Help - https://github.com/IT-Service/ITG.Readme#Get-HelpXML + [Creating the Cmdlet Help File](http://msdn.microsoft.com/en-us/library/bb525433.aspx) @@ -539,6 +539,9 @@ + + https://github.com/IT-Service/ITG.Readme#Get-Readme + [MarkDown]: <http://daringfireball.net/projects/markdown/syntax> "MarkDown (md) Syntax" @@ -548,9 +551,6 @@ [Написание справки для командлетов](http://go.microsoft.com/fwlink/?LinkID=123415) - - https://github.com/IT-Service/ITG.Readme#Get-Readme - @@ -657,13 +657,13 @@ - about_Updatable_Help + https://github.com/IT-Service/ITG.Readme#New-HelpInfo - Set-HelpInfo + about_Updatable_Help - https://github.com/IT-Service/ITG.Readme#New-HelpInfo + Set-HelpInfo [HelpInfo XML Sample File](http://msdn.microsoft.com/en-us/library/windows/desktop/hh852750.aspx) @@ -781,6 +781,9 @@ + + https://github.com/IT-Service/ITG.Readme#New-HelpXML + about_Comment_Based_Help @@ -790,9 +793,6 @@ [Creating the Cmdlet Help File](http://msdn.microsoft.com/en-us/library/bb525433.aspx) - - https://github.com/IT-Service/ITG.Readme#New-HelpXML - @@ -917,6 +917,9 @@ + + https://github.com/IT-Service/ITG.Readme#Set-AboutModule + Get-AboutModule @@ -929,9 +932,6 @@ [Написание справки для командлетов](http://go.microsoft.com/fwlink/?LinkID=123415) - - https://github.com/IT-Service/ITG.Readme#Set-AboutModule - @@ -1060,11 +1060,17 @@ + + https://github.com/IT-Service/ITG.Readme#Set-HelpInfo + about_Updatable_Help - https://github.com/IT-Service/ITG.Readme#Set-HelpInfo + Get-HelpInfo + + + New-HelpInfo [HelpInfo XML Sample File](http://msdn.microsoft.com/en-us/library/windows/desktop/hh852750.aspx) @@ -1269,13 +1275,16 @@ - about_Updatable_Help + https://github.com/IT-Service/ITG.Readme#Set-HelpXML - [Creating the Cmdlet Help File](http://msdn.microsoft.com/en-us/library/bb525433.aspx) + Get-HelpXML - https://github.com/IT-Service/ITG.Readme#Set-HelpXML + about_Updatable_Help + + + [Creating the Cmdlet Help File](http://msdn.microsoft.com/en-us/library/bb525433.aspx) @@ -1543,6 +1552,9 @@ + + https://github.com/IT-Service/ITG.Readme#Set-Readme + Get-Readme @@ -1555,9 +1567,6 @@ [Написание справки для командлетов](http://go.microsoft.com/fwlink/?LinkID=123415) - - https://github.com/IT-Service/ITG.Readme#Set-Readme - \ No newline at end of file