Metaúdaje pre dokumentáciu služby Microsoft Learn
Metaúdaje na lokalite Microsoft Learn používame na vytváranie zostáv na analýzu obsahu, zisťovanie obsahu prostredníctvom vyhľadávania a podpora aspektov používania lokality. Metaúdaje možno použiť v článku (v klientskej záležitosti YAML) alebo globálne v súbore docfx.json odkladacieho priestoru.
Ak upravujete existujúci článok, pravdepodobne nebudete musieť zmeniť žiadne metaúdaje. Ak však pridávate nový článok, existujú určité požadované atribúty metaúdajov, ktoré budete musieť zahrnúť do prednej časti súboru YAML.
Tu je príklad metaúdajov použitých v prednej časti článku v jazyku YAML v jazyku Markdown:
---
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
Atribúty metaúdajov ms.prod a ms.technology sa vyradia z platformy Learn. Od januára 2024 sa hodnoty v týchto taxonómiách zlúčia do služieb ms.service a ms.subservice na vykazovanie obsahu podľa produktov.
V nasledujúcej tabuľke sú uvedené požadované atribúty metaúdajov. Ak niektorú z týchto možností vynecháte, pravdepodobne sa počas vytvárania zobrazí chyba overenia.
| Pole | Hodnota | Prečo? |
|---|---|---|
author |
ID konta GitHub autora. | Identifikuje autora pomocou ID GitHubu v prípade, že existujú otázky týkajúce sa obsahu alebo problémy s obsahom. V niektorých prípadoch môže automatizácia služby GitHub informovať autora aktivity týkajúcej sa súboru. |
description |
Súhrn obsahu. 75 – 300 znakov. | Používa sa vo vyhľadávaní na lokalite. Niekedy sa používa na stránke s výsledkami vyhľadávacieho nástroja pre lepšiu SEO. |
ms.author |
Alias Microsoft autora bez výrazu @microsoft.com. Ak nie ste zamestnancom spoločnosti Microsoft, nájdite vhodného zamestnanca spoločnosti Microsoft, ktorý sa má použiť v tomto poli. | Identifikuje vlastníka článku. Vlastník je zodpovedný za rozhodnutia o obsahu článku a za vytváranie zostáv a BI článku. |
ms.date |
Dátum vo formáte MM/DD/RRRR. | Na publikovanej stránke sa zobrazia informácie o tom, kedy bol článok naposledy podstatne upravený alebo zaručene aktuálny. Dátum sa zadá bez času a interpretuje sa ako 0:00 a v časovom pásme UTC. Dátum zobrazený používateľom sa skonvertuje na časové pásmo. |
ms.servicealebo ms.prod |
Identifikátor služby alebo produktu. Použite jeden alebo druhý, nikdy oba. Táto hodnota sa často v súbore docfx.json nastaví globálne. | Používa sa na triedenie problémov a vytváranie zostáv. ms.prod a ms.service sú rozdiely, ktoré predchádzajú službe Microsoft Learn, určené na rozlíšenie medzi konkrétnymi produktmi spustenými na počítači (lokálny) a (skorým) cloudovými službami. |
ms.topic |
Zvyčajne jedna z nasledujúcich hodnôt:article, conceptual, contributor-guide, overview, quickstart, reference, sample, , tutorial. |
Identifikuje typ obsahu na účely vytvárania zostáv. |
title |
Názov stránky. | Toto je názov stránky, ktorý sa zobrazuje na karte prehliadača. Je to najdôležitejšie metaúdaje pre SEO. |
V atribútoch sa rozlišujú veľké a malé písmená. Zadajte ich presne tak, ako sú uvedené, a použite dvojbodku a medzeru medzi atribútmi a hodnotou. Ak hodnota atribútu obsahuje dvojbodku (:), hash (#) alebo iný špeciálny znak, musíte ho uzavrite medzi jednoduché úvodzovky (') alebo dvojité ("). Naprí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 -->
Okrem požadovaných metaúdajov môžete pridať aj množstvo voliteľných atribútov metaúdajov. V nasledujúcej tabuľke sú uvedené niektoré z voliteľných atribútov metaúdajov.
| Pole | Hodnota | Prečo? |
|---|---|---|
ms.custom |
Iba pre spisovateľa alebo tím. Bežne sa používa na sledovanie konkrétnych dokumentov alebo množín obsahu v telemetrických nástrojoch. Ide o jednu hodnotu reťazca a je na náročnom nástroji, ktorý ho analyzuje. Príklad: ms.custom: "experiment1, content_reporting, all_uwp_docs, CI_Id=101022"Obmedzenie znakov: Maximálna dĺžka hodnoty reťazca je 125 znakov. |
ms.custom je vlastné pole, ktoré môžu spisovatelia použiť na sledovanie špeciálnych projektov alebo podmnožiny obsahu. |
ms.reviewer |
Alias spoločnosti Microsoft osoby, ktorá obsah skontroluje. | |
ms.subservice |
Konkrétnejšia hodnota, s ms.service ktorou možno vykonať konkrétnejšie vytváranie zostáv o obsahu o službe. Použite ms.subservice iba vtedy, ak používate tiež .ms.service |
ms.subservice samé o sebe nie sú platné metaúdaje. Autor ju musí priradiť k nadradenej ms.service hodnote. Tento atribút je spôsob, ako podrobnejšie prejsť na detaily pri vykazovaní pre danú ms.servicetabuľku . |
ms.technology |
Konkrétnejšia hodnota, ktorú možno použiť spolu s ms.prod cieľom umožniť presnejšie vytváranie zostáv o obsahu o produkte. Použite ms.technology iba vtedy, ak používate tiež .ms.prod |
ms.technology samé o sebe nie sú platné metaúdaje. Autor ju musí priradiť k nadradenej ms.prod hodnote. Tento atribút je spôsob, ako podrobnejšie prejsť na detaily pri vykazovaní pre danú ms.prodtabuľku . |
ROBOTS |
NOINDEX, UNFOLLOW |
Použite ROBOTS v časti metaúdajov, čím zabránite tomu, aby proces vytvárania a publikovania zobrazoval obsah na stránkach vyhľadávania. Keď chcete použiť ( ROBOTS a áno, celé písmeno má veľké písmeno, aj keď iné značky metaúdajov nie sú):– Pridať ROBOTS: NOINDEX do časti metaúdajov.- NOINDEX spôsobí, že majetok sa nezobrazí vo výsledkoch vyhľadávania.– Používajte NOFOLLOW iba vtedy, keď archivujete celú množinu obsahu. |
no-loc |
Zoznam slov v článku, ktoré by sa nikdy nemali prekladať (lokalizované). | Pomocou týchto metaúdajov zabránite prekrývaniu. |