Microsoft Learn belgeleri için meta veriler
İçerik analizi raporlaması, arama yoluyla içerik bulunabilirliği ve site deneyiminin yönlerini yönlendirmek için Microsoft Learn'de meta verileri kullanırız. Meta veriler makalede (YAML ön maddesinde) veya deponun docfx.json dosyasında genel olarak uygulanabilir.
Mevcut bir makalede düzenleme yapıyorsanız, büyük olasılıkla meta verileri değiştirmeniz gerekmez. Ancak, yeni bir makale ekliyorsanız, dosyanın YAML ön konusuna eklemeniz gereken bazı gerekli meta veri öznitelikleri vardır.
Markdown makalesinin YAML ön konusuna uygulanan meta verilerin bir örneği aşağıda verilmişti:
---
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 -->
Not
ms.prod ve ms.technology meta veri öznitelikleri Learn platformundan kullanımdan kaldırılıyor. Ocak 2024'den itibaren, bu taksonomilerdeki değerler, içeriğe ürüne göre raporlama için ms.service ve ms.subservice içinde birleştirilir.
Aşağıdaki tabloda gerekli meta veri öznitelikleri gösterilmektedir. Bunlardan herhangi birini atlarsanız, derleme sırasında büyük olasılıkla bir doğrulama hatası alırsınız.
Alan | Değer | Neden? |
---|---|---|
author |
Yazarın GitHub hesap kimliği. | İçerikle ilgili sorular veya sorunlar olması durumunda yazarı GitHub Kimliğine göre tanımlar. Bazı durumlarda GitHub otomasyonu, dosyayı içeren etkinliği yazara bildirebilir. |
description |
İçeriğin özeti. 75-300 karakter. | Site aramasında kullanılır. Bazen iyileştirilmiş SEO için arama motoru sonuçları sayfasında kullanılır. |
ms.author |
"@microsoft.com" olmadan yazarın Microsoft diğer adı. Microsoft çalışanı değilseniz, bu alanda kullanmak için uygun bir Microsoft çalışanı bulun. | Makalenin sahibini tanımlar. Makalenin içeriği ve makalenin raporlaması ve iş zekası hakkındaki kararlardan sahibi sorumludur. |
ms.date |
AA/GG/YYYY biçiminde bir tarih. | Yayımlanan sayfada, makalenin en son ne zaman önemli ölçüde düzenlendiğini veya yenilendiğinden emin olundığını belirtmek için görüntülenir. Tarih saat olmadan girilir ve 0:00 ve UTC saat dilimi olarak yorumlanır. Kullanıcılara görüntülenen tarih kendi saat dilimine dönüştürülür. |
ms.service veya ms.prod |
Hizmet veya ürün tanımlayıcısı. Birini veya diğerini kullanın, ikisini birden kullanmayın. Bu değer genellikle docfx.json dosyasında genel olarak ayarlanır. | Sorun önceliklendirme ve raporlama için kullanılır. ms.prod ve ms.service Microsoft Learn'de önceden belirtilen, bir makinede (şirket içi) çalıştırılacak belirli ürünler ile (erken) bulut hizmetleri arasında ayrım yapmak için yapılan ayrımlardır. |
ms.topic |
Genellikle aşağıdaki değerlerden biri:article , conceptual , contributor-guide , overview , , quickstart , reference , sample . tutorial |
Raporlama amacıyla içerik türünü tanımlar. |
title |
Sayfa başlığı. | Bu, tarayıcı sekmesinde görüntülenen sayfa başlığıdır. SEO için en önemli meta verilerdir. |
Öznitelikler büyük/küçük harfe duyarlıdır. Bunları tam olarak listelendiği gibi girin ve özniteliklerle değer arasında iki nokta üst üste ve boşluk kullanın. Öznitelik değeri iki nokta üst üste (:), karma (#) veya başka bir özel karakter içeriyorsa, bunu tek (') veya çift (") tırnak içine almanız gerekir. Örneğin:
---
title: 'Quickstart: How to use hashtags (#) to make a point on the internet'
---
# Heading 1 <!-- the article title to show on the web page -->
Gerekli meta verilerin yanı sıra ekleyebileceğiniz birçok isteğe bağlı meta veri özniteliği de vardır. Aşağıdaki tabloda isteğe bağlı meta veri özniteliklerinden bazıları gösterilmektedir.
Alan | Değer | Neden? |
---|---|---|
ms.custom |
Yalnızca yazar veya ekip kullanımı için. Telemetri araçlarında belirli belgeleri veya içerik kümelerini izlemek için yaygın olarak kullanılır. Bu, tek bir dize değeridir ve ayrıştırmak için kullanılan ara çubuğuna kadardır. Örnek: ms.custom: "experiment1, content_reporting, all_uwp_docs, CI_Id=101022" Karakter sınırı: En fazla dize değeri uzunluğu 125 karakterdir. |
ms.custom yazarların özel projeleri veya içeriğin bir alt kümesini izlemek için kullanabileceği özel bir alandır. |
ms.reviewer |
İçeriği gözden geçiren bir kişinin Microsoft diğer adı. | |
ms.subservice |
Bir hizmetle ilgili içerikte daha belirgin raporlamayı etkinleştirmek için ile ms.service birlikte kullanılabilecek daha belirli bir değer. Yalnızca aynı zamanda kullanıyorsanız ms.service kullanınms.subservice . |
ms.subservice tek başına geçerli meta veriler değildir. Yazarın bunu bir üst ms.service değerle ilişkilendirmesi gerekir. Bu öznitelik, belirli ms.service bir için raporlamada detaya gitmenin bir yoludur. |
ms.technology |
Bir ürünle ilgili içerik üzerinde daha belirgin raporlama sağlamak için birlikte ms.prod kullanılabilecek daha belirli bir değer. Yalnızca aynı zamanda kullanıyorsanız ms.prod kullanınms.technology . |
ms.technology tek başına geçerli meta veriler değildir. Yazarın bunu bir üst ms.prod değerle ilişkilendirmesi gerekir. Bu öznitelik, belirli ms.prod bir için raporlamada detaya gitmenin bir yoludur. |
ROBOTS |
NOINDEX , UNFOLLOW |
Derleme ve yayımlama işleminin arama sayfalarında içerik göstermesini önlemek için meta veri bölümünde ROBOTS kullanın. Kullanmak ROBOTS istediğinizde (ve evet, diğer meta veri etiketleri olmasa bile tümü büyük harfe ayrılmıştır):- Meta veri bölümünüze ekleyin ROBOTS: NOINDEX .- NOINDEX , varlığın arama sonuçlarında görünmemelerine neden olur.- Yalnızca bir içerik kümesinin tamamını arşivlerken kullanın NOFOLLOW . |
no-loc |
Makalede hiçbir zaman çevrilmemesi gereken (yerelleştirilmiş) sözcüklerin listesi. | "Overlocalization" özelliğini önlemek için bu meta verileri kullanın. |