Dokumentace k metadatem pro Microsoft Learn
Metadata v Microsoft Learn používáme k vytváření sestav analýz obsahu, zjistitelnosti obsahu prostřednictvím vyhledávání a řízení aspektů prostředí webu. Metadata se dají použít v článku (ve front matter YAML) nebo globálně v souboru docfx.json úložiště.
Pokud upravujete existující článek, pravděpodobně nebudete muset měnit žádná metadata. Pokud ale přidáváte nový článek, existují určité požadované atributy metadat, které budete muset zahrnout do fronty YAML souboru.
Tady je příklad metadat použitých na webu YAML v článku Markdownu:
---
title: # the article title to show on the browser tab
description: # 115 - 145 character description to show in search results
author: {github-id} # the author's GitHub ID - will be auto-populated if set in settings.json
ms.author: {ms-alias} # the author's Microsoft alias (if applicable) - will be auto-populated if set in settings.json
ms.date: {@date} # the date - will be auto-populated when template is first applied
ms.topic: getting-started # the type of article
---
# Heading 1 <!-- the article title to show on the web page -->
Poznámka
Atributy metadat ms.prod a ms.technology se vyřazují z platformy Learn. Od ledna 2024 se hodnoty v těchto taxonomiích konsolidují do ms.service a ms.subservice pro vytváření sestav obsahu podle produktu.
V následující tabulce jsou uvedeny požadované atributy metadat. Pokud některou z těchto možností vynecháte, pravděpodobně se během sestavování zobrazí chyba ověření.
Pole | Hodnota | Proč? |
---|---|---|
author |
ID účtu GitHub autora. | Identifikuje autora podle ID GitHubu v případě, že se jedná o dotazy nebo problémy s obsahem. V některých případech může automatizace GitHubu upozornit autora aktivity související se souborem. |
description |
Souhrn obsahu. 75–300 znaků. | Používá se při vyhledávání na webu. Někdy se používá na stránce s výsledky vyhledávacího webu pro lepší SEO. |
ms.author |
Alias microsoftu autora bez @microsoft.com Pokud nejste zaměstnancem Microsoftu, vyhledejte v tomto poli vhodný zaměstnanec Microsoftu. | Identifikuje vlastníka článku. Vlastník zodpovídá za rozhodnutí o obsahu článku a za vytváření sestav a BI článku. |
ms.date |
Datum ve formátu MM/DD/RRRR. | Zobrazí se na publikované stránce, která označuje poslední úpravu nebo zaručenou čerstvou verzi článku. Datum je zadáno bez času a je interpretováno jako 0:00 a v časovém pásmu UTC. Datum zobrazené uživatelům se převede do časového pásma. |
ms.service nebo ms.prod |
Identifikátor služby nebo produktu. Používejte jednu nebo druhou, nikdy obojí. Tato hodnota se často nastavuje globálně v souboru docfx.json . | Používá se pro třídění a generování sestav problémů. ms.prod a ms.service jsou rozdíly v tom, že se microsoft Learn předepíše, znamená rozlišovat mezi konkrétními produkty běžícími na počítači (místním) a (počátečním) cloudovým službám. |
ms.topic |
Obvykle jedna z následujících hodnot:article , conceptual , contributor-guide , , quickstart overview , reference , sample , , tutorial . |
Určuje typ obsahu pro účely vytváření sestav. |
title |
Název stránky. | Toto je název stránky, který se zobrazuje na kartě prohlížeče. Jedná se o nejdůležitější metadata pro SEO. |
Atributy rozlišují malá a velká písmena. Zadejte je přesně tak, jak je uvedeno, a použijte dvojtečku a mezeru mezi atributy a hodnotou. Pokud hodnota atributu obsahuje dvojtečku (:), hodnotu hash (#) nebo jakýkoli jiný speciální znak, musíte ji uzavřít do jednoduchých (') nebo dvojitých (") uvozovek. Příklad:
---
title: 'Quickstart: How to use hashtags (#) to make a point on the internet'
---
# Heading 1 <!-- the article title to show on the web page -->
Kromě požadovaných metadat existuje mnoho volitelných atributů metadat, které můžete přidat. V následující tabulce jsou uvedeny některé volitelné atributy metadat.
Pole | Hodnota | Proč? |
---|---|---|
ms.custom |
Pouze pro spisovatele nebo týmy. Běžně se používá ke sledování konkrétních dokumentů nebo sad obsahu v nástrojích telemetrie. Jedná se o jednu řetězcovou hodnotu a je až na nástroj, který ho využívá k analýze. Příklad: ms.custom: "experiment1, content_reporting, all_uwp_docs, CI_Id=101022" Limit znaků: Maximální délka hodnoty řetězce je 125 znaků. |
ms.custom je vlastní pole, pomocí kterého můžou autoři sledovat speciální projekty nebo podmnožinu obsahu. |
ms.reviewer |
Alias Microsoftu osoby, která obsah zkontroluje. | |
ms.subservice |
Konkrétnější hodnotu, se kterou je možné použít ms.service k povolení konkrétnějšího vytváření sestav obsahu o službě. Používejte ms.subservice pouze v případě, že používáte ms.service . |
ms.subservice sama o sobě nejsou platná metadata. Autor ho musí přidružit k nadřazené ms.service hodnotě. Tento atribut je způsob, jak přejít k podrobnostem v sestavách pro danou hodnotu ms.service . |
ms.technology |
Konkrétnější hodnotu, kterou lze použít společně ms.prod s cílem umožnit konkrétnější vytváření sestav obsahu o produktu. Používejte ms.technology pouze v případě, že používáte ms.prod . |
ms.technology sama o sobě nejsou platná metadata. Autor ho musí přidružit k nadřazené ms.prod hodnotě. Tento atribut je způsob, jak přejít k podrobnostem v sestavách pro danou hodnotu ms.prod . |
ROBOTS |
NOINDEX , UNFOLLOW |
Pomocí robotů v části metadat zabráníte procesu sestavení a publikování v zobrazení obsahu na vyhledávacích stránkách. Pokud chcete použít ROBOTS (a ano, je to celé velkým písmenem, i když jiné značky metadat nejsou):- Přidejte ROBOTS: NOINDEX do oddílu metadat.- NOINDEX způsobí, že se prostředek ve výsledcích hledání nezobrazí.- Používejte NOFOLLOW pouze v případech, kdy archivujete celou sadu obsahu. |
no-loc |
Seznam slov v článku, která by neměla být nikdy přeložena (lokalizována). | Tato metadata použijte k zabránění "přelokalizaci". |