A PowerShell Docs stílusútmutatója

Ez a cikk stílusra vonatkozó útmutatást nyújt a PowerShell-Docs tartalomhoz. Az Áttekintés című témakörben ismertetett információkra épül.

Termék-terminológia

A PowerShellnek több változata létezik.

• PowerShell – Ez az alapértelmezés. Mi a PowerShell 7-es és az azt túlmutatót tekintjük valódi PowerShellnek.

• PowerShell Core – .NET Core-on készült PowerShell. A Core kifejezés használatát olyan esetekre kell korlátozni, ahol meg kell különböztetni a Windows PowerShell.

• Windows PowerShell – A PowerShell a .NET-keretrendszer. Windows PowerShell kizárólag a Windows, és a teljes keretrendszerre van szükség.

  Általánosságban elmondható, hogy a dokumentációban Windows PowerShell hivatkozások PowerShellre módosíthatók. A "Windows PowerShell" akkor használatos, Windows PowerShell adott viselkedést tárgyalunk.

Kapcsolódó termékek

• Visual Studio Code (VS Code) – Ez a Microsoft ingyenes, nyílt forráskódú szerkesztője. Az első említéskor a teljes nevet kell használni. Ezt követően használhatja a VS Code-et. Ne használja a "VSCode" kódot.
• PowerShell-bővítmény Visual Studio Code-hez – A bővítmény a VS Code-et a PowerShell előnyben részesített IDE-jjét váltja. Az első említéskor a teljes nevet kell használni. Ezt követően használhatja a PowerShell-bővítményt.
• Azure PowerShell – Ez az Azure-szolgáltatások kezeléséhez használt PowerShell-modulok gyűjteménye.
• Azure Stack PowerShell – Ez a Microsoft hibridfelhő-megoldásának kezeléséhez használt PowerShell-modulok gyűjteménye.

Markdown-specifikus adatok

A dokumentációt buildelő Microsoft Open Publishing System (OPS) a Markdig segítségével feldolgoz egy Markdown-dokumentumot. A Markdig a legújabb CommonMark-specifikáció szabályai alapján elemezi a dokumentumokat.

Az új CommonMark specifikáció sokkal szigorúbban vonatkozik egyes Markdown-elemek konstrukcióira. Fordítson különös figyelmet a dokumentumban megadott adatokra.

Üres sorok, szóközök és tabulátorok

A Markdownban üres sorok jelzik a blokkok végét is. A különböző típusú Markdown-blokkok (például bekezdés és lista vagy fejléc) között egyetlen üres sornak kell lennie.

Több egymást követő üres sor egyetlen üres sorként jelenik meg a HTML-ben. Nem szolgálnak célt. Egy kódblokkon belül az egymást követő üres sorok megszakítják a kódblokkot.

A sorok végéről távolítsa el a felesleges szóközöket.

Megjegyzés

A Markdownban fontos szerepet játszanak a térközök. Tabulátorok helyett mindig szóközöket használjon. A záró szóközök megváltoztathatják a Markdown renderelését.

Címek és fejlécek

Csak ATX-fejléceket használjon (# stílus, a = vagy - típusú fejlécek helyett).

• Használja megfelelően a kezdőbetűket. Csak a tulajdonneveket és a cím vagy fejléc első szavát kezdje nagybetűvel
• A # jel és a fejléc első betűje között egyetlen szóköznek kell lennie
• A fejléceket egy-egy üres sor zárja közre
• Egy dokumentumban csak egy H1 fejléc legyen
• A fejlécszintek eggyel nőnek. Ne hagyja ki a szinteket
• Ne használjon félkövér vagy más jelölőt a fejlécben

A sorok legfeljebb 100 karakterre korlátozása

Ez fogalmi cikkekre és parancsmagreferenciákra vonatkozik. A sor hosszának korlátozása javítja a Git-különbség és -előzmények olvashatóságát. Más írók számára is megkönnyíti a közreműködést.

A Reflow Markdown bővítményt a Visual Studio Code-ban használhatja a bekezdések egyszerű újratolására, hogy illeszkedjenek az előírt sorhosszhoz.

About_topics legfeljebb 80 karakterből állhat. További információ: About_ formázása.

Listák

Ha a lista több mondatot vagy bekezdést tartalmaz, érdemes lehet lista helyett egy alszintű fejlécet használni.

A listákat egy-egy üres sor zárja közre.

Számozatlan listák

Ne végződtetsen ponttal a listaelemeket, kivéve, ha több mondatot tartalmaznak. A listaelemek listajeleként használja a kötőjel (-) karaktert. Így nem téveszthető össze félkövér vagy dőlt betűk csillag [*] karaktert használó jelölésével. Ha egy listajel alá más elemeket is fel kíván venni, szúrjon be egy sortörést, a behúzást pedig igazítsa a listajel utáni első karakterhez.

Például:

This is a list that contain child elements under a bullet item.

- First bullet item

  Sentence explaining the first bullet.

  - Child bullet item

    Sentence explaining the child bullet.

- Second bullet item
- Third bullet item

Ez egy lista, amely egy listajel alatti gyermekelemeket tartalmaz.

• Első listajeles elem

  Az első elemet magyarázó mondat.

  • Gyermek listajeles elem

    A gyermekjelet magyarázó mondat.

• Második listajeles elem

• Harmadik listajeles elem

Rendezett listák

Ha bekezdést vagy más elemet szeretne elhelyezni egy számozott elem alá, igazítsa a behúzást az elem sorszáma utáni első karakterhez. A számokkal listázott elemek mindegyikének a számot kell használnia 1. az egyes elemek növelése helyett. A Markdown-megjelenítés automatikusan növeli az értékeket. Ezáltal egyszerűbben hajtható végre az elemek átrendezése és az alárendelt tartalom behúzása.

Például:

1. For the first element, insert a single space after the 1. Long sentences should be
   wrapped to the next line and must line up with the first character after the numbered
   list marker.

   To include a second element (like this one), insert a line break after the first
   and align indentations. The indentation of the second element must line up with
   the first character after the numbered list marker. For single digit items, like
   this one, you indent to column 4. For double digits items, for example item number
   10, you indent to column 5.

1. The next numbered item starts here.

Az eredményül kapott Markdown a következőképpen jelenik meg:

1. Az első elemnél szúrjon be egyetlen szóközt az 1. sorszám után. A hosszú mondatokat tördelje a következő sorba, és az első karaktert igazítsa a listasorszám utáni első karakterhez.

   Egy második (ehhez hasonló) elem elhelyezéséhez szúrjon be sortörést az első után, és igazítsa egymáshoz a behúzásokat. A második elem behúzásának a listasorszám utáni első karakterrel kell egy vonalban lennie. Egyjegyű sorszámoknál ehhez a 4. oszlopig kell behúzni. Kétjegyű sorszámoknál, amilyen például a 10., az 5. oszlopig kell behúzni.

2. Itt kezdődik a következő számozott elem.

Képek

Kép beágyazásának szintaxisa:

![[alt text]](<folderPath>)

Example:
![Introduction](./media/overview/Introduction.png)

Ahol az alt text (helyettesítő szöveg) a kép rövid leírása, a <folder path> (mappa elérési útja) pedig a kép relatív elérési útja. A helyettesítő szövegek a gyengén látó felhasználók által használt képernyőolvasó programokhoz szükségesek.

A képeket a cikket tartalmazó mappában kell media/<article-name> tárolni. Ne osson meg képeket a cikkek között. A media mappában hozzon létre egy mappát, amelynek neve megegyezik a cikk fájlnevével. A cikkhez tartozó képeket másolja be ebben az új mappába. Ha egy képet több cikkben is használ, akkor minden képmappában meg kell lennie a képfájl egy példányának. Így elkerülhető, hogy egy cikk egy képének módosítása más cikkeket is érintsen.

A következő képfájltípusok támogatottak: *.png , *.gif , , *.jpeg *.jpg , *.svg

Az Open Publishing által támogatott Markdown-bővítmények

A Microsoft Docs tartalomszerkesztő csomag olyan eszközöket tartalmaz, amelyek a közzétételi rendszer egyedi funkcióit támogatják. A riasztások Markdown-bővítmények, amelyek a tartalom pontosságát docs.microsoft.com színekkel és ikonokkal renderelő idézeteket hoznak létre. A következő riasztási típusok támogatottak:

> [!NOTE]
> Information the user should notice even if skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]
> Essential information required for user success.

> [!CAUTION]
> Negative potential consequences of an action.

> [!WARNING]
> Dangerous certain consequences of an action.

Ezek a riasztások a következőképpen jelennek meg a docs.microsoft.com webhelyen:

Megjegyzésblokk

Megjegyzés

Olyan információk, amelyeket a felhasználónak akkor is észre kell vennie, ha csak átfutja a szöveget.

Tipp blokk

Tipp

Olyan kiegészítő információk, amelyek segítenek a felhasználónak sikeresebben végezni a munkafolyamatot.

Fontos blokk

Fontos

Alapvető információk, amelyek feltétlenül szükségesek a sikeres végrehajtáshoz.

Figyelemblokk

Figyelemfelhívás

Egy művelet potenciális negatív következményei.

Figyelmeztetési blokk

Figyelmeztetés

Egy művelet meghatározott veszélyes következményei.

Hivatkozások

• A hivatkozásoknak Markdown szintaxist kell [friendlyname](url-or-path) használniuk. A hivatkozási hivatkozások támogatottak.

• A közzétételi rendszer háromféle hivatkozást támogat:

  • URL-hivatkozások
  • Fájlhivatkozások
  • Kereszthivatkozások

• Az egyéb cikkekre mutató hivatkozásoknak docs.microsoft.com helyhez viszonyított elérési utaknak kell lennie

• A külső webhelyek összes URL-címének HTTPS-t kell használnia, kivéve, ha az nem érvényes a célhelyre.

• A hivatkozásoknak felhasználóbarát névvel, általában a hivatkozott cikk címének kell lennie

• A lap alján található Kapcsolódó hivatkozások szakasz összes elemének hivatkozásnak kell lennie

• Ne használjon a hivatkozások szögletes zárójelei között félkövér, félkövér vagy más jelölőt.

• Az üres URL-címek egy adott URI dokumentálásakor használhatók. Az URI-t a háttérben kell lennie. Például:

  By default, if you don't specify this parameter, the DMTF standard resource URI
  `http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/` is used and the class name is appended to it.
  

Hivatkozás más tartalmakra a docs.microsoft.com

• Az egyéb cikkekre mutató URL-docs.microsoft.com helyhez viszonyított elérési utaknak kell lennie. Relatív hivatkozás legegyszerűbben úgy hozható létre, ha kimásolva az URL-címet a böngészőből, majd eltávolítja a https://docs.microsoft.com/en-us Markdown-ba beilleszteni kívánt értékből. A Microsoft-tulajdonságok URL-címében ne szerepeljenek területi adatok (eltávolítás /en-us az URL-címből). Távolítsa el a szükségtelen lekérdezési paramétereket az URL-címből. Eltávolítható példák:

  • ?view=powershell-5.1 – a PowerShell egy adott verziójára mutató hivatkozáshoz használható
  • ?redirectedfrom=MSDN – hozzáadódik az URL-címhez, amikor egy régi cikkből átirányítják az új helyre

  Ha egy dokumentum egy adott verziójára kell hivatkozni, akkor hozzá kell adni a paramétert a &preserve-view=true lekérdezési sztringhez. Például: ?view=powershell-5.1&preserve-view=true

• A fájlhivatkozások az egyik referenciacikkből a másikba, vagy egy fogalmi cikkből a másikba való hivatkozáshoz használhatók. Ha a PowerShell egy adott verziójával kapcsolatos referenciacikkre kell hivatkozni, url-hivatkozást kell használnia.

  • A fájlhivatkozások relatív elérési utat tartalmaznak (például: ../folder/file.md )
  • Minden fájl elérési útja perjelet ( / ) használ

• A kereszthivatkozások a közzétételi rendszer által támogatott speciális funkciók. A fogalmi cikkekben kereszthivatkozásokat használhat a .NET API-hoz vagy a parancsmagok referenciáihoz.

  A .NET API-referencia hivatkozásaiért lásd a központi közreműködői útmutató Hivatkozások használata a dokumentációban témakörét.

  A parancsmagok referenciáira mutató hivatkozások formátuma a következő: xref:<module-name>.<cmdlet-name> . Például a Get-Content Microsoft.PowerShell.Management modulban található parancsmagra mutató hivatkozáshoz.

  [Get-Content](xref:Microsoft.PowerShell.Management.Get-Content)

A mélyhivatkozás URL-címeken és fájlhivatkozásokon is engedélyezett. Adja hozzá a célútvonal végi horgonyt. Például:

• [about_Splatting](about_Splatting.md#splatting-with-arrays)
• [custom key bindings](https://code.visualstudio.com/docs/getstarted/keybindings#_custom-keybindings-for-refactorings)

További információ: Hivatkozások használata a dokumentációban.

A parancsszintaxis elemeinek formázása

• A parancsmagok és paraméterek mindig a teljes nevet használják. Ne használja az aliasokat, kivéve, ha kifejezetten az aliast mutatja be.

• A tulajdonság, a paraméter, az objektum, a típusnevek, az osztálynevek és az osztály metódusának félkövérnek kell lennie.

  • A tulajdonság- és paraméterértékeket a backticks ( ) használatával kell ` becsomagolni.
  • Ha szögletes zárójeles stílust használó típusokra hivatkozik, használjon backtickset. Például: [System.Io.FileInfo]

• A nyelvi kulcsszavakat, a parancsmagok nevét, a függvényeket, a változókat, a natív EXE-ket, a fájlútvonalak és a beágyazott szintaxispélyokat backtick ( ) karakterekbe kell ` csomagolni.

  Például:

  The following code uses `Get-ChildItem` to list the contents of `C:\Windows` and assigns
  the output to the `$files` variable.
  
  ```powershell
  $files = Get-ChildItem C:\Windows
  ```
  

  • A PowerShell-kulcsszavaknak és -operátoroknak csak kisbetűkből kell álla

  • A parancsmagok neveihez és paramétereihez használja a megfelelő (Casc)-t

  • Ha egy paramétert a nevével említ, akkor a név legyen félkövér. Ha a kötőjel-előtagú paraméter használatát mutatja be, a paramétert zárja fordított aposztrófok közé. Például:

    The parameter's name is **Name**, but it's typed as `-Name` when used on the command
    line as a parameter.
    

  • Ha külső parancs használatára mutat be példát, akkor ezt a példát írja fordított aposztrófok közé. Mindig foglalja bele a fájlkiterjesztést a natív parancsba. Például:

    To start the spooler service on a remote computer named DC01, you type `sc.exe \\DC01 start spooler`.
    

    A fájlkiterjesztéssel biztosítható, hogy a megfelelő parancs végrehajtása a PowerShell parancs-sorrendjének megfelelően legyen végrehajtva.

• Ha elméleti cikket ír (nem pedig referenciatartalmat), akkor a parancsmag nevének első előfordulását lássa el a parancsmag dokumentációjára mutató hivatkozással. Ne használjon a hivatkozások szögletes zárójelei között félkövér, félkövér vagy más jelölőt.

  Például:

  This [Write-Host](/powershell/module/Microsoft.PowerShell.Utility/Write-Host) cmdlet
  uses the **Object** parameter to ...
  

  További információt a cikk Hivatkozások szakaszában talál.

Markdown kódmintákhoz

A Markdown két különböző kódstílust támogat:

• A kód (beágyazott) – egyetlen backtick ( ) karakterrel ` van megjelölve. Nem önálló blokkként, hanem bekezdésben használható.
• Kódblokkok – többsoros blokk, amelyet háromsoros ( ``` ) sztringek vesznek körül. A kódblokkok mögött egy nyelvi címke is lehet. A nyelvi címke lehetővé teszi a szintaxiskiemelőt a kódblokk tartalmához.

Minden kódblokknak kóddobozon belül kell szerepelni. Soha ne használjon behúzást kódblokkok esetén. A Markdown lehetővé teszi ezt a mintát, de problémás lehet, és kerülendő.

A kódblokk egy vagy több kódsor, amelyet egy három-hátlapú ( ``` ) kódkerítés vesz körül. A kóddoboz jelölőinek egy önálló sorban kell szerepelniük a kódminta előtt és után. A kódblokk elején található jelölőhöz opcionálisan tartozhat egy nyelvet jelölő címke is. A Microsoft Open Publishing System (OPS) a nyelvi címkét a szintaxis-kiemelési funkció támogatásához használja.

A támogatott nyelvcímkék teljes listáját a központi közreműködői útmutató körülkerített kódblokkokat tartalmaz.

Az OPS egy Másolás gombot is megjelenít, amellyel a kódblokk tartalma a vágólapra másolható. Így gyorsan beillesztheti a kódot egy szkriptbe a kódminta tesztelése érdekében. A dokumentációban azonban nem minden példa rendeltetésszerűen futtatható. Egyes kódblokkok a PowerShell-fogalmak egyszerű illusztrációi.

A dokumentációban háromféle kódblokkot használunk:

1. Szintaxisblokkok
2. Szemléltető példák
3. Végrehajtható példák

Szintaxiskódblokkok

A szintaxiskódblokkok a parancsok szintaktikai szerkezetének leírására használhatók. Ne használjon nyelvi címkét a kódkerítésen. Ez a példa a Get-Command parancsmag összes lehetséges paraméterét mutatja be.

```
Get-Command [-Verb <String[]>] [-Noun <String[]>] [-Module <String[]>]
  [-FullyQualifiedModule <ModuleSpecification[]>] [-TotalCount <Int32>] [-Syntax]
  [-ShowCommandInfo] [[-ArgumentList] <Object[]>] [-All] [-ListImported]
  [-ParameterName <String[]>] [-ParameterType <PSTypeName[]>] [<CommonParameters>]
```

Ez a példa a for utasítás általános ismertetésére szolgál:

```
for (<init>; <condition>; <repeat>)
{<statement list>}
```

Szemléltető példák

A szemléltető példákat az adott PowerShell-fogalom elmagyarázására használjuk. Nem arra szánták őket, hogy a vágólapra másolhatók végrehajtásra. Ezeket leggyakrabban olyan egyszerű példákhoz használják, amelyek könnyen gépelhetőek és könnyen érthetők. A kódblokk tartalmazhatja a PowerShell-parancssort és a példakimenetet.

Az alábbi egyszerű példa a PowerShell összehasonlító operátorokat mutatja be. Ebben az esetben nem az a cél, hogy az olvasó átmásolja és futtassa a példakódot.

```powershell
PS> 2 -eq 2
True

PS> 2 -eq 3
False

PS> 1,2,3 -eq 2
2

PS> "abc" -eq "abc"
True

PS> "abc" -eq "abc", "def"
False

PS> "abc", "def" -eq "abc"
abc
```

Végrehajtható példák

Az összetett példáknak vagy a másolni és végrehajtani kívánt példáknak a következő blokk stílusú jelölőt kell használniuk:

```powershell
<Your PowerShell code goes here>
```

A PowerShell-parancsok által megjelenített kimeneteknek a szintaxis-kiemelés elkerülése érdekében egy Kimenet típusú kódblokkban kell szerepelniük. Például:

```powershell
Get-Command -Module Microsoft.PowerShell.Security
```

```Output
CommandType  Name                        Version    Source
-----------  ----                        -------    ------
Cmdlet       ConvertFrom-SecureString    3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       ConvertTo-SecureString      3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Get-Acl                     3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Get-AuthenticodeSignature   3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Get-CmsMessage              3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Get-Credential              3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Get-ExecutionPolicy         3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Get-PfxCertificate          3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       New-FileCatalog             3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Protect-CmsMessage          3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Set-Acl                     3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Set-AuthenticodeSignature   3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Set-ExecutionPolicy         3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Test-FileCatalog            3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Unprotect-CmsMessage        3.0.0.0    Microsoft.PowerShell.Security
```

A Kimeneti kód címkéje nem a szintaxiskiemelő rendszer által támogatott hivatalos "nyelv". Ez a címke azonban azért hasznos, mert az OPS hozzáadja a "Kimenet" címkét a weblap kóddobozához. Az "Output" (Kimenet) kódmező nem tartalmaz szintaxiskiemelőt.

A kódolási stílus szabályai

Kerülje a sorfolytató karakterek használatát

A PowerShell-példakódoknál kerülje a többsoros utasításokat lehetővé tevő sorfolytató karakterek (`) használatát. Amellett, hogy nehéz őket észrevenni, problémákat is okozhat, ha a sorok végén extra szóközök vannak.

• A Több paraméterrel is rendelkezik parancsmagok sorhosszának csökkentése a PowerShell-splatting használatával.
• Használja ki a PowerShell természetes sortörési lehetőségeit, például a pipe ( ) karakterek után, a zárójelek ( ), a zárójelek ( ) és a szögletes | { ( zárójelek ( [ ) után.

Kerülje a PowerShell-parancssor szerepeltetését a példákban

A parancssori sztring használata nem ajánlott, és a parancssori használatot szemléltető forgatókönyvekre kell korlátozni. A legtöbb példában a parancssori sztringnek a következőnek kell lennie: PS> . Ez a parancssor mentes minden olyan jellemzőtől, amelyek az operációs rendszerre utalnak.

A példákban parancssorra van szükség a parancssort megváltoztató parancsok szemléltetésére, illetve arra az esetekre, amikor a megjelenített elérési út jelentős a forgatókönyvben. A következő példa azt szemlélteti, hogyan változik a parancssor a beállításjegyzék-szolgáltató használatakor.

PS C:\> cd HKCU:\System\
PS HKCU:\System\> dir

    Hive: HKEY_CURRENT_USER\System

Name                   Property
----                   --------
CurrentControlSet
GameConfigStore        GameDVR_Enabled                       : 1
                       GameDVR_FSEBehaviorMode               : 2
                       Win32_AutoGameModeDefaultProfile      : {2, 0, 1, 0...}
                       Win32_GameModeRelatedProcesses        : {1, 0, 1, 0...}
                       GameDVR_HonorUserFSEBehaviorMode      : 0
                       GameDVR_DXGIHonorFSEWindowsCompatible : 0

Ne használjon aliasokat a példákban

Használja az összes parancsmag és paraméter teljes nevét, kivéve, ha kifejezetten az aliast dokumentálja. A parancsmagok és a paraméterek neveinek a megfelelő, Nagybani-kis- és kis- és nagy neveket kell használniuk.

Paraméterek használata a példákban

Kerülje a pozícióparaméterek használatát. Általában mindig érdemes a paraméter nevét is szerepeltetni egy példában, még akkor is, ha a paraméter pozíciójú. Ez segít elkerülni a félreértéseket a példákban.

A formázási parancsmagokkal kapcsolatos referenciacikkek

A parancsmag-referenciák speciális struktúrájú cikkek. Ezt a struktúrát a PlatyPS határozza meg. A PlatyPS létrehozza a Parancsmagok súgóját a Markdown powershell-moduljaihoz. A Markdown-fájlok szerkesztése után a PlatyPS használatával hozhatók létre a Get-Help parancsmag által használt MAML-súgófájlok.

A PlatyPS a kódba írva tartalmazza a parancsmag-referencia rögzített sémáját. A platyPS.schema.md dokumentum ennek a struktúrának a leírására tesz kísérletet. A sémáktól való eltérés buildelési hibákhoz vezethetnek, amelyeket ki kell javítani ahhoz, hogy elfogadjuk a közreműködését.

• Ne távolítsa el az ATX fejlécstruktúráit. A PlatyPS meghatározott fejléceket vár.
• Az Input type és Output type fejléc típusát mindenképpen meg kell adni. Ha a parancsmag nem bemenetet vagy értéket ad vissza, használja a None értéket.
• Beágyazott kódszakaszok bármely bekezdésben használhatók.
• A körülkerített kódblokkok csak a PÉLDÁK szakaszban engedélyezettek.

A PlatyPS sémában a EXAMPLES egy H2 fejléc. Minden példa egy H3 fejléc. Egy példán belül a séma nem teszi lehetővé, hogy a kódblokkokat bekezdések választják el egymástól. A séma a következő struktúrát teszi lehetővé:

### Example X - Title sentence

0 or more paragraphs
1 or more code blocks
0 or more paragraphs.

Minden példát lásson el sorszámmal és tömör címmel.

Például:

### Example 1: Get cmdlets, functions, and aliases

This command gets the PowerShell cmdlets, functions, and aliases that are installed on the
computer.

```powershell
Get-Command
```

### Example 2: Get commands in the current session

```powershell
Get-Command -ListImported
```

About_ fájlok formázása

About_* A fájlok Markdown formátumban vannak megírva, de egyszerű szöveges fájlokként vannak kiállítva. A Markdown egyszerű szöveggé alakítása a Pandoc használatával. About_* A fájlok a PowerShell összes verziójával és a közzétételi eszközökkel való legjobb kompatibilitás érdekében vannak formázva.

Alapvető formázási irányelvek:

• Normál sorok korlátozása 80 karakterre

• A kódblokkok legfeljebb 76 karakterből állhatnak

• Az idézőjelek (és riasztások) legfeljebb 78 karakterből állhatnak

• Ha ezeket a speciális meta karaktereket \ használja, $ a , és < a karaktereket:

  • A fejlécen belül ezeket a karaktereket kezdő karakterrel kell escape-karakterrel vagy kódfedőkkel \ () körülzárni `

  • Egy bekezdésen belül ezeket a karaktereket kódtartományba kell tenni. Például:

    ### The purpose of the \$foo variable
    
    The `$foo` variable is used to store ...
    

• A tábláknak 76 karakteren belül kell elférni

  • A cellák tartalmát tördelje manuálisan több sorba

  • Minden sorban használja a nyitó és a záró | karaktert

  • Az alábbi példa egy olyan tábla megfelelő felépítését mutatja be, amely egy cella több sorára tördelt információkat tartalmaz.

    ```
    |Operator|Description                |Example                          |
    |--------|---------------------------|---------------------------------|
    |`-is`   |Returns TRUE when the input|`(get-date) -is [DateTime]`      |
    |        |is an instance of the      |`True`                           |
    |        |specified .NET type.       |                                 |
    |`-isNot`|Returns TRUE when the input|`(get-date) -isNot [DateTime]`   |
    |        |not an instance of the     |`False`                          |
    |        |specified.NET type.        |                                 |
    |`-as`   |Converts the input to the  |`"5/7/07" -as [DateTime]`        |
    |        |specified .NET type.       |`Monday, May 7, 2007 12:00:00 AM`|
    ```
    

    Megjegyzés

    A 76 oszlopra vonatkozó korlátozás csak a About_* témakörökre vonatkozik. Széles oszlopokat fogalmi vagy parancsmag-referencia cikkekben használhat.

Következő lépések

Szerkesztési ellenőrzőlista