Μεταδεδομένα σελίδας
Μια σελίδα DevSite είναι μια ενιαία ενότητα περιεχομένου σε έναν ιστότοπο. Μια σελίδα μπορεί να έχει τίτλο, σώμα, στοιχεία κεφαλίδας και χαρακτηριστικά μεταδεδομένων που ελέγχουν τις δυνατότητες του ιστότοπου. Όταν ένας χρήστης επισκέπτεται τη διεύθυνση URL για μια σελίδα, ο ιστότοπος αποδίδει μια πλήρη ιστοσελίδα με βάση τις ιδιότητες της σελίδας περιεχομένου, προσθέτοντας δυναμικά στοιχεία όπως η κεφαλίδα, το υποσέλιδο και η πλαϊνή γραμμή. Οι προεπιλεγμένες συμπεριφορές βελτιστοποιούνται για σελίδες τεχνικής τεκμηρίωσης, αλλά μια σελίδα μπορεί επίσης να διαμορφωθεί για άλλες χρήσεις, όπως μάρκετινγκ και σελίδες προορισμού.
Δομή σελίδας
Μια σελίδα DevSite είναι μια ιστοσελίδα της οποίας η γενική εμφάνιση και οι δυνατότητες διαχειρίζονται από τον ιστότοπο. Εμφανίζεται μια σελίδα στο Google Developers με πολλές κοινές περιοχές. (Δεν υποστηρίζουν όλες οι τοποθεσίες όλες οι δυνατότητες.) Τοποθετήστε το δείκτη του ποντικιού σας πάνω από το διάγραμμα για ετικέτες.
site header
Το λογότυπο του ιστότοπου, το γραφικό στοιχείο σύνδεσης, το πλαίσιο αναζήτησης και η πλοήγηση στην κορυφή. Κοινό σε ολόκληρο τον ιστότοπο.
project bar
Ο τίτλος του έργου ή του προϊόντος και τα γραφικά στοιχεία του έργου (όπως ο σύνδεσμος "Σχόλια"). Αυτή η περιοχή ορίζεται από τα μεταδεδομένα του έργου .
sidebar
Ιεραρχική πλοήγηση σε όλο το βιβλίο. Αυτή η περιοχή ορίζεται από μεταδεδομένα βιβλίου .
body
Ο τίτλος της σελίδας και το περιεχόμενο της σελίδας.
page footer ("last updated")
Γραφικά στοιχεία για συγκεκριμένες σελίδες (όπως η ειδοποίηση "Τελευταία ενημέρωση"). Μπορεί επίσης να περιέχει μια ειδοποίηση άδειας CC, η οποία είναι ένα χαρακτηριστικό μεταδεδομένων έργου.
site footer
Οι σύνδεσμοι υποσέλιδου ιστότοπου, το γραφικό στοιχείο επιλογής γλώσσας. Κοινό σε ολόκληρο τον ιστότοπο.
Αρχεία πηγής HTML
<html devsite>
<head>
<title>Page title</title>
<meta name="project_path" value="/path/to/_project.yaml" />
<meta name="book_path" value="/path/to/_book.yaml" />
</head>
<body>
<p>Body content goes here, implemented as HTML.</p>
</body>
</html>
Το χαρακτηριστικό devsite του στοιχείου <html> λέει στον DevSite ότι αυτό πρέπει να αποδοθεί ως σελίδα DevSite και όχι αυτολεξεί ως στοιχείο HTML. Εάν η σελίδα σας εμφανίζεται χωρίς μορφοποίηση ή κεφαλίδα ή υποσέλιδο, ελέγξτε ότι ο <html devsite> εμφανίζεται κοντά στην κορυφή του αρχείου σας.
Τα στοιχεία <html> , <head> και <body> απαιτούνται και πρέπει να έχουν ετικέτες ανοίγματος και κλεισίματος.
Μια τυπική σελίδα πρέπει επίσης να έχει ένα στοιχείο <title> , μέσα στο <head> . Δείτε τον τίτλο της σελίδας .
Συγκεκριμένες ετικέτες <meta> ελέγχουν τις δυνατότητες σελίδας. Αυτά περιγράφονται σε αυτήν την αναφορά. Μια τυπική σελίδα έχει μια μετα-ετικέτα "project_path" , η οποία αναφέρεται σε ένα αρχείο μεταδεδομένων _project.yaml και μια μετα-ετικέτα "book_path" , η οποία αναφέρεται σε ένα αρχείο μεταδεδομένων _book.yaml . Δείτε Έργα και βιβλία . Οι ετικέτες <meta> που αναγνωρίζονται από το DevSite συνήθως δεν εμφανίζονται στην τελική σελίδα.
Άλλα στοιχεία στο <head> και όλα τα στοιχεία στο <body> αποδίδονται στην τελική σελίδα.
Αρχεία πηγής Markdown
Project: /path/to/_project.yaml
Book: /path/to/_book.yaml
# Page title
Body content, specified in Markdown, goes here.
Μια τυπική σελίδα πρέπει να έχει τίτλο (π.χ. # Page title ). Δείτε τον τίτλο της σελίδας .
Συγκεκριμένες μετα-ετικέτες ελέγχουν τις δυνατότητες σελίδας. Αυτά περιγράφονται σε αυτή την αναφορά. Μια τυπική σελίδα έχει μια μετα-ετικέτα Project: που αναφέρεται σε ένα αρχείο μεταδεδομένων _project.yaml και μια μετα-ετικέτα Book: που αναφέρεται σε ένα αρχείο μεταδεδομένων _book.yaml . Δείτε Έργα και βιβλία. Οι μετα-ετικέτες που αναγνωρίζονται από το DevSite συνήθως δεν εμφανίζονται στην τελική σελίδα.
Έργα και βιβλία
Ένα έργο περιγράφεται από ένα αρχείο μεταδεδομένων έργου που ονομάζεται _project.yaml . Ένα βιβλίο περιγράφεται από ένα αρχείο μεταδεδομένων βιβλίου με το όνομα _book.yaml . Αυτά τα αρχεία δημοσιεύονται στον ιστότοπο μαζί με αρχεία σελίδας και στοιχείων και μπορούν να μεταφραστούν σε πολλές γλώσσες. Ανατρέξτε στην ενότητα Μεταδεδομένα έργου και Μεταδεδομένα βιβλίου για πληροφορίες σχετικά με τη δομή και τα χαρακτηριστικά αυτών των αρχείων.
Για να συσχετίσετε μια σελίδα με ένα έργο, δώστε το χαρακτηριστικό project_path . Η τιμή του είναι η διαδρομή περιεχομένου προς το αρχείο _project.yaml .
HTML
<meta name="project_path" value="/path/to/_project.yaml" />
Χαμήλωση τιμής
Project: /path/to/_project.yaml
Εάν μια σελίδα δεν έχει χαρακτηριστικό project_path , θα αποδοθεί χωρίς την περιοχή της γραμμής έργου και τα χαρακτηριστικά της. Η σελίδα δεν θα θεωρείται μέρος έργου.
Για να συσχετίσετε μια σελίδα με ένα βιβλίο, δώστε το χαρακτηριστικό book_path . Η τιμή του είναι η διαδρομή περιεχομένου προς το αρχείο _book.yaml .
HTML
<meta name="book_path" value="/path/to/_book.yaml" />
Χαμήλωση τιμής
Book: /path/to/_book.yaml
Τίτλος σελίδας
<head>
<title>Page title</title>
...
</head>
Ή χρησιμοποιήστε ένα στοιχείο <h1> με την κατηγορία page-title στο <body> της σελίδας.
HTML
<h1 class="page-title">Page title</h1>
Χαμήλωση τιμής
# Page title
Οι αρχικές σελίδες του έργου δεν χρειάζονται τίτλους,
HTML
<meta name="no_page_title" value="true" />
Χαμήλωση τιμής
no_page_title: true
Σε ειδικές περιπτώσεις όπου το αυτόματο <h1> δεν είναι επιθυμητό για μια ειδική διάταξη, αλλά μια σελίδα χρειάζεται ακόμα τίτλο παραθύρου, μπορείτε να διατηρήσετε τον τίτλο αλλά να αποκρύψετε την επικεφαλίδα με το χαρακτηριστικό "hide_page_heading" :
HTML
<title>Page title</title>
<meta name="hide_page_heading" value="true" />
Χαμήλωση τιμής
hide_page_heading: true
# Page title
Περιγραφή κεφαλίδας
Πολλοί ιστότοποι DevSite έχουν μια περιγραφή στην κεφαλίδα. Αυτό ορίζεται στο αρχείο μεταδεδομένων _project.yaml και εμφανίζεται αυτόματα στις σελίδες προορισμού του DevSite. Με άλλα λόγια, οι σελίδες που δημιουργούνται χρησιμοποιώντας πρότυπο _index.yaml θα αποδώσουν αυτόματα μια περιγραφή στην κεφαλίδα, η οποία ορίζεται στο αρχείο _project.yaml .
Αυτή η περιγραφή μπορεί να παρακαμφθεί για τη σελίδα ορίζοντας μια description στη ρίζα του αρχείου _index.yaml ή να αποσιωπηθεί ορίζοντας hide_description: true εντός του αντικειμένου header του αντικειμένου landing_page .
Διάταξη πλήρους πλάτους
Εάν χρειάζεται περισσότερος έλεγχος στη διάταξη, μπορείτε να πείτε στον DevSite να παραιτηθεί από τον έλεγχο της διάταξης για την περιοχή κάτω από την κεφαλίδα του ιστότοπου και τη γραμμή έργου και πάνω από το υποσέλιδο του ιστότοπου. Για να το κάνετε αυτό, ορίστε το χαρακτηριστικό "full_width" μεταδεδομένων σε "true" .
HTML
<meta name="full_width" value="true" />
Χαμήλωση τιμής
full_width: true
Ημερομηνία τελευταίας ενημέρωσης
Από προεπιλογή, εκτός από σελίδες full-width , η περιοχή υποσέλιδου σελίδας περιλαμβάνει μια αυτόματη ειδοποίηση "τελευταία ενημέρωση". Στις περισσότερες περιπτώσεις, αυτό δίνει στους χρήστες ένα άμεσο μήνυμα σχετικά με τη φρεσκάδα του περιεχομένου στη σελίδα.
Σε ορισμένες περιπτώσεις, αυτές οι πληροφορίες ενδέχεται να προκαλούν σύγχυση ή να θεωρηθούν εμπιστευτικές από την ομάδα προϊόντων. Για να απενεργοποιήσετε την τελευταία ενημέρωση ειδοποίησης σε μια σελίδα, ορίστε το χαρακτηριστικό hide_last_updated σε true :
HTML
<meta name="project_path" value="/time-travel/_project.yaml" />
<meta name="book_path" value="/time-travel/_book.yaml" />
<meta name="hide_last_updated" value="true" />
Χαμήλωση τιμής
Project: /time-travel/_project.yaml
Book: /time-travel/_book.yaml
hide_last_updated: true
Μπορείτε να παρακάμψετε την αυτόματα υπολογισμένη ημερομηνία "τελευταία ενημέρωση" ορίζοντας τη μετα-ετικέτα refresh_date σε μια ημερομηνία σε μορφή ISO 8601 :
HTML
<meta name="project_path" value="/time-travel/_project.yaml" />
<meta name="book_path" value="/time-travel/_book.yaml" />
<meta name="refresh_date" value="2017-03-27" />
Χαμήλωση τιμής
Project: /time-travel/_project.yaml
Book: /time-travel/_book.yaml
refresh_date: 2017-03-27
Περιγραφή σελίδας
Η περιγραφή μιας σελίδας είναι μια σύνοψη κειμένου του περιεχομένου της σελίδας. Για να ορίσετε μια περιγραφή για μια σελίδα, δώστε ένα στοιχείο <meta name="description" content="DESCRIPTION" /> . Σημειώστε ότι το κείμενο της περιγραφής πηγαίνει σε ένα χαρακτηριστικό που ονομάζεται content , όχι value . αυτό ταιριάζει με το χαρακτηριστικό web standard.
HTML
<meta name="description" content="It was the best of times, it was the blurst of times..." />
Χαμήλωση τιμής
description: It was the best of times, it was the blurst of times...
Η ρύθμιση της περιγραφής της σελίδας προκαλεί την προσθήκη της ετικέτας <meta> στην τελική σελίδα
Διαδρομή εικόνας
Το image_path είναι η διαδρομή προς την εικόνα που αντιπροσωπεύει αυτήν τη σελίδα στα μέσα κοινωνικής δικτύωσης και λειτουργίες του DevSite όπως recommendations και dynamic content . Όταν οριστεί, αυτή η εικόνα θα χρησιμοποιηθεί ως εικόνα OpenGraph της σελίδας, παρακάμπτοντας τις ρυθμίσεις social media του έργου και τις ρυθμίσεις επωνυμίας tenant site's .
HTML
<meta name="image_path" value="/site-assets/developers_64dp.png" />
Χαμήλωση τιμής
image_path: /site-assets/developers_64dp.png
Λέξεις-κλειδιά
Το πεδίο keywords είναι μια λίστα συμβολοσειρών οριοθετημένη με κόμματα που περιγράφουν τη σελίδα και χρησιμοποιούνται σε λειτουργίες αναζήτησης και ανακάλυψης, όπως η αναζήτηση ιστότοπου και Dynamic Content .
Το πεδίο keywords υποστηρίζει επίπεδες λέξεις-κλειδιά χωρίς συσχέτιση διαστάσεων (για παράδειγμα, gettingstarted ) και δομημένες λέξεις-κλειδιά που χρησιμοποιούν χώρους ονομάτων διαστάσεων για να αντιπροσωπεύουν τη σχέση μεταξύ εγγράφων και οντοτήτων πραγματικού κόσμου, όπως γλώσσες προγραμματισμού, προϊόντα και συμβάντα (για παράδειγμα, product:ComputeEngine ή language:Python3 ). Μπορείτε να προσθέσετε και τους δύο τύπους keywords σε οποιοδήποτε πεδίο λέξεων-κλειδιών.
Εάν τοποθετήσετε μια λέξη-κλειδί που δεν συμμορφώνεται με τις απαιτήσεις μορφοποίησης, θα δείτε μια προειδοποίηση με τη σωστά μορφοποιημένη έκδοση της λέξης-κλειδιού σας στην έξοδο του εργαλείου που χρησιμοποιήσατε (συνήθως το εργαλείο γραμμής εντολών DevSite ή τον Εκδότη περιεχομένου DevSite).
HTML
<meta name="keywords" value="spacetime,timetravel,product:Delorean" />
Χαμήλωση τιμής
keywords: spacetime, timetravel, product:Delorean