Dokumentation til metadata til Microsoft Learn
Vi bruger metadata på Microsoft Learn til rapportering af indholdsanalyse, registrering af indhold via søgning og til at fremme aspekter af webstedsoplevelsen. Metadata kan anvendes i artiklen (i YAML-front sagen) eller globalt i docfx.json-filen til lageret.
Hvis du redigerer en eksisterende artikel, behøver du sandsynligvis ikke at ændre metadata. Men hvis du tilføjer en ny artikel, er der visse påkrævede metadataattributter, som du skal inkludere i YAML-filens forside.
Her er et eksempel på metadata, der er anvendt i YAML-fronten i en Markdown-artikel:
---
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 -->
Bemærk
Metadataattributterne ms.prod og ms.technology udgår fra Learn-platformen. Fra og med januar 2024 konsolideres værdierne i disse taksonomier til ms.service og ms.subservice for rapportering om indhold efter produkt.
I følgende tabel vises de påkrævede metadataattributter. Hvis du udelader nogen af disse, får du sandsynligvis vist en valideringsfejl under buildet.
| Felt | Værdi | Hvorfor? |
|---|---|---|
author |
Forfatterens GitHub-konto-id. | Identificerer forfatteren af GitHub-id, hvis der er spørgsmål om eller problemer med indholdet. I nogle tilfælde kan GitHub-automatisering give forfatteren besked om aktiviteter, der involverer filen. |
description |
En oversigt over indholdet. 75-300 tegn. | Bruges i webstedssøgning. Nogle gange bruges på en søgemaskine resultater side for forbedret SEO. |
ms.author |
Forfatterens Microsoft-alias uden "@microsoft.com". Hvis du ikke er Microsoft-medarbejder, skal du finde en passende Microsoft-medarbejder, der kan bruges i dette felt. | Identificerer artiklens ejer. Ejeren er ansvarlig for beslutninger om indholdet af artiklen og for artiklens rapportering og BI. |
ms.date |
En dato i formatet MM/DD/ÅÅÅÅ. | Vises på den publicerede side for at angive, hvornår artiklen sidst blev redigeret eller garanteret frisk. Datoen angives uden klokkeslæt og fortolkes som 0:00 og i UTC-tidszonen. Den dato, der vises for brugerne, konverteres til deres tidszone. |
ms.serviceeller ms.prod |
Tjeneste- eller produkt-id'et. Brug den ene eller den anden, aldrig begge dele. Denne værdi angives ofte globalt i filen docfx.json . | Bruges til problemtriage og -rapportering. ms.prod og ms.service skelnes der mellem før Microsoft Learn, der er beregnet til at skelne mellem bestemte produkter, der kører på en maskine (i det lokale miljø) og de (tidlige) cloudtjenester. |
ms.topic |
Normalt en af følgende værdier:article, , conceptualcontributor-guide, overviewquickstart, , reference, sample. tutorial |
Identificerer typen af indhold til rapporteringsformål. |
title |
Sidetitlen. | Dette er den sidetitel, der vises under browserfanen. Det er de vigtigste metadata for SEO. |
Der er forskel på store og små bogstaver i attributter. Angiv dem nøjagtigt som angivet, og brug et kolon og et mellemrum mellem attributterne og værdien. Hvis en attributværdi indeholder et kolon (:), en hashværdi (#) eller et andet specialtegn, skal du omslutte enten enkelte (') eller dobbelte (") anførselstegn. Eksempler:
---
title: 'Quickstart: How to use hashtags (#) to make a point on the internet'
---
# Heading 1 <!-- the article title to show on the web page -->
Ud over de påkrævede metadata er der mange valgfri metadataattributter, du kan tilføje. I følgende tabel vises nogle af de valgfri metadataattributter.
| Felt | Værdi | Hvorfor? |
|---|---|---|
ms.custom |
Kun til skrive- eller teambrug. Bruges ofte til sporing af bestemte dokumenter eller sæt af indhold i telemetriværktøjer. Det er en enkelt strengværdi, og det er op til det forbrugende værktøj at fortolke det. Eksempel: ms.custom: "experiment1, content_reporting, all_uwp_docs, CI_Id=101022"Tegngrænse: Den maksimale strengværdi er 125 tegn. |
ms.custom er et brugerdefineret felt, som forfattere kan bruge til at spore specialprojekter eller et undersæt af indhold. |
ms.reviewer |
Microsoft-aliasset for en person, der gennemser indholdet. | |
ms.subservice |
En mere specifik værdi, der kan bruges til ms.service at aktivere mere specifik rapportering om indhold om en tjeneste. ms.subservice Brug kun , hvis du også bruger ms.service. |
ms.subservice i sig selv ikke er gyldige metadata. Forfatteren skal knytte den til en overordnet ms.service værdi. Denne attribut er en metode til at foretage yderligere detailudledning i rapporteringen for en given ms.service. |
ms.technology |
En mere specifik værdi, der kan bruges sammen med ms.prod for at muliggøre mere specifik rapportering om indhold om et produkt. ms.technology Brug kun , hvis du også bruger ms.prod. |
ms.technology i sig selv ikke er gyldige metadata. Forfatteren skal knytte den til en overordnet ms.prod værdi. Denne attribut er en metode til at foretage yderligere detailudledning i rapporteringen for en given ms.prod. |
ROBOTS |
NOINDEX, UNFOLLOW |
Brug ROBOTS i dit metadataafsnit til at forhindre, at build- og publiceringsprocessen viser indhold på søgesider. Når du vil bruge ROBOTS (og ja, bliver det hele skrevet med stort, selvom andre metadatakoder ikke er):– Føj ROBOTS: NOINDEX til metadatasektionen.- NOINDEX medfører, at aktivet ikke vises i søgeresultater.– Bruges NOFOLLOW kun, når du arkiverer et helt indholdssæt. |
no-loc |
En liste over ord i artiklen, der aldrig skal oversættes (lokaliseret). | Brug disse metadata til at forhindre "overlokalisering". |