メタデータの更新

拡張機能の名前

Learn Authoring Pack、Visual Studio Code メタ拡張機能は、複数のサブ拡張機能で構成されています。 この機能は、 Learn Markdown 拡張機能に含まれています。 Learn Markdown 拡張機能は Learn Authoring Pack の一部であり、個別にインストールする必要はありません。

まとめ

Markdown (*.md) ファイルには、メタデータに固有の 2 つのコンテキスト メニュー項目があります。 テキスト エディター内の任意の場所を右クリックすると、次のようなメニュー項目が表示されます。

メタデータの更新コンテキスト メニュー

ms.date メタデータ値の更新

[Update ms.date Metadata Value](ms.date メタデータ値の更新) オプションを選択すると、Markdown ファイルの現在の ms.date 値が今日の日付に設定されます。 ドキュメントに ms.date メタデータ フィールドがない場合、アクションは実行されません。

暗黙的なメタデータ値の更新

[Update implicit metadata values](暗黙的なメタデータ値の更新) オプションを選択すると、暗黙的に指定できるすべてのメタデータ値が検索され、置き換えられます。 メタデータ値は、"docfx.json" ファイルの build/fileMetadata ノードの下に暗黙的に指定されます。 fileMetadata ノード内の各キーと値のペアは、メタデータの既定値を表します。 たとえば、"最上位レベル/サブフォルダー" ディレクトリ内にある Markdown ファイルで、ms.author メタデータ値を省略すると、fileMetadata ノードで使用する既定値が暗黙的に指定される可能性があります。

{
    "build": {
        "fileMetadata": {
            "ms.author": {
                "top-level/sub-folder/**/**.md": "dapine"
            }
        }
    }
}

この場合、すべての Markdown ファイルで、ms.author: dapine メタデータ値が暗黙的に使用されます。 この機能は、"docfx.json" ファイル内で見つかったこのような暗黙的な設定に対して動作します。 Markdown ファイルに、暗黙の値以外の値が明示的に設定されたメタデータが含まれている場合、それらはオーバーライドされます。

次の Markdown ファイルのメタデータについて考えてみましょう。この Markdown ファイルは最上位レベル/サブフォルダー/includes/example.md 内にあります。

---
ms.author: someone-else
---

# Content

"docfx.json" が上記の内容であることを前提にすると、このファイルに対して [暗黙的なメタデータ値の更新] オプションが実行されると、メタデータ値は ms.author: dapine に更新されます。

---
ms.author: dapine
---

# Content

操作の実例

この機能の簡単なデモンストレーションを以下に示します。

メタデータの更新のデモ