Metadatele paginii

O pagină DevSite este o singură unitate de conținut pe un site. O pagină poate avea un titlu, un corp, elemente de antet și atribute de metadate care controlează caracteristicile site-ului. Când un utilizator vizitează adresa URL a unei pagini, site-ul redă o pagină web completă pe baza proprietăților paginii de conținut, adăugând elemente dinamice, cum ar fi antetul, subsolul și bara laterală. Comportamentele implicite sunt optimizate pentru paginile de documentație tehnică, dar o pagină poate fi configurată și pentru alte utilizări, precum marketing și pagini de destinație.

Structura unei pagini

antetul site-ului
bara de proiect
bara laterală
corp
ultima actualizare

O pagină DevSite este o pagină web al cărei aspect general și caracteristici sunt gestionate de site. O pagină pe Google Developers este afișată cu mai multe zone comune. (Nu toate site-urile acceptă toate funcțiile.) Treceți mouse-ul peste diagramă pentru etichete.

site header

Sigla site-ului, widgetul de conectare, caseta de căutare și navigarea de sus. Comună pe întregul site.

project bar

Titlul proiectului sau al produsului și widget-urile specifice proiectului (cum ar fi linkul „Feedback”). Această zonă este definită de metadatele proiectului .

sidebar

Navigare ierarhică la nivelul întregii cărți. Această zonă este definită de metadatele cărții .

body

Titlul paginii și conținutul paginii.

page footer ("last updated")

Widgeturi specifice paginii (cum ar fi notificarea „Ultima actualizare”). Poate conține, de asemenea, o notificare de licență CC, care este un atribut de metadate ale proiectului.

site footer

Linkurile de subsol al site-ului, widgetul de selectare a limbii. Comună pe întregul site.

Fișiere sursă 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>

Atributul devsite al elementului <html> îi spune lui DevSite că aceasta ar trebui redată ca pagină DevSite și nu textual ca material HTML. Dacă pagina dvs. apare fără formatare sau un antet sau subsol, verificați dacă <html devsite> apare în partea de sus a fișierului.

Elementele <html> , <head> și <body> sunt necesare și trebuie să aibă etichete de deschidere și de închidere.

O pagină tipică trebuie să aibă, de asemenea, un element <title> , în interiorul <head> . Vezi titlul paginii .

Etichetele <meta> specifice controlează funcțiile paginii. Acestea sunt descrise în această referință. O pagină tipică are o metaetichetă "project_path" , care se referă la un fișier de metadate _project.yaml , și o metaetichetă "book_path" , care se referă la un fișier de metadate _book.yaml . Vezi Proiecte și cărți . Etichetele <meta> recunoscute de DevSite de obicei nu apar în pagina finală.

Alte elemente din <head> și toate elementele din <body> sunt redate în pagina finală.

Fișierele sursă Markdown 


Project: /path/to/_project.yaml
Book: /path/to/_book.yaml

# Page title

Body content, specified in Markdown, goes here.

O pagină tipică trebuie să aibă un titlu (de exemplu, # Page title ). Vezi titlul paginii .

Etichetele meta specifice controlează caracteristicile paginii. Acestea sunt descrise în această referință. O pagină tipică are o metaetichetă Project: care se referă la un fișier de metadate _project.yaml , și o metaetichetă Book: care se referă la un fișier de metadate _book.yaml . Vezi Proiecte și cărți. Metaetichetele recunoscute de DevSite de obicei nu apar în pagina finală.

Proiecte și cărți

Un proiect este descris de un fișier de metadate de proiect numit _project.yaml . O carte este descrisă de un fișier de metadate de carte numit _book.yaml . Aceste fișiere sunt publicate pe site împreună cu fișierele de pagină și materiale și pot fi traduse în mai multe limbi. Consultați Metadatele proiectului și Metadatele cărții pentru informații despre structura și atributele acestor fișiere.

Pentru a asocia o pagină cu un proiect, furnizați atributul project_path . Valoarea sa este calea conținutului către fișierul _project.yaml .

HTML 

<meta name="project_path" value="/path/to/_project.yaml" />

Markdown 

Project: /path/to/_project.yaml

Dacă o pagină nu are un atribut project_path , va fi redată fără regiunea barei de proiect și caracteristicile acesteia. Pagina nu va fi considerată parte a unui proiect.

Pentru a asocia o pagină cu o carte, furnizați atributul book_path . Valoarea sa este calea conținutului către fișierul _book.yaml .

HTML 

<meta name="book_path" value="/path/to/_book.yaml" />

Markdown 

Book: /path/to/_book.yaml

Titlul paginii 

<head>
  <title>Page title</title>
  ...
</head>

Sau utilizați un element <h1> cu clasa page-title în <body> al paginii.

HTML 

<h1 class="page-title">Page title</h1>

Markdown 

# Page title

Paginile de pornire ale proiectului nu au nevoie de titluri,

HTML 

<meta name="no_page_title" value="true" />

Markdown 

no_page_title: true

În cazuri speciale în care <h1> automat nu este dorit pentru un aspect special, dar o pagină are nevoie de un titlu de fereastră, puteți păstra titlul, dar ascundeți titlul cu atributul "hide_page_heading" :

HTML 

<title>Page title</title>
<meta name="hide_page_heading" value="true" />

Markdown 

hide_page_heading: true
# Page title

Descrierea antetului

Multe site-uri DevSite au o descriere în antet. Acesta este setat în fișierul de metadate _project.yaml și este afișat automat pe paginile de destinație DevSite. Cu alte cuvinte, paginile care sunt create folosind șablonul _index.yaml vor reda automat o descriere în antet, care este setată în fișierul _project.yaml .

Această descriere poate fi suprascrisă pentru pagină setând o description la rădăcina fișierului _index.yaml sau suprimată prin setarea hide_description: true în obiectul header al obiectului landing_page .

Aspect pe toată lățimea

Dacă este nevoie de mai mult control asupra aspectului, puteți spune lui DevSite să renunțe la controlul asupra aspectului pentru zona de sub antetul site-ului și bara de proiect și deasupra subsolului site-ului. Pentru a face acest lucru, setați atributul de metadate "full_width" la "true" .

HTML 

<meta name="full_width" value="true" />

Markdown 

full_width: true

Data ultimei actualizări

În mod implicit, cu excepția paginilor full-width , regiunea subsolului paginii include o notificare automată de „ultima actualizare”. În cele mai multe cazuri, acest lucru oferă utilizatorilor un semnal direct despre prospețimea conținutului de pe pagină.

În câteva cazuri, aceste informații pot fi confuze sau pot fi considerate confidențiale de către echipa de produs. Pentru a dezactiva ultima notificare actualizată pe o pagină, setați atributul hide_last_updated la 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" />

Markdown 

Project: /time-travel/_project.yaml
Book: /time-travel/_book.yaml
hide_last_updated: true

Puteți înlocui data „ultima actualizare” calculată automat prin setarea metaetichetei refresh_date la o dată în format 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" />

Markdown 

Project: /time-travel/_project.yaml
Book: /time-travel/_book.yaml
refresh_date: 2017-03-27

Descrierea paginii

Descrierea unei pagini este un rezumat textual al conținutului paginii. Pentru a seta o descriere pentru o pagină, furnizați un element <meta name="description" content="DESCRIPTION" /> . Observați că textul descrierii se înscrie într-un atribut numit content , nu value ; aceasta se potrivește cu atributul standard web.

HTML 

<meta name="description" content="It was the best of times, it was the blurst of times..." />

Markdown 

description: It was the best of times, it was the blurst of times...

Setarea descrierii paginii face ca eticheta <meta> să fie inclusă pe pagina finală

Calea imaginii

image_path este calea către imaginea care reprezintă această pagină în rețelele sociale și în funcțiile DevSite, cum ar fi recommendations și dynamic content . Când este setată, această imagine va fi folosită ca imagine OpenGraph a paginii, suprascriind setările social media ale proiectului și setările de branding tenant site's .

HTML 

<meta name="image_path" value="/site-assets/developers_64dp.png" />

Markdown 

image_path: /site-assets/developers_64dp.png

Cuvinte cheie

Câmpul keywords este o listă delimitată de virgulă de șiruri care descriu pagina și sunt utilizate în funcții de căutare și descoperire, cum ar fi căutarea pe site și Dynamic Content .

Câmpul keywords acceptă cuvinte cheie plate fără asociere dimensională (de exemplu, gettingstarted ) și cuvinte cheie structurate care utilizează spații de nume dimensionale pentru a reprezenta relația dintre documente și entitățile din lumea reală, cum ar fi limbaje de programare, produse și evenimente (de exemplu, product:ComputeEngine sau language:Python3 ). Puteți adăuga ambele tipuri de keywords în orice câmp de cuvinte cheie.

Dacă introduceți un cuvânt cheie care nu respectă cerințele de formatare, veți vedea un avertisment cu versiunea corect formatată a cuvântului dvs. cheie în rezultatul instrumentului pe care l-ați folosit (de obicei instrumentul de linie de comandă DevSite sau Editorul de conținut DevSite).

HTML 

<meta name="keywords" value="spacetime,timetravel,product:Delorean" />

Markdown 

keywords: spacetime, timetravel, product:Delorean