Olvasás angol nyelven

Megosztás a következőn keresztül:


Metaadatok a Microsoft Learn dokumentációjához

A Microsoft Learn metaadatait használjuk a tartalomelemzési jelentésekhez, a tartalmak kereséssel való felderíthetőségéhez és a webhely élményének hajtóelemeihez. A metaadatok a cikkben (a YAML-előtérben) vagy globálisan is alkalmazhatók az adattár docfx.json fájljában.

Ha egy meglévő cikket szerkeszt, valószínűleg nem kell módosítania a metaadatokat. Ha azonban új cikket ad hozzá, bizonyos szükséges metaadat-attribútumokat fel kell vennie a fájl YAML-előlapjára.

Íme egy példa a Markdown-cikk YAML-előlapján alkalmazott metaadatokra:

---
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 -->

Megjegyzés

Az ms.prod és az ms.technology metaadat-attribútumok kivonásra kerülnek a Learn platformról. 2024 januárjától kezdődően ezekben az osztályozásokban szereplő értékek az ms.service és az ms.subservice szolgáltatásba lesznek egyesítve a tartalom termékenkénti jelentéséhez.

Kötelező metaadatok

Az alábbi táblázat a szükséges metaadat-attribútumokat mutatja be. Ha kihagyja bármelyiket, valószínűleg érvényesítési hibát fog kapni a buildelés során.

Mező Érték Miért?
author A szerző GitHub-fiókazonosítója. Azonosítja a szerzőt a GitHub-azonosító alapján, ha a tartalommal kapcsolatos kérdések vagy problémák merülnek fel. Bizonyos esetekben előfordulhat, hogy a GitHub automation értesíti a szerzőt a fájlt érintő tevékenységről.
description A tartalom összegzése. 75-300 karakter. A webhely-keresésben használatos. Néha használják a keresőmotor találati oldalán továbbfejlesztett SEO.
ms.author A szerző Microsoft-aliasa, "@microsoft.com" nélkül . Ha Ön nem Microsoft-alkalmazott, keresse meg a megfelelő Microsoft-alkalmazottat ebben a mezőben. Azonosítja a cikk tulajdonosát. A tulajdonos felelős a cikk tartalmával kapcsolatos döntésekért, valamint a cikk jelentéséért és a BI-ért.
ms.date Dátum MM/DD/ÉÉÉÉ formátumban. A közzétett oldalon jelenik meg, amely jelzi, hogy a cikk mikor lett utoljára jelentősen szerkesztve, vagy friss állapotban lett garantálva. A rendszer idő nélkül adja meg a dátumot, és 0:00-ként és az UTC időzónában értelmezi. A rendszer a felhasználók számára megjelenített dátumot időzónává alakítja.
ms.servicevagy
ms.prod
A szolgáltatás vagy a termék azonosítója. Használjon egyet vagy a másikat, soha ne mindkettőt. Ez az érték gyakran globálisan van beállítva a docfx.json fájlban. A probléma osztályozásához és jelentéséhez használatos.

ms.prod és ms.service különbséget tesznek a Microsoft Learn előzetes verziója között, amely a számítógépen (helyszíni) és a (korai) felhőszolgáltatásokon futtatott egyes termékek megkülönböztetésére szolgál.
ms.topic Általában az alábbi értékek egyike:

article, conceptual, contributor-guide, overview, quickstartreference, sample. tutorial
A jelentéskészítési célú tartalom típusát azonosítja.
title A lap címe. Ez az oldal címe, amely a böngészőlapon jelenik meg. Ez a seo legfontosabb metaadatai.

Az attribútumok megkülönböztetik a kis- és nagybetűket. Adja meg őket pontosan a felsoroltak szerint, és használjon kettőspontot és szóközt az attribútumok és az érték között. Ha egy attribútum értéke kettőspontot (:), kivonatot (#) vagy bármely más speciális karaktert tartalmaz, akkor azt egyetlen (') vagy dupla (") idézőjelként kell mellékelnie. Példa:

---
title: 'Quickstart: How to use hashtags (#) to make a point on the internet'
---
# Heading 1 <!-- the article title to show on the web page -->

Nem kötelező metaadatok

A szükséges metaadatok mellett számos választható metaadatattribútumot is hozzáadhat. Az alábbi táblázat néhány választható metaadat-attribútumot mutat be.

Mező Érték Miért?
ms.custom Csak író vagy csapat számára használható.

A telemetriai eszközök adott dokumentumainak vagy tartalomkészleteinek nyomon követésére gyakran használják. Ez egy sztringérték, és a fogyasztó eszközön múlik az elemzés. Példa: ms.custom: "experiment1, content_reporting, all_uwp_docs, CI_Id=101022"

Karakterkorlát: A sztring maximális hossza 125 karakter.
ms.custom egy egyéni mező, amellyel az írók nyomon követhetik a speciális projekteket vagy a tartalom egy részhalmazát.
ms.reviewer A tartalmat véleményező személy Microsoft-aliasa.
ms.subservice Egy konkrétabb érték, amellyel ms.service pontosabb jelentés készíthető egy szolgáltatás tartalmáról. Csak akkor használja ms.subservice , ha ön is használja ms.service. ms.subservice önmagában nem érvényes metaadatok. A szerzőnek szülőértékkel ms.service kell társítania. Ez az attribútum egy adott ms.servicejelentéskészítés további részletezésére használható.
ms.technology Egy konkrétabb érték, amellyel együtt ms.prod pontosabb jelentés készíthető egy termék tartalmáról. Csak akkor használja ms.technology , ha ön is használja ms.prod. ms.technology önmagában nem érvényes metaadatok. A szerzőnek szülőértékkel ms.prod kell társítania. Ez az attribútum egy adott ms.prodjelentéskészítés további részletezésére használható.
ROBOTS NOINDEX, UNFOLLOW A ROBOTS használatával a metaadatok szakaszban megakadályozhatja, hogy a buildelési és közzétételi folyamat megjelenítse a tartalmakat a keresési oldalakon. Ha használni ROBOTS szeretné (és igen, az összes nagybetűs, annak ellenére, hogy más metaadatcímkék nem):
– Adja hozzá ROBOTS: NOINDEX a metaadatszakaszhoz.
- NOINDEX az objektum nem jelenik meg a keresési eredmények között.
– Csak akkor használható NOFOLLOW , ha egy teljes tartalomkészletet archivál.
no-loc A cikkben szereplő szavak listája, amelyeket soha nem szabad lefordítani (honosítva). Ezzel a metaadatokkal megakadályozhatja a "túllokosítást".

Lásd még