Online súgó támogatása

A PowerShell 3.0-s verziótól kezdve a PowerShell-parancsok online funkcióját kétféleképpen Get-Help lehet támogatni. Ez a témakör bemutatja, hogyan valósíthatja meg ezt a funkciót a különböző parancstípusokhoz.

Az online súgó

Az online súgó mindig is fontos része volt a PowerShellnek. Bár a parancsmag súgótémakört 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 közösségi tartalomban és wikialapú dokumentumokban való Get-Help megosztását. A legfontosabb, hogy a frissíthető súgó megjelenése előtt az online súgó a súgófájlok legfrissebb verzióját biztosította.

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

Az Get-Help működése – Online

Annak érdekében, hogy a felhasználók megtalálják a parancsok online súgótémakörét, a parancs online paraméterrel rendelkezik, amely megnyitja a súgótémakör online verzióját egy parancshoz a felhasználó alapértelmezett Get-Help webböngészőjében.

A következő parancs például megnyitja a parancsmag online Invoke-Command súgótémakörét.

Get-Help Invoke-Command -Online

A megvalósításához a parancsmag egy Uniform Resource Identifier (URI) keres az online verzió súgótémakörét a Get-Help -Online Get-Help következő helyeken.

• A parancs súgótémakörének Kapcsolódó hivatkozások szakaszában található első hivatkozás. 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. Ez a funkció a PowerShell 3.0-ban lett bevezetve.

  Get-HelpA a Kapcsolódó hivatkozások szakasz első bejegyzésében egy URI-t keres, mielőtt lekérte volna a HelpUri tulajdonság értékét. Ha a tulajdonság értéke helytelen vagy megváltozott, felülírhatja egy másik érték megadásával az első kapcsolódó hivatkozásban. Az első kapcsolódó hivatkozás azonban csak akkor működik, ha a súgótémakörei telepítve vannak a felhasználó számítógépén.

URI hozzáadása egy parancs súgótémakörének első kapcsolódó hivatkozáshoz

Bármilyen parancsot támogathat, ha hozzáad egy érvényes URI-t a parancs XML-alapú súgótémakörének Kapcsolódó hivatkozások szakaszában Get-Help -Online található első bejegyzéshez. Ez a beállítás csak AZ 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. Ha a súgótémakör telepítve van, és az URI ki van töltve, ez az érték elsőbbséget élvez a parancs HelpUri tulajdonsága felett.

A funkció támogatásához az URI-nak meg kell jelennie a elem első eleme maml:uri maml:relatedLinks/maml:navigationLink maml:relatedLinks alatt.

A következő XML az URI helyes elhelyezését mutatja be. A Online version: elem szövege ajánlott maml:linkText 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 egy parancshoz

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

HelpUri tulajdonság hozzáadása parancsmaghoz

A C# nyelven írt parancsmagok számára adjon hozzá egy HelpUri attribútumot a Parancsmag osztályhoz. Az attribútum értékének olyan URI-nak kell lennie, amely vagy értékkel http https kezdődik.

Az alábbi kód a parancsmagosztály HelpUri Get-History 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 használata érdekében adjon hozzá egy HelpUri tulajdonságot a CmdletBinding attribútumhoz. A tulajdonság értékének egy "http" vagy "https" előtaggal kezdődik URI-nak kell lennie.

Az alábbi kód a függvény HelpUri attribútumát New-Calendar 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-parancsokhoz adjon hozzá egy HelpUri attribútumot a CMdletMetadata elemhez a CDXML-fájlban. Az attribútum értékének olyan URI-nak kell lennie, amely vagy értékkel http https kezdődik.

Az alábbi kód a CIM-parancs HelpUri Start-Debug 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 munkafolyamatokhoz adjon hozzá egy et. ExternalHelp comment irányelv a munkafolyamat kódhoz. A irányelv értékének olyan URI-nak kell lennie, amely vagy értékkel http https kezdődik.

Megjegyzés

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

Az alábbi kód a következőt mutatja be: . ExternalHelp irányelv egy munkafolyamat-fájlban.

# .ExternalHelp "https://go.microsoft.com/fwlink/?LinkID=138338"