Les på engelsk

Del via


Dokumentasjon for Metadata for Microsoft Learn

Vi bruker metadata på Microsoft Learn for rapportering av innholdsanalyse, oppdagbarhet av innhold via søk og kjøring av aspekter ved nettstedsopplevelsen. Metadata kan brukes i artikkelen (i YAML-frontsaken) eller globalt i docfx.json-filen for repo.

Hvis du redigerer en eksisterende artikkel, trenger du sannsynligvis ikke å endre metadata. Hvis du imidlertid legger til en ny artikkel, finnes det visse nødvendige metadataattributter som du må inkludere i YAML-frontsaken for filen.

Her er et eksempel på metadata som brukes i YAML-frontsaken i en Markdown-artikkel:

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

Obs!

Attributtene ms.prod og ms.technology metadata blir trukket tilbake fra Learn-plattformen. Fra og med januar 2024 konsolideres verdiene i disse taksonomiene til ms.service og ms.subservice for rapportering av innhold etter produkt.

Nødvendige metadata

Tabellen nedenfor viser de nødvendige metadataattributtene. Hvis du utelater noen av disse, får du sannsynligvis en valideringsfeil under bygg.

Felt Verdi Hvorfor?
author Forfatterens GitHub-konto-ID. Identifiserer forfatteren av GitHub-ID i tilfelle det er spørsmål om eller problemer med innholdet. I noen tilfeller kan GitHub-automatisering varsle forfatteren av aktiviteten som involverer filen.
description Et sammendrag av innholdet. 75-300 tegn. Brukes i områdesøk. Noen ganger brukes på en søkemotorresultatside for forbedret seo.
ms.author Forfatterens Microsoft-alias, uten @microsoft.com. Hvis du ikke er en Microsoft-ansatt, kan du finne en passende Microsoft-ansatt som skal brukes i dette feltet. Identifiserer artikkelens eier. Eieren er ansvarlig for beslutninger om innholdet i artikkelen, og for artikkelens rapportering og BI.
ms.date En dato i formatet MM/DD/ÅÅÅÅ. Vises på den publiserte siden for å angi siste gang artikkelen ble vesentlig redigert eller garantert fersk. Datoen angis uten klokkeslett og tolkes som 0:00 og i UTC-tidssonen. Datoen som vises for brukere, konverteres til tidssonen.
ms.serviceeller
ms.prod
Tjeneste- eller produktidentifikatoren. Bruk det ene eller det andre, aldri begge deler. Denne verdien angis ofte globalt i den docfx.json filen. Brukes til problemtriage og rapportering.

ms.prod og ms.service er forskjeller som er forut for Microsoft Learn, ment å skille mellom bestemte produkter som kjører på en maskin (på forhånd) og (tidlig) skytjenester.
ms.topic Vanligvis én av følgende verdier:

article, conceptual, contributor-guide, overview, quickstart, reference, , sample. tutorial
Identifiserer innholdstypen for rapporteringsformål.
title Sidetittelen. Dette er sidetittelen som vises i nettleserfanen. Det er de viktigste metadataene for SEO.

Attributter skiller mellom store og små bokstaver. Skriv dem inn nøyaktig som oppført, og bruk et kolon og et mellomrom mellom attributtene og verdien. Hvis en attributtverdi inneholder et kolon (:), en hash (#) eller et annet spesialtegn, må du omslutte det enten enkle (') eller doble (") anførselstegn. Eksempel:

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

Valgfrie metadata

I tillegg til de nødvendige metadataene finnes det mange valgfrie metadataattributter du kan legge til. Tabellen nedenfor viser noen av de valgfrie metadataattributtene.

Felt Verdi Hvorfor?
ms.custom Bare for skrive- eller teambruk.

Brukes vanligvis til å spore bestemte dokumenter eller innholdssett i telemetriverktøy. Det er en enkelt strengverdi, og det er opp til forbrukerverktøyet å analysere den. Eksempel: ms.custom: "experiment1, content_reporting, all_uwp_docs, CI_Id=101022"

Tegngrense: Maksimal strengverdilengde er 125 tegn.
ms.custom er et egendefinert felt som forfattere kan bruke til å spore spesielle prosjekter eller et delsett av innhold.
ms.reviewer Microsoft-aliaset til en person som ser gjennom innholdet.
ms.subservice En mer spesifikk verdi som kan brukes til ms.service å aktivere mer spesifikk rapportering av innhold om en tjeneste. ms.subservice Bruk bare hvis du også bruker ms.service. ms.subservice i seg selv er ikke gyldige metadata. Forfatteren må knytte den til en overordnet ms.service verdi. Dette attributtet er en måte å drille ned ytterligere i rapporteringen for en gitt ms.service.
ms.technology En mer spesifikk verdi som kan brukes sammen med ms.prod for å aktivere mer spesifikk rapportering av innhold om et produkt. ms.technology Bruk bare hvis du også bruker ms.prod. ms.technology i seg selv er ikke gyldige metadata. Forfatteren må knytte den til en overordnet ms.prod verdi. Dette attributtet er en måte å drille ned ytterligere i rapporteringen for en gitt ms.prod.
ROBOTS NOINDEX, UNFOLLOW Bruk ROBOTS i metadatadelen for å hindre at bygg- og publiseringsprosessen viser innhold på søkesider. Når du vil bruke ROBOTS (og ja, er alt stor forbokstav, selv om andre metadatakoder ikke er det):
– Legg ROBOTS: NOINDEX til i metadatainndelingen.
- NOINDEX fører til at aktivumet ikke vises i søkeresultatene.
– Brukes NOFOLLOW bare når du arkiverer et helt innholdssett.
no-loc En liste over ord i artikkelen som aldri skal oversettes (lokalisert). Bruk disse metadataene til å forhindre overlokalisering.

Se også