Skip to content

Commit

Permalink
+ добавил генерацию раздела "Примечания" в readme.md по разделу .Notes (
Browse files Browse the repository at this point in the history
  • Loading branch information
sergey-s-betke committed Sep 21, 2013
1 parent 75a1d03 commit 719dd4a
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 5 deletions.
20 changes: 15 additions & 5 deletions ITG.Readme.psm1
Original file line number Diff line number Diff line change
Expand Up @@ -1052,18 +1052,15 @@ $( $loc.FunctionsDescriptionFull -replace '.','-')
##### $( $loc.Component )
$($Help.Component)
$( $Help.Component )
"@
};
if ( $Help.Functionality ) {
$Description = `
$Help.Functionality `
;
@"
##### $( $loc.Functionality )
$Description
$( $Help.Functionality )
"@
};
if ( $Help.Role ) {
Expand Down Expand Up @@ -1159,6 +1156,19 @@ $ExNum. $( [String]::Format( $loc.Example, $ExNum ) )
"@
};
};
if ( $Help.alertSet ) {
@"
##### $( $loc.Notes )
"@
(
$Help.alertSet.alert `
| Select-Object -ExpandProperty Text `
| Out-String `
| Expand-Definitions `
) -replace "(`r`n)+$", '';
};
if ( $Help.relatedLinks ) {
@"
Expand Down
1 change: 1 addition & 0 deletions en-US/ITG.Readme.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ ReturnValues = Return values
Parameters = Parameters
Examples = Examples
Example = Example {0}.
Notes = Notes
RelatedLinks = Related links
OnlineHelp = Online help
GeneratorAbout = Generator: [{0}]({1} "PowerShell module for readme.md creating").
Expand Down
8 changes: 8 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -423,6 +423,10 @@ HelpInfo.XML по сути является манифестом для xml сп

Get-Module 'ITG.Yandex.DnsServer' | New-HelpInfo;

##### Примечания

Для записи HelpInfo.xml файла используйте [Set-HelpInfo][].

##### См. также

- [Online версия справки](https://github.com/IT-Service/ITG.Readme#New-HelpInfo)
Expand Down Expand Up @@ -797,6 +801,10 @@ HelpInfo.xml в каталоге модуля, либо создаёт новы

Get-Module 'ITG.Yandex.DnsServer' | Set-HelpXML;

##### Примечания

Необходимо дополнительное тестирование на PowerShell 3.

##### См. также

- [Online версия справки](https://github.com/IT-Service/ITG.Readme#Set-HelpXML)
Expand Down
1 change: 1 addition & 0 deletions ru-RU/ITG.Readme.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ ReturnValues = Передаваемые по конвейеру данные
Parameters = Параметры
Examples = Примеры использования
Example = Пример {0}.
Notes = Примечания
RelatedLinks = См. также
OnlineHelp = Online версия справки
GeneratorAbout= Генератор: [{0}]({1} "Модуль PowerShell для генерации readme для модулей PowerShell").
Expand Down

0 comments on commit 719dd4a

Please sign in to comment.