Paketmetadatenwerte, die sich auf die Benutzeroberfläche des PowerShell-Katalogs auswirken

In diesem Artikel wird erläutert, wie die Metadaten in Ihren Paketen vom PowerShell-Katalog verwendet werden. Bei Modulen werden die Metadaten im Modulmanifest gespeichert. Bei Skripten werden die Metadaten mit kommentarbasierten Schlüsselwörtern gespeichert. Die folgenden Cmdlets werden verwendet, um diese Metadaten zu erstellen oder zu aktualisieren:

• New-ModuleManifest-
• Update-ModuleManifest-
• New-ScriptFileInfo
• Update-ScriptFileInfo

Featureelemente des PowerShell-Katalogs, die vom Modulmanifest gesteuert werden

In der folgenden Liste sind die Elemente der Benutzeroberfläche der PowerShell-Katalogpaketseite aufgeführt, die vom Modulmanifest gesteuert werden.

• Titel : Der Name des Pakets, das in der Galerie veröffentlicht wurde.

• Version : Die angezeigte Version ist die Versionszeichenfolge in den Metadaten und eine Vorabversionsbezeichnung, falls angegeben. Die angegebene Zeichenfolge für die Vorabversion wird an die ModuleVersion angefügt. Informationen zu Vorabversionszeichenfolgen in Modulen finden Sie unter Vorabversionsmodulversionen.

• Beschreibung : Dies ist die Beschreibung im Modulmanifest.

• Lizenzannahme erforderlich - Ein Modul kann erfordern, dass der Benutzer eine Lizenz akzeptiert, indem es festlegt RequireLicenseAcceptance = $true, einen LicenseURI angibt und eine license.txt Datei im Stammverzeichnis des Modulordners bereitstellt. Weitere Informationen finden Sie unter Lizenzannahme erforderlich.

• Versionshinweise - Diese Informationen stammen aus dem Abschnitt "Versionshinweise " unter PSData\PrivateData.

• Besitzer : Besitzer sind die Liste der Benutzer im PowerShell-Katalog, die ein Paket aktualisieren können. Die Besitzerliste ist nicht im Paketmanifest enthalten. In der zusätzlichen Dokumentation wird beschrieben, wie Elementbesitzer verwaltet werden.

• Autor : Dies ist im Modulmanifest als Autor enthalten. Das Feld Autor wird häufig verwendet, um ein Unternehmen oder eine Organisation anzugeben, die einem Paket zugeordnet ist.

• Copyright - Dies ist das Copyright-Feld im Modulmanifest.

• FileList : Die Dateiliste wird erstellt, wenn das Paket im PowerShell-Katalog veröffentlicht wird. Sie kann nicht durch die manifesten Informationen gesteuert werden. Der PowerShell-Katalog erstellt .nuspec eine Datei, die in der Dateiliste jedes Pakets angezeigt wird. Diese Datei wird nicht mit dem Paket auf einem System installiert. Dies ist das NuGet-Paketmanifest für das Paket und kann ignoriert werden.

• Schilder - Tags sind unten PrivateData\PSData im Modulmanifest enthalten. Tags haben bestimmte Anforderungen und Bedeutungen, die im Abschnitt Tag-Details beschrieben werden.

• Cmdlets : Dies wird im Modulmanifest mithilfe von CmdletsToExport bereitgestellt. Es empfiehlt sich, die Cmdlet-Namen explizit aufzulisten, anstatt den Platzhalter *. Eine Liste verbessert die Leistung des Lademoduls.

• Functions : Dies wird im Modulmanifest mithilfe von FunctionsToExport bereitgestellt. Es empfiehlt sich, die Cmdlet-Namen explizit aufzulisten, anstatt den Platzhalter *. Eine Liste verbessert die Leistung des Lademoduls.

• DSC-Ressourcen : Dies wird im Manifest mithilfe von DscResourcesToExport bereitgestellt. Dieser Wert wird nur für Module in PowerShell 5.0 und höher unterstützt.

• Rollenfunktionen - Rollen werden aufgelistet, wenn das Modul über eine oder mehrere Rollenfunktionsdateien (.psrc) verfügt. Diese Dateien werden von JEA verwendet. Weitere Informationen finden Sie unter Rollenfunktionen.

• PowerShell-Editionen : Für Module, die für PowerShell 5.0 und niedriger entwickelt wurden, wird dies mithilfe von Tags gesteuert. Verwenden Sie für Desktop das Tag PSEdition_Desktop und für Core das Tag PSEdition_Core. Für Module, die für PowerShell 5.1 und höher entwickelt wurden, gibt es einen CompatiblePSEditions-Schlüssel im Manifest. Weitere Informationen finden Sie unter PSEdition-Unterstützung für Module.

• Abhängigkeiten : Dies wird im Manifest mithilfe von RequiredModules bereitgestellt.

• PowerShell-Mindestversion : Diese wird im Manifest mithilfe von PowerShellVersion bereitgestellt.

• Versionsverlauf - Zeigt eine Liste der Versionen des Moduls an, die in der Galerie veröffentlicht wurden. Pakete, die mit der Funktion "Löschen" ausgeblendet wurden, werden nicht im Versionsverlauf angezeigt, es sei denn, Sie sind Paketbesitzer.

• Projektwebsite : Die Projektwebsite wird für Module im PrivateData\PSData Abschnitt des Modulmanifests bereitgestellt, indem ein ProjectURI angegeben wird.

• Lizenz: Ein Lizenzlink wird für Module im PrivateData\PSData Abschnitt des Modulmanifests bereitgestellt, indem ein LicenseURI angegeben wird.

  Von Bedeutung

  Wenn eine Lizenz nicht über den LicenseURI oder innerhalb des Pakets bereitgestellt wird, gelten die Nutzungsbedingungen für den PowerShell-Katalog für das Paket. Weitere Informationen finden Sie in den Nutzungsbedingungen.

• Symbol : Ein Link wird für Module im PrivateData\PSData Abschnitt des Modulmanifests bereitgestellt, indem ein IconURI angegeben wird. Der URI sollte auf ein Bild im Format 85 x 85 mit transparentem Hintergrund verweisen. Der URI muss ein direkter Link zur Bilddatei sein und darf nicht zu einer Webseite oder einer Datei im PowerShell Gallery-Paket führen.

Featureelemente des PowerShell-Katalogs, die von den Skriptmetadaten gesteuert werden

In der folgenden Liste sind die Elemente der Benutzeroberfläche der PowerShell-Katalogpaketseite aufgeführt, die von den kommentarbasierten Metadaten in einer Skriptdatei gesteuert werden.

• Titel : Dies ist der Name des Pakets, das in der Galerie veröffentlicht wird.

• Version : Die angezeigte Version ist die Versionszeichenfolge in den Metadaten und eine Vorabversionsbezeichnung, falls angegeben. Der Wert stammt aus dem .VERSION Schlüsselwort im Metadaten-Kommentarblock. Wenn Sie ein Vorabversionsskript veröffentlichen, fügen Sie die Vorabversionszeichenfolge an die Version an. Informationen zum Angeben von Vorabversionszeichenfolgen in Modulen finden Sie unter Vorabversionen von Skripts.

• Beschreibung - Diese Information stammt aus dem .DESCRIPTION Schlüsselwort in der kommentarbasierten Hilfe einer Skriptdatei.

• Lizenzannahme erforderlich : Die Lizenzannahme wird für Skripts nicht unterstützt. Das Szenario, in dem ein Skript von einem Modul abhängt, das eine Lizenzannahme erfordert, wird jedoch unterstützt. Weitere Informationen finden Sie unter Anfordern der Lizenzannahme für Skripts.

• Versionshinweise – Diese Informationen stammen aus dem .RELEASENOTES Schlüsselwort in den kommentarbasierten Metadaten einer Skriptdatei.

• Besitzer : Besitzer sind die Liste der Benutzer im PowerShell-Katalog, die ein Paket aktualisieren können. Die Besitzerliste ist nicht im Paketmanifest enthalten. Weitere Informationen finden Sie unter Verwalten von Elementbesitzern.

• Autor - Diese Informationen stammen aus dem .AUTHOR Schlüsselwort in den kommentarbasierten Metadaten einer Skriptdatei. Das Feld Autor wird häufig verwendet, um ein Unternehmen oder eine Organisation anzugeben, die einem Paket zugeordnet ist.

• Copyright - Diese Information stammt aus dem .COPYRIGHT Schlüsselwort in den kommentarbasierten Metadaten einer Skriptdatei.

• FileList : Die Dateiliste wird erstellt, wenn das Paket im PowerShell-Katalog veröffentlicht wird. Sie kann nicht durch die manifesten Informationen gesteuert werden. Der PowerShell-Katalog erstellt .nuspec eine Datei, die in der Dateiliste jedes Pakets angezeigt wird. Diese Datei wird nicht mit dem Paket auf einem System installiert. Dies ist das NuGet-Paketmanifest für das Paket und kann ignoriert werden.

• Tags - *Diese Information stammt aus dem .TAGS Schlüsselwort in den kommentarbasierten Metadaten einer Skriptdatei. Tags haben bestimmte Anforderungen und Bedeutungen, die im Abschnitt Tag-Details beschrieben werden.

• PowerShell-Editionen : Für Module, die für PowerShell 5.0 und niedriger entwickelt wurden, wird dies mithilfe von Tags gesteuert. Verwenden Sie für Desktop das Tag PSEdition_Desktop und für Core das Tag PSEdition_Core. Für Module, die für PowerShell 5.1 und höher entwickelt wurden, gibt es einen CompatiblePSEditions-Schlüssel im Manifest. Weitere Informationen finden Sie unter PSEdition-Unterstützung für Module.

• Versionsverlauf - Zeigt eine Liste der Versionen des Moduls an, die in der Galerie veröffentlicht wurden. Pakete, die mit der Funktion "Löschen" ausgeblendet wurden, werden nicht im Versionsverlauf angezeigt, es sei denn, Sie sind Paketbesitzer.

• Projektwebsite : Diese Informationen stammen aus dem .PROJECTURI Schlüsselwort in den kommentarbasierten Metadaten einer Skriptdatei.

• Lizenz - Diese Information stammt aus dem .LICENSEURI Schlüsselwort in den kommentarbasierten Metadaten einer Skriptdatei.

  Von Bedeutung

  Wenn eine Lizenz nicht über oder .LICENSEURI innerhalb des Pakets bereitgestellt wird, gelten die Nutzungsbedingungen für den PowerShell-Katalog für das Paket. Weitere Informationen finden Sie in den Nutzungsbedingungen.

• Symbol : Diese Information stammt aus dem .ICONURI Schlüsselwort in den kommentarbasierten Metadaten einer Skriptdatei. Der URI sollte auf ein Bild im Format 85 x 85 mit transparentem Hintergrund verweisen. Der URI muss ein direkter Link zur Bilddatei sein und darf nicht zu einer Webseite oder einer Datei im PowerShell Gallery-Paket führen.

Bearbeiten von Paketdetails

Auf der Seite "Paket bearbeiten" des PowerShell-Katalogs können Herausgeber mehrere der für ein Paket angezeigten Felder ändern, insbesondere:

• Title
• Description
• Zusammenfassung
• Symbol-URL
• URL der Projekthomepage
• blockieren
• Urheberrecht
• Stichwörter
• Versionshinweise
• Lizenz erforderlich

Sie sollten diese Informationen nur in der Galerie bearbeiten, um zu korrigieren, was für eine ältere Version eines Moduls angezeigt wird. Benutzer, die das Paket herunterladen, sehen, dass die Metadaten nicht mit dem PowerShell-Katalog übereinstimmen. Jedes Mal, wenn Sie Informationen in der Galerie ändern, sollten Sie eine neue Version des Pakets mit den gleichen Änderungen veröffentlichen.

Details zum Tag

Tags sind einfache Zeichenfolgen, die von Verbrauchern zum Suchen von Paketen verwendet werden. Tags sind am wertvollsten, wenn sie konsistent in verwandten Paketen verwendet werden. Die Verwendung von Variationen desselben Wortes, z. B. Datenbank und Datenbanken oder Test und Testen, bringt wenig Nutzen. Tags sind Zeichenfolgen, bei denen die Groß-/Kleinschreibung nicht beachtet wird, und dürfen keine Leerzeichen enthalten. Wenn es einen Ausdruck gibt, von dem Sie glauben, dass Benutzer suchen werden, fügen Sie ihn der Paketbeschreibung hinzu, damit er in den Suchergebnissen gefunden werden kann. Verwenden Sie Pascal-Groß- und Kleinschreibung, Bindestriche, Unterstriche oder Punkte, um die Lesbarkeit zu verbessern. Seien Sie vorsichtig, wenn Sie lange, komplexe und ungewöhnliche Tags erstellen, die leicht falsch geschrieben werden können.

Der PowerShell-Katalog und die PowerShellGet-Cmdlets haben eine besondere Bedeutung für die PSEdition_DesktopPSEdition_Core und-Tags. Weitere Informationen finden Sie in der vorherigen Erläuterung zu PowerShell-Editionen.

Wie bereits erwähnt, bieten Tags den größten Wert, wenn sie spezifisch sind und in vielen Paketen konsistent verwendet werden. Als Herausgeber, der versucht, die besten Tags zu finden, besteht der einfachste Ansatz darin, den PowerShell-Katalog nach Tags zu durchsuchen, die Sie in Betracht ziehen. Im Idealfall stimmen die zurückgegebenen Pakete mit Ihrer Verwendung dieses Schlüsselworts überein.

In der folgenden Tabelle sind einige der am häufigsten verwendeten Tags aufgeführt. Das bevorzugte Tag sollte die besten Suchergebnisse zurückgeben.