Metadades de la pàgina
Una pàgina DevSite és una unitat única de contingut d'un lloc. Una pàgina pot tenir un títol, un cos, elements de capçalera i atributs de metadades que controlen les característiques del lloc. Quan un usuari visita l'URL d'una pàgina, el lloc representa una pàgina web completa basada en les propietats de la pàgina de contingut, afegint elements dinàmics com ara la capçalera, el peu de pàgina i la barra lateral. Els comportaments predeterminats estan optimitzats per a pàgines de documentació tècnica, però una pàgina també es pot configurar per a altres usos, com ara màrqueting i pàgines de destinació.
Estructura d'una pàgina
Una pàgina DevSite és una pàgina web l'aspecte general i les característiques de la qual són gestionades pel lloc. Es mostra una pàgina a Google Developers amb diverses àrees comunes. (No tots els llocs admeten totes les funcions.) Passeu el ratolí per sobre del diagrama de les etiquetes.
site header
El logotip del lloc, el giny d'inici de sessió, el quadre de cerca i la navegació superior. Comú a tot el lloc.
project bar
El títol del projecte o del producte i els widgets específics del projecte (com ara l'enllaç "Comentaris"). Aquesta àrea està definida per les metadades del projecte .
sidebar
Navegació jeràrquica a tot el llibre. Aquesta àrea està definida per les metadades del llibre .
body
El títol de la pàgina i el contingut de la pàgina.
page footer ("last updated")
Ginys específics de la pàgina (com ara l'avís de "Darrera actualització"). També pot contenir un avís de llicència CC, que és un atribut de metadades del projecte.
site footer
Els enllaços al peu de pàgina del lloc, el giny de selecció d'idioma. Comú a tot el lloc.
Fitxers font 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>
L'atribut devsite de l'element <html> indica a DevSite que s'ha de representar com a pàgina de DevSite i no textualment com a recurs HTML. Si la vostra pàgina apareix sense format, ni cap capçalera ni peu de pàgina, comproveu que <html devsite> apareix a la part superior del fitxer.
Els elements <html> , <head> i <body> són obligatoris i han de tenir etiquetes d'obertura i de tancament.
Una pàgina típica també ha de tenir un element <title> , dins del <head> . Vegeu el títol de la pàgina .
Les etiquetes <meta> específiques controlen les funcions de la pàgina. Aquests es descriuen en aquesta referència. Una pàgina típica té una metaetiqueta "project_path" , que fa referència a un fitxer de metadades _project.yaml , i una metaetiqueta "book_path" , que fa referència a un fitxer de metadades _book.yaml . Veure Projectes i llibres . Les etiquetes <meta> reconegudes per DevSite normalment no apareixen a la pàgina final.
Altres elements del <head> i tots els elements del <body> es representen a la pàgina final.
Fitxers font Markdown
Project: /path/to/_project.yaml
Book: /path/to/_book.yaml
# Page title
Body content, specified in Markdown, goes here.
Una pàgina típica ha de tenir un títol (p. ex., # Page title ). Vegeu el títol de la pàgina .
Les metaetiquetes específiques controlen les funcions de la pàgina. Aquests es descriuen en aquesta referència. Una pàgina típica té una metaetiqueta Project: que fa referència a un fitxer de metadades _project.yaml , i una metaetiqueta Book: que fa referència a un fitxer de metadades _book.yaml . Veure Projectes i llibres. Les metaetiquetes reconegudes per DevSite normalment no apareixen a la pàgina final.
Projectes i llibres
Un projecte es descriu mitjançant un fitxer de metadades del projecte anomenat _project.yaml . Un llibre es descriu mitjançant un fitxer de metadades de llibre anomenat _book.yaml . Aquests fitxers es publiquen al lloc juntament amb fitxers de pàgines i recursos, i es poden traduir a diversos idiomes. Consulteu Metadades del projecte i Metadades del llibre per obtenir informació sobre l'estructura i els atributs d'aquests fitxers.
Per associar una pàgina a un projecte, proporcioneu l'atribut project_path . El seu valor és la ruta del contingut al fitxer _project.yaml .
HTML
<meta name="project_path" value="/path/to/_project.yaml" />
Reducció
Project: /path/to/_project.yaml
Si una pàgina no té un atribut project_path , es representarà sense la regió de la barra de projecte i les seves característiques. La pàgina no es considerarà part d'un projecte.
Per associar una pàgina amb un llibre, proporcioneu l'atribut book_path . El seu valor és la ruta del contingut al fitxer _book.yaml .
HTML
<meta name="book_path" value="/path/to/_book.yaml" />
Reducció
Book: /path/to/_book.yaml
Títol de la pàgina
<head>
<title>Page title</title>
...
</head>
O utilitzeu un element <h1> amb la classe page-title al <body> de la pàgina.
HTML
<h1 class="page-title">Page title</h1>
Reducció
# Page title
Les pàgines d'inici del projecte no necessiten títols,
HTML
<meta name="no_page_title" value="true" />
Reducció
no_page_title: true
En casos especials en què el <h1> automàtic no es desitja per a un disseny especial però una pàgina encara necessita un títol de finestra, podeu mantenir el títol però amagar l'encapçalament amb l'atribut "hide_page_heading" :
HTML
<title>Page title</title>
<meta name="hide_page_heading" value="true" />
Reducció
hide_page_heading: true
# Page title
Descripció de la capçalera
Molts llocs de DevSite tenen una descripció a la capçalera. Això s'estableix al fitxer de metadades _project.yaml i es mostra automàticament a les pàgines de destinació de DevSite. En altres paraules, les pàgines que es creen amb la plantilla _index.yaml mostraran automàticament una descripció a la capçalera, que s'estableix al fitxer _project.yaml .
Aquesta descripció es pot substituir per a la pàgina si estableix una description a l'arrel del fitxer _index.yaml , o es pot suprimir si estableix hide_description: true a l'objecte header de l'objecte landing_page .
Disseny d'amplada completa
Si cal més control sobre el disseny, podeu dir-li a DevSite que renunciï al control sobre el disseny de l'àrea a sota de la capçalera del lloc i la barra del projecte i a sobre del peu de pàgina del lloc. Per fer-ho, establiu l'atribut de metadades "full_width" a "true" .
HTML
<meta name="full_width" value="true" />
Reducció
full_width: true
Data de l'última actualització
De manera predeterminada, excepte a les pàgines full-width , la regió del peu de pàgina inclou un avís automàtic de "darrera actualització". En la majoria dels casos, això ofereix als usuaris un senyal senzill sobre la frescor del contingut de la pàgina.
En alguns casos, aquesta informació pot ser confusa o pot ser considerada confidencial per l'equip del producte. Per desactivar l'avís de l'última actualització d'una pàgina, establiu l'atribut hide_last_updated a 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" />
Reducció
Project: /time-travel/_project.yaml
Book: /time-travel/_book.yaml
hide_last_updated: true
Podeu anul·lar la data de "darrera actualització" calculada automàticament configurant la metaetiqueta refresh_date en una data en 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" />
Reducció
Project: /time-travel/_project.yaml
Book: /time-travel/_book.yaml
refresh_date: 2017-03-27
Descripció de la pàgina
La descripció d'una pàgina és un resum textual del contingut de la pàgina. Per establir una descripció per a una pàgina, proporcioneu un element <meta name="description" content="DESCRIPTION" /> . Observeu que el text de descripció va en un atribut anomenat content , no value ; això coincideix amb l'atribut estàndard web.
HTML
<meta name="description" content="It was the best of times, it was the blurst of times..." />
Reducció
description: It was the best of times, it was the blurst of times...
L'establiment de la descripció de la pàgina fa que l'etiqueta <meta> s'inclogui a la pàgina final
Camí de la imatge
image_path és el camí a la imatge que representa aquesta pàgina a les xarxes socials i a les funcions de DevSite, com ara recommendations i dynamic content . Quan s'estableixi, aquesta imatge s'utilitzarà com a imatge OpenGraph de la pàgina, anul·lant la configuració social media del projecte i la configuració de la marca tenant site's .
HTML
<meta name="image_path" value="/site-assets/developers_64dp.png" />
Reducció
image_path: /site-assets/developers_64dp.png
Paraules clau
El camp keywords és una llista delimitada per comes de cadenes que descriuen la pàgina i que s'utilitzen a les funcions de cerca i descobriment com la cerca al lloc i Dynamic Content .
El camp keywords admet paraules clau planes sense associació dimensional (per exemple, gettingstarted ) i paraules clau estructurades que utilitzen espais de noms dimensionals per representar la relació entre documents i entitats del món real, com ara llenguatges de programació, productes i esdeveniments (per exemple, product:ComputeEngine o language:Python3 ). Podeu afegir els dos tipus de keywords a qualsevol camp de paraules clau.
Si poseu una paraula clau que no s'ajusta als requisits de format, veureu un avís amb la versió correctament formatada de la vostra paraula clau a la sortida de l'eina que heu utilitzat (normalment l'eina de línia d'ordres DevSite o l'editor de contingut de DevSite).
HTML
<meta name="keywords" value="spacetime,timetravel,product:Delorean" />
Reducció
keywords: spacetime, timetravel, product:Delorean