Μετα-δεδομένα για τεκμηρίωση του Microsoft Learn
Χρησιμοποιούμε μετα-δεδομένα στο Microsoft Learn για αναφορές ανάλυσης περιεχομένου, δυνατότητα εντοπισμού περιεχομένου μέσω αναζήτησης και προώθηση πτυχών της εμπειρίας τοποθεσίας. Τα μετα-δεδομένα μπορούν να εφαρμοστούν στο άρθρο (στην πρώτη ύλη YAML) ή καθολικά στο αρχείο docfx.json για το αποθετήριο δεδομένων.
Εάν κάνετε μια επεξεργασία σε ένα υπάρχον άρθρο, πιθανότατα δεν θα χρειαστεί να αλλάξετε οποιαδήποτε μετα-δεδομένα. Ωστόσο, εάν προσθέτετε ένα νέο άρθρο, υπάρχουν ορισμένα απαιτούμενα χαρακτηριστικά μετα-δεδομένων που θα πρέπει να συμπεριλάβετε στο προσκήνιο YAML του αρχείου.
Ακολουθεί ένα παράδειγμα μετα-δεδομένων που εφαρμόζονται στην πρώτη ύλη YAML ενός άρθρου Markdown:
---
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 -->
Σημείωση
Τα χαρακτηριστικά μετα-δεδομένων ms.prod και ms.technology αποσύρονται από την πλατφόρμα Learn. Ξεκινώντας από τον Ιανουάριο του 2024, οι τιμές σε αυτές τις ταξινομήσεις θα ενοποιηθούν στο ms.service και στο ms.subservice για αναφορά περιεχομένου κατά προϊόν.
Ο παρακάτω πίνακας εμφανίζει τα απαιτούμενα χαρακτηριστικά μετα-δεδομένων. Εάν παραλείψετε οποιοδήποτε από αυτά, πιθανότατα θα λάβετε ένα σφάλμα επικύρωσης κατά τη δόμηση.
Πεδίο | Τιμή | Γιατί; |
---|---|---|
author |
Το αναγνωριστικό λογαριασμού GitHub του συντάκτη. | Αναγνωρίζει τον συντάκτη με αναγνωριστικό GitHub σε περίπτωση που υπάρχουν ερωτήσεις ή προβλήματα με το περιεχόμενο. Σε ορισμένες περιπτώσεις, η αυτοματοποίηση του GitHub μπορεί να ενημερώσει τον συντάκτη για δραστηριότητα που αφορά το αρχείο. |
description |
Μια σύνοψη του περιεχομένου. 75-300 χαρακτήρες. | Χρησιμοποιείται στην αναζήτηση τοποθεσίας. Ορισμένες φορές χρησιμοποιείται σε μια σελίδα αποτελεσμάτων μηχανισμού αναζήτησης για βελτιωμένη SEO. |
ms.author |
Το ψευδώνυμο Microsoft του συντάκτη, χωρίς τη λέξη "@microsoft.com". Εάν δεν είστε υπάλληλος της Microsoft, βρείτε έναν κατάλληλο υπάλληλο της Microsoft για χρήση σε αυτό το πεδίο. | Προσδιορίζει τον κάτοχο του άρθρου. Ο κάτοχος είναι υπεύθυνος για αποφάσεις σχετικά με το περιεχόμενο του άρθρου, καθώς και για τις αναφορές και το BI του άρθρου. |
ms.date |
Μια ημερομηνία με τη μορφή ΜΜ/ΗΗ/ΕΕΕΕ. | Εμφανίζεται στη δημοσιευμένη σελίδα για να υποδείξει την τελευταία φορά που το άρθρο έχει υποστεί σημαντική επεξεργασία ή εγγυημένη ενημέρωση. Η ημερομηνία καταχωρείται χωρίς ώρα και ερμηνεύεται ως 0:00 και στη ζώνη ώρας UTC. Η ημερομηνία που εμφανίζεται στους χρήστες μετατρέπεται στη ζώνη ώρας τους. |
ms.service ή ms.prod |
Το αναγνωριστικό υπηρεσίας ή προϊόντος. Χρησιμοποιήστε το ένα ή το άλλο, ποτέ τα δύο. Αυτή η τιμή ορίζεται συχνά καθολικά στο αρχείο docfx.json . | Χρησιμοποιείται για την τριγωνομετρικά ζητήματα και τις αναφορές. ms.prod και ms.service είναι διακρίσεις που προηγούνται του Microsoft Learn, οι οποίες προορίζονται για διάκριση μεταξύ συγκεκριμένων προϊόντων που εκτελούνται σε έναν υπολογιστή (εκ των προτέρων) και των (πρώιμων) υπηρεσιών cloud. |
ms.topic |
Συνήθως, μία από τις παρακάτω τιμές:article , , contributor-guide conceptual , overview , , quickstart , reference , , sample . tutorial |
Προσδιορίζει τον τύπο του περιεχομένου για σκοπούς αναφοράς. |
title |
Ο τίτλος της σελίδας. | Αυτός είναι ο τίτλος σελίδας που εμφανίζεται στην καρτέλα του προγράμματος περιήγησης. Είναι τα πιο σημαντικά μετα-δεδομένα για SEO. |
Στα χαρακτηριστικά γίνεται διάκριση πεζών-κεφαλαίων. Εισαγάγετε τις ακριβώς όπως παρατίθενται και χρησιμοποιήστε μια άνω και κάτω τελεία και ένα κενό διάστημα μεταξύ των χαρακτηριστικών και της τιμής. Εάν μια τιμή χαρακτηριστικού περιλαμβάνει μια άνω και κάτω τελεία (:), έναν κατακερματισμού (#) ή οποιονδήποτε άλλο ειδικό χαρακτήρα, πρέπει να περικλείσετε είτε μονά (') είτε διπλά (") εισαγωγικά. Για παράδειγμα:
---
title: 'Quickstart: How to use hashtags (#) to make a point on the internet'
---
# Heading 1 <!-- the article title to show on the web page -->
Εκτός από τα απαιτούμενα μετα-δεδομένα, υπάρχουν πολλά προαιρετικά χαρακτηριστικά μετα-δεδομένων που μπορείτε να προσθέσετε. Ο παρακάτω πίνακας εμφανίζει ορισμένα από τα προαιρετικά χαρακτηριστικά μετα-δεδομένων.
Πεδίο | Τιμή | Γιατί; |
---|---|---|
ms.custom |
Για χρήση μόνο από τον συντάκτη ή την ομάδα. Χρησιμοποιείται συνήθως για την παρακολούθηση συγκεκριμένων εγγράφων ή συνόλων περιεχομένου σε εργαλεία τηλεμετρίας. Είναι μια μοναδική τιμή συμβολοσειράς και εξαρτάται από το εργαλείο κατανάλωσης να την αναλύσει. Παράδειγμα: ms.custom: "experiment1, content_reporting, all_uwp_docs, CI_Id=101022" Όριο χαρακτήρων: Το μέγιστο μήκος τιμής συμβολοσειράς είναι 125 χαρακτήρες. |
ms.custom Το είναι ένα προσαρμοσμένο πεδίο που μπορούν να χρησιμοποιήσουν οι συντάκτες για την παρακολούθηση ειδικών έργων ή ενός υποσυνόλου περιεχομένου. |
ms.reviewer |
Το ψευδώνυμο Microsoft ενός ατόμου που εξετάζει το περιεχόμενο. | |
ms.subservice |
Μια πιο συγκεκριμένη τιμή που μπορεί να χρησιμοποιηθεί με για να ενεργοποιήσετε πιο συγκεκριμένες αναφορές σχετικά με περιεχόμενο σχετικά με ms.service μια υπηρεσία. Χρησιμοποιήστε ms.subservice το μόνο εάν χρησιμοποιείτε επίσης το ms.service . |
ms.subservice Από μόνη της δεν είναι έγκυρα μετα-δεδομένα. Ο συντάκτης πρέπει να τη συσχετίσει με μια γονική ms.service τιμή. Αυτό το χαρακτηριστικό είναι ένας τρόπος για να κάνετε περαιτέρω διερεύνηση στην αναφορά για μια δεδομένη ms.service . |
ms.technology |
Μια πιο συγκεκριμένη τιμή που μπορεί να χρησιμοποιηθεί μαζί με ms.prod την για να ενεργοποιήσετε πιο συγκεκριμένες αναφορές σχετικά με περιεχόμενο σχετικά με ένα προϊόν. Χρησιμοποιήστε ms.technology το μόνο εάν χρησιμοποιείτε επίσης το ms.prod . |
ms.technology Από μόνη της δεν είναι έγκυρα μετα-δεδομένα. Ο συντάκτης πρέπει να τη συσχετίσει με μια γονική ms.prod τιμή. Αυτό το χαρακτηριστικό είναι ένας τρόπος για να κάνετε περαιτέρω διερεύνηση στην αναφορά για μια δεδομένη ms.prod . |
ROBOTS |
NOINDEX , UNFOLLOW |
Χρησιμοποιήστε τα ROBOTS στην ενότητα μετα-δεδομένων σας για να αποτρέψετε τη διαδικασία δόμησης και δημοσίευσης από την εμφάνιση περιεχομένου στις σελίδες αναζήτησης. Όταν θέλετε να χρησιμοποιήσετε ROBOTS (και ναι, όλα είναι κεφαλαία, παρόλο που δεν είναι άλλες ετικέτες μετα-δεδομένων):- Προσθέστε ROBOTS: NOINDEX το στην ενότητα μετα-δεδομένων σας.- NOINDEX Το προκαλεί να μην εμφανίζεται το στοιχείο στα αποτελέσματα αναζήτησης.- Χρησιμοποιείται NOFOLLOW μόνο όταν αρχειοθετείτε ένα ολόκληρο σύνολο περιεχομένου. |
no-loc |
Μια λίστα λέξεων στο άρθρο που δεν πρέπει ποτέ να μεταφραστεί (να μεταφραστεί). | Χρησιμοποιήστε αυτά τα μετα-δεδομένα για να αποτρέψετε την "υπερεντοπισμό". |