Frissíthető súgó – áttekintés

Ez a dokumentum alapvető bevezetést nyújt a PowerShell frissíthető súgófunkciójának tervezéséhez és működéséhez. A modulkészítőknek és a Windows PowerShell súgótémaköröket a felhasználóknak kézbesítő felhasználóknak készült.

Bevezetés

A PowerShell súgótémakörök a PowerShell-élmény szerves részét képezik. A PowerShell-modulokhoz hasonlóan a súgótémaköröket is folyamatosan frissítik és fejlesztik a szerzők és a PowerShell-felhasználók közösségének hozzájárulásai.

A Windows PowerShell 3.0-ban bevezetett Frissíthető súgó funkció biztosítja, hogy a felhasználók a parancssorban a súgótémakörök legújabb verzióival rendelkezzenek, akár beépített PowerShell-parancsok esetén is, új modulok letöltése vagy a Windows Update futtatása nélkül. Az frissíthető súgó egyszerűvé teszi a frissítést azáltal, hogy olyan parancsmagokat biztosít, amelyek letöltik a súgótémakörök legújabb verzióit az internetről, és a megfelelő alkönyvtárakba telepítik őket a felhasználó helyi számítógépén. Még a tűzfalak mögött álló felhasználók is használhatják az új parancsmagokat egy belső fájlmegosztás frissített súgójának beszerzéséhez.

Az frissíthető súgót teljes mértékben támogatja a Windows 8 és a Windows Server 2012 összes Windows PowerShell-modulja, és funkciói minden Windows PowerShell-modul szerzője számára elérhetők. Az frissíthető súgó csak XML-alapú súgófájlokat támogat. Nem támogatja a megjegyzésalapú súgót.

Az frissíthető súgó az alábbi funkciókat tartalmazza.

• A Update-Help parancsmag, amely meghatározza, hogy a felhasználók rendelkeznek-e a legújabb súgófájlokkal egy modulhoz, és ha nem, letölti a legújabb súgófájlokat az internetről, kicsomagolja őket, és telepíti őket a megfelelő modul alkönyvtárakba a felhasználó számítógépén. A felhasználók a Get-Help parancsmaggal azonnal megtekinthetik az újonnan telepített súgótémaköröket. Nem kell újraindítaniuk a PowerShellt.

• A Mentési súgó parancsmag, amely letölti a legújabb súgófájlokat az internetről, és egy fájlrendszerkönyvtárba menti őket. A felhasználók a Update-Help parancsmaggal kérhetnek le súgófájlokat a fájlrendszer könyvtárából, majd kicsomagolhatják és telepítheti őket a felhasználó számítógépének modul alkönyvtáraiban. A Save-Help parancsmag olyan felhasználók számára készült, akik korlátozott vagy nem rendelkeznek internet-hozzáféréssel, valamint azoknak a vállalatoknak, akik inkább korlátozzák az internet-hozzáférést.

• Modulsúgója. A modul súgófájljait egységként kezelik és kézbesítik, így a felhasználók az általuk használt modulokhoz tartozó összes súgófájlt lekérhetik. Az frissíthető súgó csak modulokhoz támogatott, Windows PowerShell beépülő modulokhoz nem.

• verziótámogatási. Az frissíthető súgó szabványos négypozíciós (N1) pozíciót használ. N2. N3. N4) verziószámok. Az frissíthető súgók akkor töltik le a súgófájlokat, ha a felhasználó számítógépén (vagy a Save-Help könyvtárban) található súgófájlok verziószáma alacsonyabb, mint az internetes helyen található súgófájlok verziószáma.

• többnyelvű támogatási. Az frissíthető súgó több felhasználói felületen is támogatja a modul súgófájljait. Az frissíthető súgófájlnevek közé tartoznak a szabványos nyelvi kódok, például a "en-US" és a "ja-JP", a Update-Help és Save-Help parancsmagok pedig a modulkönyvtár nyelvspecifikus alkönyvtáraiba helyezik a súgófájlokat.

• automatikusan létrehozott súgó. A Get-Help parancsmag alapvető súgót jelenít meg a súgófájlokkal nem rendelkező parancsokhoz. Az automatikusan létrehozott súgó tartalmazza a parancs szintaxisát és aliasát, valamint az online súgó és az Frissíthető súgó használatának utasításait.

• Továbbfejlesztett online súgó. Az online súgóhoz való könnyű hozzáféréshez már nincs szükség súgófájlokra. A Get-Help parancsmag Online paramétere mostantól lekéri egy online súgótémakör URL-címét bármely parancs HelpUri tulajdonságának értékéből, ha nem találja az online súgó URL-címét egy súgófájlban. A HelpUri tulajdonság feltöltéséhez adjon hozzá egy HelpUri attribútumot a parancsmagok, függvények és CIM-parancsok kódjába, vagy használja a .LINK megjegyzésalapú súgó kulcsszót munkafolyamatokban és szkriptekben.

  A súgófájlok frissíthetővé tétele érdekében a Windows Windows PowerShell-moduljai nem tartalmazzák a súgófájlokat. A felhasználók az Frissíthető súgó segítségével telepíthetik és frissíthetik a súgófájlokat. Más modulok szerzői súgófájlokat is tartalmazhatnak a modulokban, vagy kihagyhatják őket. Az frissíthető súgó támogatása nem kötelező, de ajánlott.