Frissíthető súgó írása: Részletes útmutató

Ez a dokumentum a Frissíthető súgó létrehozása folyamatának lépéseit sorolja fel.

Frissíthető súgó írása: Részletes útmutató

A frissíthető súgó végfelhasználók számára lett kialakítva, de jelentős előnyökkel is jár a modul készítői és a súgóírók számára, beleértve a tartalom hozzáadásának, a hibák kijavítása, a több felhasználói felületi kultúrában való kézbesítésének, valamint a felhasználói megjegyzésekre és kérésekre való válaszadásnak a képességét a modul kiszállítását követően. Ez a témakör azt ismerteti, hogyan csomagolhat és tölthet fel súgófájlokat, hogy a felhasználók letöltsék és telepítsék őket az Update-Help és a Save-Help parancsmagok használatával.

Az alábbi lépések áttekintést nyújtanak a frissíthető súgó támogatásához.

1. lépés: A súgófájlok internetes helyének megkeresása

A frissíthető súgó létrehozásának első lépése egy internetes hely megkeresása a modul súgófájlja számára. Valójában két különböző helyet is használhat. A modul súgóinformációs fájlját (HelpInfo XML – alább) egy internetes helyen, a súgótartalom CAB-fájljait pedig egy másik internetes helyen tarthatja meg. Egy modul összes CAB-tartalmának ugyanazon a helyen kell lennie. A különböző modulokhoz szükséges CAB-fájlok súgótartalmakat ugyanazon a helyen is el lehet helyezze.

2. lépés: HelpInfoURI kulcs hozzáadása a moduljegyzékhez

Adjon hozzá egy HelpInfoURI kulcsot a moduljegyzékhez. A kulcs értéke a Uniform Resource Identifier HelpInfo XML-információs fájl helyének URI-értéke. A biztonság érdekében a címnek "http" vagy "https" előtaggal kell kezdődnie. Az URI-nak meg kell adnia egy internetes helyet, de nem tartalmazhatja a HelpInfo XML-fájlnevet.

Például:

@{
RootModule = TestModule.psm1
ModuleVersion = '2.0'
HelpInfoURI = 'https://go.microsoft.com/fwlink/?LinkID=0123'
}

3. lépés: HelpInfo XML-fájl létrehozása

A HelpInfo XML információs fájl tartalmazza a súgófájlok internetes helyének URI-ját és a modul legújabb súgófájlszámait az egyes támogatott felhasználói felületi kulturális környezetben. Minden Windows PowerShell modul egy HelpInfo XML-fájllal rendelkezik. Ha frissíti a súgófájlokat, szerkeszti vagy lecseréli a HelpInfo XML-fájlt; Nem kell újabbat hozzáadnia. További információ: HelpInfo XML-fájl létrehozása.

4. lépés: CAB-fájlok létrehozása

A modul súgófájlokat tartalmazó CAB-fájl létrehozásához használjon kabinetfájlokat .cab () tartalmazó eszközt() (például MakeCab.exe ). Hozzon létre külön CAB-fájlt a súgófájlokhoz az egyes támogatott felhasználói felületi kulturális környezetben. További információ: Frissíthető CAB-súgófájlok előkészítése.

5. lépés: A fájlok feltöltése

Új vagy frissített súgófájlok közzétételéhez töltse fel a CAB-fájlokat a HelpInfo XML-fájl HelpContentUri eleme által megadott internetes helyre. Ezután töltse fel a HelpInfo XML-fájlt az internetre, amelyet a moduljegyzék HelpInfoUri kulcsának értéke ad meg.