Documentatie voor metagegevens voor Microsoft Learn
We gebruiken metagegevens op Microsoft Learn voor rapportage van inhoudsanalyse, vindbaarheid van inhoud via zoekopdrachten en het stimuleren van aspecten van de site-ervaring. Metagegevens kunnen worden toegepast in het artikel (in de YAML-front-matter) of globaal in het docfx.json-bestand voor de opslagplaats.
Als u een bewerking aanbrengt in een bestaand artikel, hoeft u waarschijnlijk geen metagegevens te wijzigen. Als u echter een nieuw artikel toevoegt, zijn er bepaalde vereiste metagegevenskenmerken die u moet opnemen in de YAML-front-matter van het bestand.
Hier volgt een voorbeeld van metagegevens die zijn toegepast in de YAML-front-matter van een 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 -->
Notitie
De metagegevenskenmerken ms.prod en ms.technology worden buiten gebruik gesteld van het Learn-platform. Vanaf januari 2024 worden waarden in deze taxonomieën samengevoegd tot ms.service en ms.subservice voor rapportage over inhoud per product.
In de volgende tabel ziet u de vereiste metagegevenskenmerken. Als u een van deze weglaat, krijgt u waarschijnlijk een validatiefout tijdens de build.
Veld | Waarde | Waarom? |
---|---|---|
author |
De GitHub-account-id van de auteur. | Identificeert de auteur op GitHub-id voor het geval er vragen zijn over of problemen met de inhoud. In sommige gevallen kan GitHub Automation de auteur op de hoogte stellen van activiteiten met betrekking tot het bestand. |
description |
Een samenvatting van de inhoud. 75-300 tekens. | Wordt gebruikt bij het zoeken van sites. Soms gebruikt op een pagina met zoekresultaten van een zoekmachine voor verbeterde SEO. |
ms.author |
De Microsoft-alias van de auteur, zonder @microsoft.com. Als u geen Microsoft-werknemer bent, zoekt u een geschikte Microsoft-werknemer die u in dit veld kunt gebruiken. | Identificeert de eigenaar van het artikel. De eigenaar is verantwoordelijk voor beslissingen over de inhoud van het artikel en voor de rapportage en BI van het artikel. |
ms.date |
Een datum in de notatie MM/DD/JJJJ. | Weergegeven op de gepubliceerde pagina om aan te geven dat het artikel de laatste keer dat het artikel aanzienlijk is bewerkt of gegarandeerd vers is. De datum wordt ingevoerd zonder tijd en wordt geïnterpreteerd als 0:00 en in de UTC-tijdzone. De datum die naar gebruikers wordt weergegeven, wordt geconverteerd naar hun tijdzone. |
ms.service of ms.prod |
De service of product-id. Gebruik een of andere, nooit beide. Deze waarde wordt vaak globaal ingesteld in het docfx.json-bestand . | Wordt gebruikt voor het classificeren en rapporteren van problemen. ms.prod en ms.service zijn onderscheid gemaakt die voorafgaan aan Microsoft Learn, bedoeld om onderscheid te maken tussen specifieke producten die worden uitgevoerd op een machine (on-premises) en de (vroege) cloudservices. |
ms.topic |
Meestal een van de volgende waarden:article contributor-guide , , , overview conceptual , , quickstart , , reference , . sample tutorial |
Identificeert het type inhoud voor rapportagedoeleinden. |
title |
De paginatitel. | Dit is de paginatitel die wordt weergegeven op het browsertabblad. Het zijn de belangrijkste metagegevens voor SEO. |
Kenmerken zijn hoofdlettergevoelig. Voer ze exact in zoals vermeld en gebruik een dubbele punt en een spatie tussen de kenmerken en de waarde. Als een kenmerkwaarde een dubbele punt (:), een hash (#) of een ander speciaal teken bevat, moet u deze tussen enkele (') of dubbele (")aanhalingstekens plaatsen. Voorbeeld:
---
title: 'Quickstart: How to use hashtags (#) to make a point on the internet'
---
# Heading 1 <!-- the article title to show on the web page -->
Naast de vereiste metagegevens zijn er veel optionele metagegevenskenmerken die u kunt toevoegen. In de volgende tabel ziet u enkele van de optionele metagegevenskenmerken.
Veld | Waarde | Waarom? |
---|---|---|
ms.custom |
Alleen voor schrijver of team. Wordt vaak gebruikt voor het bijhouden van specifieke documenten of sets inhoud in telemetriehulpprogramma's. Het is één tekenreekswaarde en het is aan het verbruikshulpprogramma om deze te parseren. Voorbeeld: ms.custom: "experiment1, content_reporting, all_uwp_docs, CI_Id=101022" Tekenlimiet: de maximale tekenreekswaardelengte is 125 tekens. |
ms.custom is een aangepast veld dat schrijvers kunnen gebruiken om speciale projecten of een subset van inhoud bij te houden. |
ms.reviewer |
De Microsoft-alias van een persoon die de inhoud beoordeelt. | |
ms.subservice |
Een specifiekere waarde waarmee u specifiekere rapporten over inhoud over een service kunt ms.service inschakelen. Alleen gebruiken ms.subservice als u ook gebruikt ms.service . |
ms.subservice zelf zijn geen geldige metagegevens. De auteur moet deze koppelen aan een bovenliggende ms.service waarde. Dit kenmerk is een manier om verder in te zoomen op rapportage voor een bepaald ms.service kenmerk. |
ms.technology |
Een specifiekere waarde die samen kan worden gebruikt ms.prod om specifiekere rapportage over inhoud over een product mogelijk te maken. Alleen gebruiken ms.technology als u ook gebruikt ms.prod . |
ms.technology zelf zijn geen geldige metagegevens. De auteur moet deze koppelen aan een bovenliggende ms.prod waarde. Dit kenmerk is een manier om verder in te zoomen op rapportage voor een bepaald ms.prod kenmerk. |
ROBOTS |
NOINDEX , UNFOLLOW |
Gebruik ROBOTS in de sectie metagegevens om te voorkomen dat het bouw- en publicatieproces inhoud op zoekpagina's weergeeft. Als u wilt gebruiken ROBOTS (en ja, dit is allemaal hoofdlettergebruik, ook al zijn andere metagegevenstags dat niet):- Toevoegen ROBOTS: NOINDEX aan de sectie metagegevens.- NOINDEX zorgt ervoor dat de asset niet wordt weergegeven in zoekresultaten.- Alleen gebruiken NOFOLLOW wanneer u een volledige inhoudsset archiveert. |
no-loc |
Een lijst met woorden in het artikel dat nooit mag worden vertaald (gelokaliseerd). | Gebruik deze metagegevens om 'overlokalisatie' te voorkomen. |