Delen via

Stijlgids voor PowerShell-documentatie

  • Artikel

Dit artikel bevat stijl richtlijnen die specifiek zijn voor PowerShell-Docs inhoud. Het bouwt voort op de informatie die wordt beschreven in overzicht.

Productterminologie

Er zijn verschillende varianten van PowerShell.

  • PowerShell: Dit is de standaard. PowerShell 7 en meer wordt gezien als powershell.

  • PowerShell Core: PowerShell gebouwd op .NET Core. Gebruik van de term Core moet worden beperkt tot gevallen waarin het nodig is om deze te onderscheiden van Windows PowerShell.

  • Windows PowerShell: PowerShell gebouwd op .NET Framework. Windows PowerShell alleen op een Windows en vereist het volledige framework.

    In het algemeen kunnen verwijzingen naar 'Windows PowerShell' in de documentatie worden gewijzigd in PowerShell. 'Windows PowerShell' moet worden gebruikt wanneer Windows PowerShell-specifiek gedrag wordt besproken.

Verwante producten

  • Visual Studio Code (VS Code) - Dit is de gratis opensource-editor van Microsoft. Bij de eerste vermelding moet de volledige naam worden gebruikt. Daarna kunt u VS Code gebruiken. Gebruik geen VSCode.
  • PowerShell-extensie voor Visual Studio Code: met de extensie wordt VS Code de favoriete IDE voor PowerShell. Bij de eerste vermelding moet de volledige naam worden gebruikt. Daarna kunt u de PowerShell-extensie gebruiken.
  • Azure PowerShell: dit is de verzameling PowerShell-modules die worden gebruikt voor het beheren van Azure-services.
  • Azure Stack PowerShell: dit is de verzameling PowerShell-modules die worden gebruikt voor het beheren van de hybride cloudoplossing van Microsoft.

Markdown-specifieke informatie

Het Microsoft Open Publishing System (OPS) dat onze documentatie bouwt, maakt gebruik van markdig om de Markdown-documenten te verwerken. Markdig parseert de documenten op basis van de regels van de meest recente CommonMark-specificatie.

De nieuwe CommonMark-specificatie is veel strikter over de constructie van sommige Markdown-elementen. Let goed op de details in dit document.

Witregels, spaties en tabs

Witregels geven ook het einde van een blok aan in Markdown. Er moet één witregel tussen verschillende typen Markdown-blokken zijn (zoals tussen een alinea en een lijst of koptekst).

Meerdere opeenvolgende lege regels worden weergegeven als één lege regel in HTML. Ze dienen geen doel. Binnen een codeblok wordt het codeblok door opeenvolgende lege regels afgegeven.

Verwijder extra spaties aan het einde van regels.

Notitie

Spatiegebruik is erg belangrijk in Markdown. Gebruik altijd spaties in plaats van harde tabs. Aan het volgen van spaties kan de manier waarop Markdown wordt weergegeven, worden gewijzigd.

Titels en koppen

Gebruik alleen ATX-kopteksten (kopteksten in #-stijl in plaats van =- of --stijl).

  • Gebruik alleen zinnen - alleen eigennamen en de eerste letter van een titel of koptekst moet een hoofdletter krijgen
  • Er moet één spatie zijn tussen de # en de eerste letter van de koptekst
  • Kopteksten moeten worden omgeven door één lege regel
  • Slechts één H1 per document
  • Headerniveaus moeten met één worden verhoogd. Niveaus niet overslaan
  • Gebruik geen vetgedrukte of andere markeringen in kopteksten

Beperk de lengte van regels tot 100 tekens

Dit geldt voor conceptuele artikelen en cmdlet-naslag. Het beperken van de regellengte verbetert de leesbaarheid van git-verschillen en -geschiedenis. Het maakt het ook eenvoudiger voor andere schrijvers om bijdragen te leveren.

Gebruik de Markdown-extensie Reflow in Visual Studio Code om alinea's eenvoudig om te zetten op basis van de voorgeschreven regellengte.

About_topics zijn beperkt tot 80 tekens. Zie Opmaak van bestanden About_ meer informatie.

Lijsten

Als uw lijst meerdere zinnen of alinea's bevat, kunt u overwegen een koptekst op subniveau te gebruiken in plaats van een lijst.

Lijsten moeten worden omgeven door één lege regel.

Niet-geordende lijsten

Laat lijstitems niet eindigen met een punt, tenzij ze meerdere zinnen bevatten. Gebruik het afbreekstreepje (-) als opsommingsteken voor een lijstitem. Dit voorkomt verwarring met vette of cursieve markeringen, waarbij het sterretje [*] wordt gebruikt. Voeg een regel toe en lijn de inspringing uit met het eerste teken achter het opsommingsteken om een alinea of andere elementen onder een opsomming op te nemen.

Bijvoorbeeld:

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

Dit is een lijst met onderliggende elementen onder een opsommingsteken.

  • Item van eerste opsomming

    Zin met uitleg voor de eerste opsomming.

    • Item onderliggend opsommingsteken

      Zin waarin het onderliggende opsommingsteken wordt uitgelegd.

  • Item van tweede opsomming

  • Item van derde opsomming

Geordende lijsten

Lijn de inspringing uit met het eerste teken achter het itemnummer om een alinea of andere elementen onder een genummerd item op te nemen. Alle items in een genummerde lijst moeten het getal gebruiken in 1. plaats van elk item te verhogen. Bij het weergeven van de Markdown wordt de waarde automatisch verhoogd. Hierdoor kunnen items gemakkelijker in een andere volgorde worden geplaatst en wordt de inspringing van onderliggende inhoud gestandaardiseerd.

Bijvoorbeeld:

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.

De resulterende Markdown wordt als volgt weergegeven:

  1. Plaats bij het eerste element een spatie achter de 1. Lange zinnen moeten passend worden gemaakt op de volgende regel en worden uitgelijnd met het eerste teken na de markering van de genummerde lijst.

    U kunt een tweede element (zoals dit) opnemen door een nieuwe regel na de eerste in te voegen en de inspringing uit te lijnen. De inspringing van het tweede element moet worden uitgelijnd met het eerste teken na de markering van de genummerde lijst. Voor items met één cijfer, zoals dit, springt u in naar kolom 4. Voor items met dubbele cijfers, zoals nummer 10, springt u in naar kolom 5.

  2. Het volgende genummerde item begint hier.

Installatiekopieën

De syntaxis voor het insluiten van een afbeelding is:

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

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

Hierbij is alt text een korte beschrijving van de afbeelding en <folder path> een relatief pad naar de afbeelding. Voor schermlezers voor visueel gehandicapten is alternatieve tekst nodig.

Afbeeldingen moeten worden opgeslagen in een media/<article-name> map in de map met het artikel. Deel geen afbeeldingen tussen artikelen. Maak onder de map media een map die overeenkomt met de bestandsnaam van uw artikel. Kopieer de afbeeldingen voor dat artikel naar de nieuwe map. Als een afbeelding door meerdere artikelen wordt gebruikt, moet elke afbeeldingsmap een kopie van het afbeeldingsbestand bevatten. Dit voorkomt dat een wijziging voor een afbeelding in het ene artikel gevolgen heeft voor het andere artikelen.

De volgende bestandstypen voor afbeeldingen worden ondersteund: *.png , , , , *.gif *.jpeg *.jpg , *.svg

Markdown-extensies ondersteund door Open Publishing

Het Microsoft Docs Authoring Pack bevat hulpprogramma's die ondersteuning bieden voor functies die uniek zijn voor ons publicatiesysteem. Waarschuwingen zijn een Markdown-extensie voor het maken van blockquotes die worden weergegeven op docs.microsoft.com met kleuren en pictogrammen die het belang van de inhoud markeren. De volgende typen waarschuwingen worden ondersteund:

> [!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.

Deze waarschuwingen zien er op docs.microsoft.com als volgt uit:

Opmerkingsblok

Notitie

Information the user should notice even if skimming.

Tipblok

Tip

Optional information to help a user be more successful.

Belangrijk blok

Belangrijk

Essential information required for user success.

Waarschuwingsblok

Waarschuwing

Negative potential consequences of an action.

Waarschuwingsblok

Waarschuwing

Bepaalde gevaarlijke gevolgen van een actie.

  • Hyperlinks moeten de Markdown-syntaxis [friendlyname](url-or-path) gebruiken. Koppelingsverwijzingen worden ondersteund.

  • Het publicatiesysteem ondersteunt drie typen koppelingen:

    • URL-koppelingen
    • Bestandskoppelingen
    • Koppelingen voor kruisverwijzingen

  • Koppelingen naar andere artikelen over docs.microsoft.com moeten site-relatieve paden zijn

  • Alle URL's naar externe websites moeten HTTPS gebruiken, tenzij dat niet geldig is voor de doelsite.

  • Koppelingen moeten een gebruiksvriendelijke naam hebben, meestal de titel van het gekoppelde artikel

  • Alle items in de sectie Gerelateerde koppelingen onderaan moeten een hyperlink bevatten

  • Gebruik geen backticks, vetgedrukte of andere markeringen tussen de haken van een hyperlink.

  • Bare URL's kunnen worden gebruikt wanneer u een specifieke URI documenteert. De URI moet tussen de backticks worden ingesloten. Bijvoorbeeld:

    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.

Koppelen aan andere inhoud op docs.microsoft.com

  • URL-koppelingen naar andere artikelen op docs.microsoft.com moeten site-relatieve paden zijn. De eenvoudigste manier om een relatieve koppeling te maken, is door de URL vanuit uw browser te kopiëren en vervolgens te verwijderen uit de waarde https://docs.microsoft.com/en-us die u in Markdown plakt. Neem geen locales op in URL's van Microsoft-eigenschappen (verwijder /en-us uit URL). Verwijder overbodige queryparameters uit de URL. Voorbeelden die moeten worden verwijderd:

    • ?view=powershell-5.1 - wordt gebruikt om een koppeling te maken naar een specifieke versie van PowerShell
    • ?redirectedfrom=MSDN - toegevoegd aan de URL wanneer u vanuit een oud artikel wordt omgeleid naar de nieuwe locatie

    Als u een koppeling wilt maken naar een specifieke versie van een document, moet u de &preserve-view=true parameter toevoegen aan de queryreeks. Bijvoorbeeld: ?view=powershell-5.1&preserve-view=true

  • Een bestandskoppeling wordt gebruikt om een koppeling te maken van het ene referentieartikel naar het andere, of van het ene conceptuele artikel naar het andere. Als u een koppeling wilt maken naar een referentieartikel voor een specifieke versie van PowerShell, moet u een URL-koppeling gebruiken.

    • Bestandskoppelingen bevatten een relatief bestandspad (bijvoorbeeld: ../folder/file.md )
    • Alle bestandspaden gebruiken tekens met een slash / ()

  • Kruisverwijzingskoppelingen zijn een speciale functie die wordt ondersteund door het publicatiesysteem. U kunt kruisverwijzingskoppelingen in conceptuele artikelen gebruiken om een koppeling te maken naar .NET API of cmdlet-verwijzing.

    Zie Koppelingen in documentatie gebruiken in de centrale gids voor inzenders voor koppelingen naar .NET API-naslaginformatie.

    Koppelingen naar cmdlet-verwijzingen hebben de volgende indeling: xref:<module-name>.<cmdlet-name> . Bijvoorbeeld om een koppeling te maken naar Get-Content de cmdlet in de module Microsoft.PowerShell.Management.

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

Dieptekoppeling is toegestaan voor zowel URL- als bestandskoppelingen. Voeg het anker toe aan het einde van het doelpad. Bijvoorbeeld:

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

Zie Koppelingen gebruiken in de documentatie voor meer informatie.

Syntaxiselementen van opdrachten opmaken

  • Gebruik altijd de volledige naam voor cmdlets en parameters. Vermijd het gebruik van aliassen, tenzij u de alias specifiek demonstreert.

  • Eigenschap, parameter, object, typenamen, klassenamen, klassemethoden moeten vet zijn.

    • Eigenschaps- en parameterwaarden moeten worden verpakt in backticks ( ` ).
    • Wanneer u verwijst naar typen met behulp van de stijl met vierkante haken, gebruikt u backticks. Bijvoorbeeld: [System.Io.FileInfo]

  • Sleutelwoorden voor de taal, namen van cmdlet's, functies, variabelen, systeemeigen EXE's, bestandspaden en voorbeelden van inlinesyntaxis moeten worden verpakt in backtick ` () tekens.

    Bijvoorbeeld:

    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
```

    • PowerShell-trefwoorden en -operators moeten allemaal kleine letters zijn

    • Gebruik de juiste casing (Pascal) voor cmdlet-namen en -parameters

    • Wanneer naar een parameter wordt verwezen aan de hand van de naam, moet de naam vet zijn. Wanneer het gebruik van een parameter met een afbreekstreepje als voorvoegsel wordt gedemonstreerd, moet de parameter tussen accents graves worden geplaatst. Bijvoorbeeld:

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

    • Wanneer een voorbeeld van het gebruik van een externe opdracht wordt gebruikt, moet het voorbeeld tussen accents graves zijn geplaatst. Neem altijd de bestandsextensie op in de native opdracht. Bijvoorbeeld:

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

      Door de bestandsextensie op te geven, zorgt u ervoor dat de juiste opdracht wordt uitgevoerd volgens de prioriteit van de PowerShell-opdracht.

  • Als u een conceptueel artikel (in tegenstelling tot referentie-inhoud) schrijft, moet de eerste instantie van een cmdlet-naam een hyperlink naar de cmdlet-documentatie bevatten. Gebruik geen backticks, vetgedrukte of andere markeringen tussen de haken van een hyperlink.

    Bijvoorbeeld:

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

    Zie de sectie Hyperlinks van dit artikel voor meer informatie.

Markdown voor codevoorbeelden

Markdown ondersteunt twee verschillende codestijlen:

  • Code omspant (inline) - gemarkeerd met één backtick ( ` ) teken. Wordt gebruikt in een alinea in plaats van als een zelfstandig blok.
  • Codeblokken: een blok met meerdere regels dat wordt omgeven door tekenreeksen met drie keer een backtick ``` (). Codeblokken hebben mogelijk ook een taallabel na de backticks. Met het taallabel kunt u syntaxis markeren voor de inhoud van het codeblok.

Alle codeblokken moeten zich binnen een afscheiding bevinden. Gebruik nooit inspringing voor codeblokken. Markdown staat dit patroon toe, maar kan problematisch zijn en moet worden vermeden.

Een codeblok bestaat uit een of meer coderegels, omgeven door een code fence met drie keer een backtick ``` (). De markeringen voor de codeafscheiding moeten zich op een eigen regel voor en na het codevoorbeeld bevinden. De markering na het begin van het codeblok heeft mogelijk een optioneel taallabel. In het Open Publishing System (OPS) van Microsoft wordt het taallabel gebruikt om de functie voor markering van de syntaxis te ondersteunen.

Zie Fenced code blocks in the centralized contributor guide (Engelstalig) voor een volledige lijst met ondersteunde taaltags.

OPS voegt tevens een knop Kopiëren toe waarmee u de inhoud van het codeblok naar het klembord kopieert. Hiermee kunt u de code snel in een script plakken om het codevoorbeeld te testen. Niet alle voorbeelden in onze documentatie zijn echter bedoeld om te worden uitgevoerd zoals ze zijn. Sommige codeblokken zijn eenvoudige illustraties van een PowerShell-concept.

Er worden drie typen codeblokken gebruikt in onze documentatie:

  1. Syntaxisblokken
  2. Illustratieve voorbeelden
  3. Uitvoerbare voorbeelden

Syntaxiscodeblokken

Syntaxiscodeblokken worden gebruikt om de syntactische structuur van een opdracht te beschrijven. Gebruik geen taalcode op het codehek. Dit voorbeeld toont alle mogelijke parameters van de Get-Command-cmdlet.

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

Dit voorbeeld bevat een beschrijving van de for-instructie in algemene termen:

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

Illustratieve voorbeelden

Illustratieve voorbeelden worden gebruikt om een PowerShell-concept uit te leggen. Ze zijn niet bedoeld om te worden gekopieerd naar het klembord voor uitvoering. Deze worden meestal gebruikt voor eenvoudige voorbeelden die eenvoudig te typen en gemakkelijk te begrijpen zijn. Het codeblok kan de PowerShell-prompt en voorbeelduitvoer bevatten.

Hier is een eenvoudig voorbeeld van de PowerShell-vergelijkingsoperators. In dit geval is het niet de bedoeling dat de lezer dit voorbeeld kopieert en uitvoert.

```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
```

Uitvoerbare voorbeelden

Voor complexe voorbeelden, of voorbeelden die zijn bedoeld om te worden gekopieerd en uitgevoerd, moet de volgende blokstijlopmerking worden gebruikt:

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

De uitvoer die door PowerShell-opdrachten wordt weergegeven, moet zich in een Uitvoer-codeblok bevinden om markering van de syntaxis te voorkomen. Bijvoorbeeld:

```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
```

Het codelabel Uitvoer is geen officiële 'taal' die wordt ondersteund door het syntaxis markeringssysteem. Dit label is echter handig omdat OPS het label Uitvoer toevoegt aan het codevakframe op de webpagina. Het codevak Uitvoer heeft geen syntaxis markeren.

Stijlregels voor code

Voortzetting van regels in codevoorbeelden vermijden

Vermijd tekens voor voortzetting van de regel (`) in PowerShell-codevoorbeelden. Deze zijn moeilijk te zien en kunnen problemen veroorzaken als er extra spaties aan het einde van de regel staan.

  • Gebruik PowerShell-splatting om de regellengte te verminderen voor cmdlets met verschillende parameters.
  • Profiteer van de mogelijkheden voor natuurlijke regelbreak van PowerShell, zoals na het pijpje () tekens, het openen van | accolades ( ), haakjes ( ) { en ( haakjes ( [ ).

PowerShell-prompts vermijden in voorbeelden

Het gebruik van de prompt-tekenreeks wordt afgeraden en moet worden beperkt tot scenario's die zijn bedoeld om het gebruik van de opdrachtregel te illustreren. Voor de meeste van deze voorbeelden moet de prompt-tekenreeks PS> zijn. Deze prompt is onafhankelijk van indicatoren voor specifieke besturingssystemen.

Prompts zijn vereist in voorbeelden om opdrachten te illustreren die de prompt wijzigen of wanneer het weergegeven pad belangrijk is voor het scenario. In het volgende voorbeeld wordt getoond hoe de prompt verandert als de registerprovider wordt gebruikt.

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

Gebruik geen aliassen in voorbeelden

Gebruik de volledige naam van alle cmdlets en parameters, tenzij u de alias specifiek documenteert. Cmdlet- en parameternamen moeten gebruikmaken van de juiste Namen met de naam van Dekcase.

Parameters gebruiken in voorbeelden

Vermijd het gebruik van positionele parameters. Over het algemeen moet u altijd de parameternaam opnemen in een voorbeeld, zelfs als de parameter positioneel is. Dit verkleint de kans op verwarring in uw voorbeelden.

Naslagartikelen voor cmdlet opmaken

Artikelen met naslaginformatie voor cmdlets hebben een specifieke structuur. Deze structuur wordt gedefinieerd door PlatyPS. PlatyPS genereert de Help voor cmdlet voor PowerShell-modules in Markdown. Nadat de Markdown-bestanden zijn bewerkt, wordt PlatyPS gebruikt om de MAML-helpbestanden te maken die door de Get-Help-cmdlet worden gebruikt.

In PlatyPS is een in code vastgelegd schema voor cmdlet-naslaginformatie. Dit schema is in de code geschreven. In het document platyPS. schema.md is deze structuur beschreven. Schendingen van het schema veroorzaken compilatiefouten die moeten worden opgelost voordat we uw bijdrage kunnen accepteren.

  • Verwijder geen van de ATX-headerstructuren. PlatyPS verwacht een specifieke reeks kopteksten.
  • De kopteksten Inputtype en Outputtype moeten een type hebben. Als de cmdlet geen invoer gebruikt of een waarde retourneert, gebruikt u de waarde None .
  • In elke alinea kunnen inline codereeksen worden gebruikt.
  • Omhingelcodeblokken zijn alleen toegestaan in de sectie VOORBEELDEN.

In het PlatyPS-schema is VOORBEELDEN een H2-header. Elk voorbeeld is een H3-header. In een voorbeeld staat het schema niet toe dat codeblokken worden gescheiden door alinea's. Het schema maakt de volgende structuur mogelijk:

### Example X - Title sentence

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

Geef elk voorbeeld een nummer en voeg een korte titel toe.

Bijvoorbeeld:

### 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_-bestanden opmaken

About_* -bestanden worden geschreven in Markdown, maar worden verzonden als bestanden met tekst zonder tekst. We gebruiken Pandoc om de Markdown te converteren naar tekst zonder tekst. About_* -bestanden worden geformatteerd voor de beste compatibiliteit voor alle versies van PowerShell en met de publicatiehulpprogramma's.

Algemene richtlijnen voor het opmaken:

  • Normale regels beperken tot 80 tekens

  • Codeblokken zijn beperkt tot 76 tekens

  • Blokquotes (en waarschuwingen) zijn beperkt tot 78 tekens

  • Wanneer u deze speciale metatekens \ gebruikt, $ , en < :

    • Binnen een koptekst moeten deze tekens een escape-teken gebruiken met behulp van een vooraanstaand teken of tussen \ code omspannen met behulp van backticks ( ` )

    • Binnen een alinea moeten deze tekens in codeperioden worden gezet. Bijvoorbeeld:

      ### The purpose of the \$foo variable

The `$foo` variable is used to store ...

  • Tabellen moeten binnen 76 tekens passen

    • Laat inhoud van cellen die over meerdere regels valt handmatig teruglopen

    • Gebruik op elke regel |-tekens voor openen en sluiten

    • In het volgende voorbeeld ziet u hoe u op de juiste wijze een tabel maakt die informatie bevat die op meerdere regels in een cel wordt verpakt.

      ```
|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`|
```

      Notitie

      De beperking van 76 kolommen geldt alleen voor About_* onderwerpen. U kunt brede kolommen gebruiken in conceptuele of cmdlet-referentieartikelen.

Volgende stappen

Redactionele controlelijst