Megosztás a következőn keresztül:

Online súgó támogatása

Megjegyzés

Az XML-alapú súgó manuális készítése nagyon nehéz. A PlatyPS modul lehetővé teszi, hogy segítséget írjon a Markdownban, majd XML-alapú súgóvá konvertálja. Ez sokkal egyszerűbbé teszi a súgó írását és karbantartását. PlatyPS is létrehozhatja a Frissíthető súgócsomagokat. További információ: Xml-alapú súgó létrehozása a PlatyPShasználatával.

A PowerShell 3.0-tól kezdve kétféleképpen támogathatja a Get-Help Online funkciót a PowerShell-parancsokhoz. Ez a témakör azt ismerteti, hogyan implementálhatja ezt a funkciót különböző parancstípusokhoz.

Tudnivalók az online súgóról

Az online súgó mindig is fontos része volt a PowerShellnek. Bár a Get-Help parancsmag súgótémaköröket jelenít meg a parancssorban, sok felhasználó inkább az online olvasás élményét részesíti előnyben, beleértve a színkódolást, a hivatkozásokat és az ötletek megosztását a közösségi tartalmakban és a wikialapú dokumentumokban. A legfontosabb, hogy az frissíthető súgó megjelenése előtt az online súgó a súgófájlok up-tolegdátumosabb verzióját adta meg.

A PowerShell 3.0 frissíthető súgójának megjelenésével az online súgó továbbra is nélkülözhetetlen szerepet játszik. A rugalmas felhasználói élmény mellett az online súgó segítséget nyújt azoknak a felhasználóknak, akik nem vagy nem tudják használni az Frissíthető súgót a súgótémakörök letöltéséhez.

A Get-Help -Online működése

A parancsok online súgótémaköreinek megkereséséhez a Get-Help parancs online paraméterrel rendelkezik, amely megnyitja a súgótémakör online verzióját a felhasználó alapértelmezett internetböngészőjében.

Az alábbi parancs például megnyitja a Invoke-Command parancsmag online súgótémakörét.

Get-Help Invoke-Command -Online

A Get-Help -Onlineimplementálásához a Get-Help parancsmag egységes erőforrás-azonosítót (URI) keres az online verzió súgótémaköréhez az alábbi helyeken.

  • A parancs súgótémakörének Kapcsolódó hivatkozások szakaszának első hivatkozása. A súgótémakört telepíteni kell a felhasználó számítógépén. Ez a funkció a PowerShell 2.0-ban lett bevezetve.

  • Bármely parancs HelpUri tulajdonsága. A HelpUri tulajdonság akkor is elérhető, ha a parancs súgótémaköre nincs telepítve a felhasználó számítógépén. Ezt a funkciót a PowerShell 3.0-ban vezettük be.

    Get-Help keres egy URI-t a Kapcsolódó hivatkozások szakasz első bejegyzésében, mielőtt megkapja a HelpUri tulajdonság értékét. Ha a tulajdonság értéke helytelen vagy módosult, felülbírálhatja, ha egy másik értéket ad meg az első kapcsolódó hivatkozásban. Az első kapcsolódó hivatkozás azonban csak akkor működik, ha a súgótémakörök telepítve vannak a felhasználó számítógépén.

Bármely parancs Get-Help -Online támogathatja, ha egy érvényes URI-t ad hozzá a parancs XML-alapú súgótémakörének Kapcsolódó hivatkozások szakaszának első bejegyzéséhez. Ez a beállítás csak XML-alapú súgótémakörökben érvényes, és csak akkor működik, ha a súgótémakör telepítve van a felhasználó számítógépén. A súgótémakör telepítése és az URI feltöltésekor ez az érték elsőbbséget élvez a parancs HelpUri tulajdonságával szemben.

A funkció támogatásához az URI-nak az maml:relatedLinks elem első maml:relatedLinks/maml:navigationLink eleme alatti maml:uri elemben kell megjelennie.

Az alábbi XML az URI helyes elhelyezését mutatja. A maml:linkText elem Online version: szövege ajánlott eljárás, de nem kötelező.

<maml:relatedLinks>
    <maml:navigationLink>
        <maml:linkText>Online version:</maml:linkText>
        <maml:uri>https://go.microsoft.com/fwlink/?LinkID=113279</maml:uri>
    </maml:navigationLink>
    <maml:navigationLink>
        <maml:linkText>about_History</maml:linkText>
        <maml:uri/>
    </maml:navigationLink>
</maml:relatedLinks>

A HelpUri tulajdonság hozzáadása parancshoz

Ez a szakasz bemutatja, hogyan adhat hozzá HelpUri tulajdonságot különböző típusú parancsokhoz.

HelpUri-tulajdonság hozzáadása parancsmaghoz

C# nyelven írt parancsmagok esetén adjon hozzá egy HelpUri attribútumot a Parancsmag osztályhoz. Az attribútum értékének olyan URI-nak kell lennie, amely http vagy httpskezdődik.

Az alábbi kód a Get-History parancsmagosztály HelpUri attribútumát mutatja be.

[Cmdlet(VerbsCommon.Get, "History", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=001122")]

HelpUri-tulajdonság hozzáadása speciális függvényhez

Speciális függvények esetén adjon hozzá egy HelpUri tulajdonságot a CmdletBinding attribútumhoz. A tulajdonság értékének egy "http" vagy "https" kezdetű URI-nak kell lennie.

Az alábbi kód a New-Calendar függvény HelpUri attribútumát mutatja be

function New-Calendar {
    [CmdletBinding(SupportsShouldProcess=$true,
    HelpUri="https://go.microsoft.com/fwlink/?LinkID=01122")]

HelpUri-attribútum hozzáadása cim-parancshoz

CIM-parancsok esetén adjon hozzá egy HelpUri attribútumot a CDXML-fájl CmdletMetadata eleméhez. Az attribútum értékének olyan URI-nak kell lennie, amely http vagy httpskezdődik.

Az alábbi kód a Start-Debug CIM-parancs HelpUri attribútumát mutatja be

<CmdletMetadata Verb="Debug" HelpUri="https://go.microsoft.com/fwlink/?LinkID=001122"/>

HelpUri-attribútum hozzáadása munkafolyamathoz

A PowerShell-nyelven írt munkafolyamatok esetében adjon hozzá egy .EXTERNALHELP megjegyzés kulcsszót a munkafolyamat-kódhoz. A kulcsszó értékének olyan URI-nak kell lennie, amely http vagy httpskezdődik.

Megjegyzés

A HelpUri tulajdonság nem támogatott XAML-alapú munkafolyamatokhoz a PowerShellben.

Az alábbi kód egy munkafolyamat-fájl .EXTERNALHELP kulcsszóját mutatja be.

# .EXTERNALHELP "https://go.microsoft.com/fwlink/?LinkID=138338"
  • Last updated on