Dokumentation om metadata för Microsoft Learn
Vi använder metadata på Microsoft Learn för innehållsanalysrapportering, identifiering av innehåll via sökning och drivande aspekter av webbplatsupplevelsen. Metadata kan användas i artikeln (i YAML-fronten) eller globalt i docfx.json-filen för lagringsplatsen.
Om du redigerar en befintlig artikel behöver du förmodligen inte ändra några metadata. Men om du lägger till en ny artikel finns det vissa obligatoriska metadataattribut som du måste inkludera i YAML-fronten för filen.
Här är ett exempel på metadata som används i YAML-frontartikeln 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 -->
Anteckning
Metadataattributen ms.prod och ms.technology dras tillbaka från Learn-plattformen. Från och med januari 2024 konsolideras värdena i dessa taxonomier till ms.service och ms.subservice för rapportering av innehåll efter produkt.
I följande tabell visas de metadataattribut som krävs. Om du utelämnar något av dessa får du troligen ett valideringsfel under bygget.
Fält | Värde | Varför? |
---|---|---|
author |
Författarens GitHub-konto-ID. | Identifierar författaren via GitHub-ID om det finns frågor om eller problem med innehållet. I vissa fall kan GitHub Automation meddela författaren om aktivitet som rör filen. |
description |
En sammanfattning av innehållet. 75–300 tecken. | Används i webbplatssökning. Används ibland på en sökmotorresultatsida för förbättrad SEO. |
ms.author |
Författarens Microsoft-alias, utan "@microsoft.com". Om du inte är anställd på Microsoft kan du hitta en lämplig Microsoft-anställd att använda i det här fältet. | Identifierar artikelns ägare. Ägaren ansvarar för beslut om innehållet i artikeln och för artikelns rapportering och BI. |
ms.date |
Ett datum i formatet MM/DD/ÅÅÅÅ. | Visas på den publicerade sidan för att ange den senaste gången artikeln redigerades eller garanterades på nytt. Datumet anges utan tid och tolkas som 0:00 och i UTC-tidszonen. Datumet som visas för användarna konverteras till tidszonen. |
ms.service eller ms.prod |
Tjänst- eller produktidentifieraren. Använd det ena eller det andra, aldrig båda. Det här värdet anges ofta globalt i filen docfx.json . | Används för problemtriage och rapportering. ms.prod och ms.service är distinktioner som görs före Microsoft Learn, avsedda att skilja mellan specifika produkter som körs på en dator (lokalt) och (tidiga) molntjänster. |
ms.topic |
Vanligtvis något av följande värden:article , conceptual , contributor-guide , overview , quickstart , reference , , sample . tutorial |
Identifierar typen av innehåll i rapporteringssyfte. |
title |
Sidrubriken. | Det här är sidrubriken som visas på webbläsarfliken. Det är de viktigaste metadata för SEO. |
Attribut är skiftlägeskänsliga. Ange dem exakt som i listan och använd ett kolon och ett blanksteg mellan attributen och värdet. Om ett attributvärde innehåller ett kolon (:), en hash (#) eller något annat specialtecken, måste du omge det antingen enkla (') eller dubbla (") citattecken. Till exempel:
---
title: 'Quickstart: How to use hashtags (#) to make a point on the internet'
---
# Heading 1 <!-- the article title to show on the web page -->
Förutom de metadata som krävs finns det många valfria metadataattribut som du kan lägga till. I följande tabell visas några av de valfria metadataattributen.
Fält | Värde | Varför? |
---|---|---|
ms.custom |
Endast för skrivare eller team. Används ofta för att spåra specifika dokument eller uppsättningar med innehåll i telemetriverktyg. Det är ett enda strängvärde och det är upp till det förbrukande verktyget att parsa det. Exempel: ms.custom: "experiment1, content_reporting, all_uwp_docs, CI_Id=101022" Teckengräns: Den maximala strängvärdets längd är 125 tecken. |
ms.custom är ett anpassat fält som författare kan använda för att spåra specialprojekt eller en delmängd av innehållet. |
ms.reviewer |
Microsoft-aliaset för en person som granskar innehållet. | |
ms.subservice |
Ett mer specifikt värde som kan användas med ms.service för att aktivera mer specifik rapportering om innehåll om en tjänst. Använd ms.subservice endast om du också använder ms.service . |
ms.subservice i sig är inte giltiga metadata. Författaren måste associera den med ett överordnat ms.service värde. Det här attributet är ett sätt att öka detaljnivån ytterligare i rapporteringen för en viss ms.service . |
ms.technology |
Ett mer specifikt värde som kan användas tillsammans med ms.prod för att möjliggöra mer specifik rapportering om innehåll om en produkt. Använd ms.technology endast om du också använder ms.prod . |
ms.technology i sig är inte giltiga metadata. Författaren måste associera den med ett överordnat ms.prod värde. Det här attributet är ett sätt att öka detaljnivån ytterligare i rapporteringen för en viss ms.prod . |
ROBOTS |
NOINDEX , UNFOLLOW |
Använd ROBOTS i metadataavsnittet för att förhindra att bygg- och publiceringsprocessen visar innehåll på söksidor. När du vill använda ROBOTS (och ja, allt är versalt, även om andra metadatataggar inte är det):– Lägg till ROBOTS: NOINDEX i metadataavsnittet.- NOINDEX gör att tillgången inte visas i sökresultaten.– Använd NOFOLLOW endast när du arkiverar en hel innehållsuppsättning. |
no-loc |
En lista med ord i artikeln som aldrig ska översättas (lokaliserad). | Använd dessa metadata för att förhindra "överallokering". |