New-ExternalHelp
PlatyPS tarafından desteklenen markdown temelinde dış yardım dosyası oluşturur.
Syntax
Default (Varsayılan)
New-ExternalHelp
-Path <String[]>
-OutputPath <String>
[-ApplicableTag <String[]>]
[-Encoding <Encoding>]
[-MaxAboutWidth <Int32>]
[-ErrorLogFile <String>]
[-Force]
[-ShowProgress]
[<CommonParameters>]
Description
New-ExternalHelp cmdlet'i, PlatyPS tarafından desteklenen markdown yardım dosyalarını temel alan bir dış yardım dosyası oluşturur.
Get-Help cmdlet'ini kullanarak yardım sağlamak için bunu bir modülle gönderebilirsiniz.
Belirttiğiniz markdown dosyaları PlatyPS Şemasıizlemiyorsa, bu cmdlet hata iletileri döndürür.
Örnekler
Örnek 1: Klasörün içeriğine göre dış yardım oluşturma
PS C:\> New-ExternalHelp -Path ".\docs" -OutputPath "out\platyPS\en-US"
Directory: D:\Working\PlatyPS\out\platyPS\en-US
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 5/19/2016 12:32 PM 46776 platyPS-help.xml
Bu komut, belirtilen konumda bir dış yardım dosyası oluşturur. Bu komut, klasör adının yerel ayarı içermesi için en iyi yöntemi kullanır.
Örnek 2: Özel kodlama kullanan yardım oluşturma
PS C:\> New-ExternalHelp -Path ".\docs" -OutputPath "out\PlatyPS\en-US" -Force -Encoding ([System.Text.Encoding]::Unicode)
Directory: D:\Working\PlatyPS\out\PlatyPS\en-US
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 5/22/2016 6:34 PM 132942 platyPS-help.xml
Bu komut, belirtilen konumda bir dış yardım dosyası oluşturur. Bu komut, Force parametresini belirtir, bu nedenle var olan bir dosyanın üzerine yazar. komutu, oluşturulan dosya için Unicode kodlamasını belirtir.
Örnek 3: Dosyaya uyarı ve hata yazma
PS C:\> New-ExternalHelp -Path ".\docs" -OutputPath "out\platyPS\en-US" -ErrorLogFile ".\WarningsAndErrors.json"
Directory: D:\Working\PlatyPS\out\platyPS\en-US
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 5/19/2016 12:32 PM 46776 platyPS-help.xml
Bu komut, belirtilen konumda bir dış yardım dosyası oluşturur. Bu komut, klasör adının yerel ayarı içermesi için en iyi yöntemi kullanır. Bu komut uyarıları ve hataları WarningsAndErrors.json dosyasına yazar.
Parametreler
-ApplicableTag
Filtre olarak kullanılacak etiket dizisini belirtin. cmdlet'in yaml meta verilerinde applicable varsa ve geçirilen etiketlerin hiçbiri burada belirtilmiyorsa, oluşturulan yardımda cmdlet yoksayılır. Aynı durum parametre düzeyi applicable yaml meta verileri için de geçerlidir.
applicable atlanırsa, cmdlet veya parametre her zaman mevcut olur. Daha fazla ayrıntı için bkz. tasarım sorunu.
Parametre özellikleri
| Tür: | String[] |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-Encoding
Dış yardım dosyanız için karakter kodlamasını belirtir. System.Text.Encoding nesnesini belirtin. Daha fazla bilgi için bkz. about_Character_Encoding.
Parametre özellikleri
| Tür: | Encoding |
| Default value: | UTF8 without BOM |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-ErrorLogFile
Bu cmdlet'in biçimlendirilmiş sonuç günlük dosyasını kaydettiği yol.
Yol, json uzantısıyla klasörün ve dosya adının konumunu ve adını içermelidir. JSON nesnesi üç özellik içerir: İleti, FilePathve Önem Derecesi (Uyarı veya Hata).
Bu yol sağlanmazsa günlük oluşturulmaz.
Parametre özellikleri
| Tür: | String |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-Force
Bu cmdlet'in aynı ada sahip mevcut bir dosyanın üzerine yazdığını gösterir.
Parametre özellikleri
| Tür: | SwitchParameter |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-MaxAboutWidth
"Hakkında" yardım metin dosyaları oluşturulurken en fazla satır uzunluğunu belirtir. Diğer yardım dosyası türleri bu parametreden etkilenmez. Daha fazla bilgi için bkz. New-MarkdownAboutHelp
Kod bloklarının içindeki satırlar sarmalanmamıştır ve MaxAboutWidth
Parametre özellikleri
| Tür: | Int32 |
| Default value: | 80 |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-OutputPath
Bu cmdlet'in dış yardım dosyanızı kaydettiği klasörün yolunu belirtir. Klasör adı, aşağıdaki örnekte olduğu gibi bir yerel ayar klasörüyle bitmelidir: .\out\PlatyPS\en-US\.
Parametre özellikleri
| Tür: | String |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | True |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-Path
Markdown dosya veya klasörlerinin yol dizisini belirtir. Bu cmdlet, bu dosya ve klasörleri temel alarak dış yardım oluşturur.
Parametre özellikleri
| Tür: | String[] |
| Default value: | None |
| Joker karakterleri destekler: | True |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | True |
| İşlem hattından gelen değer: | True |
| Özellik adına göre işlem hattından gelen değer: | True |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-ShowProgress
Mevcut markdown dosyalarını ayrıştırma altında ilerleme çubuklarını görüntüleyin.
Bu kullanılırsa yardım oluşturma çok daha yavaştır.
Parametre özellikleri
| Tür: | SwitchParameter |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
CommonParameters
Bu cmdlet yaygın parametreleri destekler: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction ve -WarningVariable. Daha fazla bilgi için bkz. about_CommonParameters.
Girişler
String
Bir yol dizisini bu cmdlet'e yöneltebilirsiniz.
Çıkışlar
FileInfo
Bu cmdlet, oluşturulan dosyalar için bir FileInfo[] nesnesi döndürür.
