A PlatyPS áttekintése

PlatyPS a Get-Helphasználatával megjelenített PowerShell-súgó létrehozásának elsődleges eszköze. A PowerShell-súgófájlok Microsoft Assistance Markup Language (MAML) formátumban vannak megírva. A MAML XML-sémát határoz meg a súgófájlok szerkezetéhez.

A PlatyPS két fő verziója létezik.

• A Microsoft.PowerShell.PlatyPS v1.0.1 a PlatyPS támogatott verziója. Ez a verzió egy teljes átírás a C#-ban, Markdig a Markdown elemzéséhez. Ez a kiadás számos fejlesztést tartalmaz:
  • Pontosabb leírást nyújt a PowerShell-parancsmagokról és paramétereiről
  • Nagyobb teljesítmény – több mint 1000 Markdown-fájlt dolgoz fel másodpercek alatt
  • Létrehoz egy objektummodellt a súgófájlból, amelyet a memóriában kezelhet
  • Olyan parancsmagokat biztosít, amelyek összekapcsolhatók az összetett műveletek végrehajtásához
  • Definiál egy új Markdown-sémát, amely tartalmazza az Get-Helpszükséges összes elemet, valamint a korábban nem elérhető információkat.
  • Adja meg a meglévő Markdown automatikus átalakítását (a régi sémát használva) új objektumokra, lehetővé téve az új Markdownba, YAML-be vagy MAML-be való exportálást.
• A platyPS v0.14.2 a PlatyPS eredeti implementációja. Ez a verzió már nem támogatott.

A PlatyPS használatának előnyei

A PlatyPS előtt a súgófájlokat kézzel írták, a meglévő eszközök és szerkesztők korlátozott segítségével. A PlatyPS leegyszerűsíti a folyamatot azáltal, hogy lehetővé teszi a súgófájlok Markdownba írását, majd MAML-re konvertálását.

A Markdown könnyen megtanulható, széles körben használják a nyílt forráskódú közösségben, és számos szerkesztő támogatja, beleértve a Visual Studio Code-ot is. A Markdown könnyen konvertálható más formátumokba, például HTML-be és PDF-be. Ezekkel a Markdown-fájlokkal MAML-súgófájlokat hozhat létre, és HTML-oldalakat hozhat létre egy webhelyhez.

Első lépések a PlatyPS-szel

A PlatyPS használatának megkezdése előtt meg kell értenie a PowerShell által támogatott súgótípusokat. További információ: Súgótípusok a PowerShellben.

A súgófájlok létrehozása a PlatyPS segítségével négy lépésből áll:

1. Hozzon létre új vagy frissítse a meglévő Markdown-súgófájlokat.
2. Szerkessze a Markdown súgófájljait leírások és példák hozzáadásához.
3. Tesztelje a Markdown súgófájljait , hogy megbizonyosodjon arról, hogy megfelelően jelennek meg.
4. Konvertálja és tegye közzé a súgófájlokat.