Metadaten-Explorer

Name der Erweiterung

Die Metaerweiterung Learn Authoring Pack, Visual Studio Code, besteht aus mehreren Untererweiterungen. Dieses Feature ist in der Erweiterung "Learn Markdown " enthalten. Die Erweiterung "Learn Markdown" ist Teil des Learn Authoring Pack, es muss nicht separat installiert werden.

Zusammenfassung

Der Metadaten-Explorer wird automatisch in der Explorer-Randleiste von Visual Studio Code angezeigt, wenn Sie eine Learn Markdown-Datei öffnen.

Metadaten-Explorer in Visual Studio Code

Metadatenquellen

Der Metadaten-Explorer zeigt Metadaten aus drei Quellen an: das YAML-Front-Matter der im Editor geöffneten Markdown-Datei sowie die fileMetadata und globalMetadata Abschnitte der docfx.json-Datei des Docsets. Symbole helfen ihnen, die Quelle der angezeigten Metadaten schnell zu identifizieren. Wenn in Ihrem Artikel erforderliche Metadaten fehlen, wird dieser Metadatenschlüssel mit einem Warnsymbol angezeigt.

Ikone Metadatenquelle
Markdown-Symbol YAML-Front-Materie der aktiven Markdown-Datei
Json-Symbol fileMetadata Abschnitt der Dateidocfx.json
Globussymbol globalMetadata Abschnitt der Dateidocfx.json
Warnungssymbol Diese erforderlichen Metadaten fehlen vollständig.

Vorrang

Im Metadaten-Explorer werden nur eindeutige Metadatenschlüssel angezeigt. Wenn mehrere Werte für denselben Schlüssel gelten können, verwendet der Explorer dieselben Rangfolgeeinstellungen wie DocFx. Die Reihenfolge in abnehmender Priorität lautet:

  1. YAML-Front-Matter
  2. fileMetadata
  3. globalMetadata

Wenn mehrere ordnerbasierte Globmuster auf einen einzelnen Artikel angewendet werden, wird der Eintrag ausgewählt, der zuletzt in der docfx.json Datei angezeigt wird. Betrachten Sie beispielsweise die Datei unter C:/docs/csharp/reference/keywords.md und die folgenden Einträge in der docfx.json Datei:

"ms.topic": {
  "csharp/**/*.md": "conceptual",
  "csharp/reference/*.md": "language-reference"
}

In diesem Fall, obwohl beide Globmuster den Pfad zur Datei enthalten, wird der zweite Wert von language-reference ausgewählt.

QuickInfo

Sie können mit dem Mauszeiger über einen Wert fahren, um eine erweiterte Darstellung im Tooltip zu sehen. Dies ist besonders nützlich für Schlüssel mit mehreren Werten in einem Array. Die Informationen enthalten auch die Quelle der Metadaten.

QuickInfo zum Wert von Metadaten im Metadaten-Explorer.

Auffrischen

Wenn das automatische Speichern in Visual Studio Code deaktiviert ist, wird der Metadaten-Explorer automatisch aktualisiert, wenn Sie Ihre Markdown-Datei speichern. Wenn Sie die automatische Speicherung aktiviert haben, können Sie die angezeigten Metadaten aktualisieren, indem Sie oben im Explorer auf die Schaltfläche " Aktualisieren " klicken.

Wenn Sie eine andere Markdown-Datei öffnen, wird der Explorer automatisch aktualisiert.

Siehe auch