Delen via

Overzicht van Help die kan worden bijgewerkt

  • Artikel

Dit document bevat een eenvoudige inleiding tot het ontwerp en de werking van de Help-functie voor PowerShell Updatable. Het is ontworpen voor moduleauteurs en anderen die Help-onderwerpen voor Windows PowerShell aan gebruikers leveren.

Introductie

Help-onderwerpen voor PowerShell vormen een integraal onderdeel van de PowerShell-ervaring. Net als PowerShell-modules worden Help-onderwerpen voortdurend bijgewerkt en verbeterd door de auteurs en door de bijdragen van de community van PowerShell-gebruikers.

De Help--functie, geïntroduceerd in Windows PowerShell 3.0, zorgt ervoor dat gebruikers de nieuwste versies van Help-onderwerpen hebben bij de opdrachtprompt, zelfs voor ingebouwde PowerShell-opdrachten, zonder nieuwe modules te downloaden of Windows Update uit te voeren. Bijgewerkte Help maakt het bijwerken eenvoudig door cmdlets op te geven die de nieuwste versies van Help-onderwerpen van internet downloaden en installeren in de juiste submappen op de lokale computer van de gebruiker. Zelfs gebruikers die zich achter firewalls bevinden, kunnen de nieuwe cmdlets gebruiken om bijgewerkte hulp te krijgen van een interne bestandsshare.

Help kan worden bijgewerkt, wordt volledig ondersteund door alle Windows PowerShell-modules in Windows 8 en Windows Server 2012 en de functies zijn beschikbaar voor alle auteurs van Windows PowerShell-modules. Help kan worden bijgewerkt, ondersteunt alleen HELP-bestanden op basis van XML. Het biedt geen ondersteuning voor hulp op basis van opmerkingen.

Help kan worden bijgewerkt met de volgende functies.

  • De cmdlet Update-Help, waarmee wordt bepaald of gebruikers de nieuwste Help-bestanden voor een module hebben en, indien niet, de nieuwste Help-bestanden van internet downloaden, uitpakken en installeren in de juiste modulesubmappen op de computer van de gebruiker. Gebruikers kunnen de cmdlet Get-Help gebruiken om de zojuist geïnstalleerde Help-onderwerpen onmiddellijk weer te geven. Ze hoeven PowerShell niet opnieuw te starten.

  • De cmdlet Save-Help, waarmee de nieuwste Help-bestanden van internet worden gedownload en opgeslagen in een bestandssysteemmap. Gebruikers kunnen de cmdlet Update-Help gebruiken om Help-bestanden op te halen uit de map van het bestandssysteem en ze uit te pakken en te installeren in de submappen van de module op de computer van de gebruiker. De Save-Help cmdlet is ontworpen voor gebruikers die beperkte of geen internettoegang hebben en voor ondernemingen die de internettoegang liever beperken.

  • Help voor een module. Help-bestanden voor een module worden beheerd en geleverd als een eenheid, zodat gebruikers alle Help-bestanden kunnen ophalen voor de modules die ze gebruiken. Hulp die kan worden bijgewerkt, wordt alleen ondersteund voor modules, niet voor Windows PowerShell-modules.

  • -versieondersteuning. Help kan worden bijgewerkt met standaard vier posities (N1). N2. N3. N4) versienummers. Help-bestanden kunnen worden bijgewerkt wanneer het versienummer van de Help-bestanden op de computer van de gebruiker (of in de map Save-Help) lager is dan het versienummer van de Help-bestanden op de internetlocatie.

  • ondersteuning voor meerdere talen. Help kan worden bijgewerkt, ondersteunt help-bestanden voor modules in meerdere UI-culturen. Bestandsnamen van Help kunnen worden bijgewerkt, bevatten standaardtaalcodes, zoals 'en-US' en 'ja-JP', en de Update-Help- en Save-Help-cmdlets plaatsen de Help-bestanden in taalspecifieke submappen van de modulemap.

  • automatisch gegenereerde Help-. De cmdlet Get-Help geeft basishulp weer voor opdrachten die geen Help-bestanden hebben. De automatisch gegenereerde Help bevat de syntaxis en aliassen van de opdracht en instructies voor het gebruik van online-Help en Help-informatie die kan worden bijgewerkt.

  • Uitgebreide online help-. Eenvoudige toegang tot onlinehulp vereist geen Help-bestanden meer. De parameter Online van de cmdlet Get-Help haalt nu de URL van een online-Help-onderwerp op uit de waarde van de eigenschap HelpUri van een opdracht, als de URL van de online-Help niet in een Help-bestand kan worden gevonden. U kunt de eigenschap HelpUri vullen door een HelpUri-kenmerk toe te voegen aan de code van cmdlets, functies en CIM-opdrachten, of door het .LINK help-trefwoord op basis van opmerkingen toe te voegen in werkstromen en scripts.

    Om onze Help-bestanden updatable te maken, worden de Windows PowerShell-modules in Windows niet geleverd met Help-bestanden. Gebruikers kunnen Help bijwerken gebruiken om Help-bestanden te installeren en bij te werken. Auteurs van andere modules kunnen Help-bestanden in modules bevatten of ze weglaten. Ondersteuning voor Updatable Help is optioneel, maar wordt aanbevolen.