Sidemetadata

En DevSite-side er en enkelt enhet med innhold på et nettsted. En side kan ha en tittel, en brødtekst, overskriftselementer og metadataattributter som kontrollerer funksjonene til nettstedet. Når en bruker besøker URL-en til en side, gjengir nettstedet en komplett nettside basert på innholdssidens egenskaper, og legger til dynamiske elementer som topptekst, bunntekst og sidefelt. Standard atferd er optimalisert for sider med teknisk dokumentasjon, men en side kan også konfigureres for annen bruk, for eksempel markedsføring og landingssider.

Strukturen til en side

sideoverskrift
prosjekt bar
sidefelt
kropp
sist oppdatert

En DevSite-side er en nettside hvis generelle utseende og funksjoner administreres av nettstedet. En side på Google Developers vises med flere fellesområder. (Ikke alle nettsteder støtter alle funksjoner.) Hold musepekeren over diagrammet for etiketter.

site header

Nettstedets logo, påloggingswidget, søkeboks og toppnavigering. Felles på hele nettstedet.

project bar

Prosjekt- eller produkttittelen og prosjektspesifikke widgets (for eksempel «Tilbakemelding»-koblingen). Dette området er definert av prosjektmetadata .

sidebar

Hierarkisk navigasjon for hele boken. Dette området er definert av bokmetadata .

body

Sidetittelen og innholdet på siden.

page footer ("last updated")

Sidespesifikke widgets (for eksempel «Sist oppdatert»-varsel). Kan også inneholde en CC-lisensmelding, som er et prosjektmetadataattributt.

site footer

Sidebunnteksten, widgeten for valg av språk. Felles på hele nettstedet.

HTML-kildefiler 

<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 attributtet til <html> -elementet forteller DevSite at dette skal gjengis som en DevSite-side og ikke ordrett som et HTML-element. Hvis siden din vises uten formatering eller topp- eller bunntekst, kontroller at <html devsite> vises nær toppen av filen.

Elementene <html> , <head> og <body> er obligatoriske og må ha åpnings- og lukkingskoder.

En typisk side må også ha et <title> -element inne i <head> . Se sidetittel .

Spesifikke <meta> -tagger kontrollerer sidefunksjoner. Disse er beskrevet i denne referansen. En typisk side har en "project_path" -metatag, som refererer til en _project.yaml metadatafil, og en "book_path" -metatag, som refererer til en _book.yaml metadatafil. Se Prosjekter og bøker . <meta> -tagger gjenkjent av DevSite vises vanligvis ikke på den siste siden.

Andre elementer i <head> og alle elementer i <body> gjengis på den siste siden.

Markdown kildefiler 


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

# Page title

Body content, specified in Markdown, goes here.

En typisk side må ha en tittel (f.eks. # Page title ). Se sidetittel .

Spesifikke metakoder kontrollerer sidefunksjoner. Disse er beskrevet i denne referansen. En typisk side har en Project: -metatag, som refererer til en _project.yaml -metadatafil, og en Book: -metatag, som refererer til en _book.yaml metadatafil. Se Prosjekter og bøker. Metakoder gjenkjent av DevSite vises vanligvis ikke på den siste siden.

Prosjekter og bøker

Et prosjekt er beskrevet av en prosjektmetadatafil kalt _project.yaml . En bok er beskrevet av en bokmetadatafil kalt _book.yaml . Disse filene publiseres på nettstedet sammen med side- og ressursfiler, og kan oversettes til flere språk. Se Prosjektmetadata og Bokmetadata for informasjon om strukturen og attributtene til disse filene.

For å knytte en side til et prosjekt, oppgi attributtet project_path . Verdien er innholdsbanen til _project.yaml filen.

HTML 

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

Markdown 

Project: /path/to/_project.yaml

Hvis en side ikke har et project_path attributt, vil den bli gjengitt uten prosjektlinjen og dens funksjoner. Siden vil ikke anses som en del av et prosjekt.

For å knytte en side til en bok, oppgi book_path attributtet. Verdien er innholdsbanen til _book.yaml filen.

HTML 

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

Markdown 

Book: /path/to/_book.yaml

Sidetittel 

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

Eller bruk et <h1> -element med page-title i <body> på siden.

HTML 

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

Markdown 

# Page title

Prosjekthjemmesider trenger ikke titler,

HTML 

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

Markdown 

no_page_title: true

I spesielle tilfeller der den automatiske <h1> ikke er ønsket for en spesiell layout, men en side fortsatt trenger en vindustittel, kan du beholde tittelen, men skjule overskriften med "hide_page_heading" -attributtet:

HTML 

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

Markdown 

hide_page_heading: true
# Page title

Overskriftsbeskrivelse

Mange DevSite-nettsteder har en beskrivelse i overskriften. Dette settes i metadatafilen _project.yaml og vises automatisk på DevSite-landingssidene. Med andre ord, sider som er opprettet ved hjelp av _index.yaml -maler vil automatisk gjengi en beskrivelse i overskriften, som er satt i _project.yaml filen.

Denne beskrivelsen kan overstyres for siden ved å sette en description ved roten av filen _index.yaml , eller undertrykkes ved å angi hide_description: true i header objektet til landing_page objektet.

Oppsett i full bredde

Hvis det er behov for mer kontroll over oppsettet, kan du be DevSite om å gi fra seg kontroll over oppsettet for området under sideoverskriften og prosjektlinjen og over sidebunnteksten. For å gjøre det, sett "full_width" -metadataattributtet til "true" .

HTML 

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

Markdown 

full_width: true

Sist oppdatert dato

Som standard, bortsett fra på sider full-width , inkluderer bunntekstområdet et automatisk "sist oppdatert" varsel. I de fleste tilfeller gir dette brukerne et enkelt signal om friskheten til innholdet på siden.

I noen få tilfeller kan denne informasjonen være forvirrende eller kan anses som konfidensiell av produktteamet. For å deaktivere det sist oppdaterte varselet på en side, sett hide_last_updated attributtet til 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

Du kan overstyre den automatisk beregnede "sist oppdatert"-datoen ved å sette refresh_date-metakoden til en dato i ISO 8601 format:

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

Sidebeskrivelse

Beskrivelsen av en side er et tekstlig sammendrag av innholdet på siden. For å angi en beskrivelse for en side, oppgi et <meta name="description" content="DESCRIPTION" /> element. Legg merke til at beskrivelsesteksten går i et attributt kalt content , ikke value ; dette samsvarer med webstandardattributtet.

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...

Innstilling av sidebeskrivelsen fører til at <meta> -taggen inkluderes på den siste siden

Bildebane

image_path er banen til bildet som representerer denne siden i sosiale medier og DevSite-funksjoner som recommendations og dynamic content . Når dette er angitt, vil dette bildet bli brukt som sidens OpenGraph-bilde, og overstyre prosjektets innstillinger social media og tenant site's merkevareinnstillinger.

HTML 

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

Markdown 

image_path: /site-assets/developers_64dp.png

Nøkkelord

keywords er en kommadelt liste over strenger som beskriver siden og brukes i søke- og oppdagelsesfunksjoner som nettstedsøk og Dynamic Content .

keywords støtter flate nøkkelord uten dimensjonell assosiasjon (for eksempel gettingstarted ) og strukturerte søkeord som bruker dimensjonale navnerom for å representere forholdet mellom dokumenter og virkelige enheter som programmeringsspråk, produkter og hendelser (for eksempel product:ComputeEngine eller language:Python3 ). Du kan legge til begge typer keywords i et hvilket som helst søkeordfelt.

Hvis du iscenesetter et nøkkelord som ikke er i samsvar med formateringskravene, vil du se en advarsel med den riktig formaterte versjonen av søkeordet i utdataene til verktøyet du har brukt (vanligvis DevSite-kommandolinjeverktøyet eller DevSite Content Publisher).

HTML 

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

Markdown 

keywords: spacetime, timetravel, product:Delorean