Side metadata

En DevSite-side er en enkelt enhed af indhold på et websted. En side kan have en titel, en brødtekst, overskriftselementer og metadataattributter, der styrer webstedets funktioner. Når en bruger besøger URL'en for en side, gengiver webstedet en komplet webside baseret på indholdssidens egenskaber, og tilføjer dynamiske elementer såsom sidehoved, sidefod og sidebjælke. Standardadfærd er optimeret til sider med teknisk dokumentation, men en side kan også konfigureres til andre formål, såsom markedsføring og landingssider.

Struktur af en side

sidehoved
projekt bar
sidebjælke
legeme
sidst opdateret

En DevSite-side er en webside, hvis generelle udseende og funktioner administreres af webstedet. En side på Google Developers vises med flere fælles områder. (Ikke alle websteder understøtter alle funktioner.) Hold musen over diagrammet for etiketter.

site header

Webstedets logo, login-widget, søgefelt og topnavigation. Fælles på tværs af hele webstedet.

project bar

Projekt- eller produkttitlen og projektspecifikke widgets (såsom linket "Feedback"). Dette område er defineret af projektets metadata .

sidebar

Hierarkisk navigation i hele bogen. Dette område er defineret af bogmetadata .

body

Sidens titel og indholdet af siden.

page footer ("last updated")

Sidespecifikke widgets (såsom meddelelsen "Sidst opdateret"). Kan også indeholde en CC-licensmeddelelse, som er en projektmetadataattribut.

site footer

Sidefoden links, sprogvalgswidgeten. Fælles på tværs af hele webstedet.

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 attributten for <html> -elementet fortæller DevSite, at dette skal gengives som en DevSite-side og ikke ordret som et HTML-aktiv. Hvis din side vises uden formatering eller en sidehoved eller sidefod, skal du kontrollere, at <html devsite> vises nær toppen af ​​din fil.

Elementerne <html> , <head> og <body> er påkrævet og skal have åbnings- og lukketags.

En typisk side skal også have et <title> -element inde i <head> . Se sidetitel .

Specifikke <meta> -tags styrer sidefunktioner. Disse er beskrevet i denne reference. En typisk side har et "project_path" -metatag, som refererer til en _project.yaml metadatafil, og et "book_path" -metatag, som refererer til en _book.yaml metadatafil. Se Projekter og bøger . <meta> -tags, der genkendes af DevSite, vises normalt ikke på den sidste side.

Andre elementer i <head> og alle elementer i <body> gengives på den sidste side.

Markdown-kildefiler 


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

# Page title

Body content, specified in Markdown, goes here.

En typisk side skal have en titel (f.eks. # Page title ). Se sidetitel .

Specifikke metatags styrer sidefunktioner. Disse er beskrevet i denne reference. En typisk side har et Project: -metatag, som refererer til en _project.yaml -metadatafil, og et Book: -metatag, som refererer til en _book.yaml metadatafil. Se Projekter og bøger. Metatags, der genkendes af DevSite, vises normalt ikke på den sidste side.

Projekter og bøger

Et projekt er beskrevet af en projektmetadatafil ved navn _project.yaml . En bog er beskrevet af en bogmetadatafil ved navn _book.yaml . Disse filer offentliggøres på webstedet sammen med side- og aktivfiler og kan oversættes til flere sprog. Se Projektmetadata og Bogmetadata for oplysninger om disse filers struktur og attributter.

For at knytte en side til et projekt skal du angive attributten project_path . Dens værdi er indholdsstien til filen _project.yaml .

HTML 

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

Markdown 

Project: /path/to/_project.yaml

Hvis en side ikke har en project_path attribut, vil den blive gengivet uden projektbjælkeområdet og dets funktioner. Siden vil ikke blive betragtet som en del af et projekt.

For at knytte en side til en bog skal du angive attributten book_path . Dens værdi er indholdsstien til filen _book.yaml .

HTML 

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

Markdown 

Book: /path/to/_book.yaml

Sidetitel 

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

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

HTML 

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

Markdown 

# Page title

Projekthjemmesider behøver ikke titler,

HTML 

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

Markdown 

no_page_title: true

I særlige tilfælde, hvor den automatiske <h1> ikke ønskes til et specielt layout, men en side stadig har brug for en vinduestitel, kan du beholde titlen, men skjule overskriften med "hide_page_heading" attributten:

HTML 

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

Markdown 

hide_page_heading: true
# Page title

Overskriftsbeskrivelse

Mange DevSite-websteder har en beskrivelse i overskriften. Dette indstilles i metadatafilen _project.yaml og vises automatisk på DevSite-landingssider. Med andre ord vil sider, der er oprettet ved hjælp af _index.yaml -skabelon, automatisk gengive en beskrivelse i headeren, som er indstillet i filen _project.yaml .

Denne beskrivelse kan tilsidesættes for siden ved at angive en description i roden af ​​filen _index.yaml eller undertrykkes ved at indstille hide_description: true i header objektet for landing_page objektet.

Fuld bredde layout

Hvis der er behov for mere kontrol over layoutet, kan du bede DevSite om at give afkald på kontrollen over layoutet for området under sidehovedet og projektlinjen og over sidefoden. For at gøre det skal du indstille metadataattributten "full_width" til "true" .

HTML 

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

Markdown 

full_width: true

Sidst opdateret dato

Som standard, undtagen på sider full-width , inkluderer sidefodområdet en automatisk "sidst opdateret" meddelelse. I de fleste tilfælde giver dette brugerne et ligetil signal om friskheden af ​​indholdet på siden.

I nogle få tilfælde kan disse oplysninger være forvirrende eller kan blive betragtet som fortrolige af produktteamet. For at deaktivere den sidst opdaterede meddelelse på en side skal du indstille attributten hide_last_updated 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 tilsidesætte den automatisk beregnede "sidst opdaterede" dato ved at indstille refresh_date-metatagget 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 af ​​en side er en tekstmæssig sammenfatning af sidens indhold. For at angive en beskrivelse af en side skal du angive et <meta name="description" content="DESCRIPTION" /> element. Bemærk, at beskrivelsesteksten går i en attribut med navnet content , ikke value ; dette matcher webstandardattributten.

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

Indstilling af sidebeskrivelsen får <meta> -tagget med på den sidste side

Billedsti

image_path er stien til billedet, der repræsenterer denne side på sociale medier og DevSite-funktioner som recommendations og dynamic content . Når det er indstillet, vil dette billede blive brugt som sidens OpenGraph-billede, og tilsidesætte projektets indstillinger social media og tenant site's branding-indstillinger.

HTML 

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

Markdown 

image_path: /site-assets/developers_64dp.png

Nøgleord

keywords er en kommasepareret liste over strenge, der beskriver siden og bruges i søge- og opdagelsesfunktioner som webstedssøgning og Dynamic Content .

keywords understøtter flade søgeord uden dimensionel tilknytning (f.eks. gettingstarted ) og strukturerede søgeord, der bruger dimensionelle navnerum til at repræsentere forholdet mellem dokumenter og enheder i den virkelige verden som programmeringssprog, produkter og begivenheder (f.eks. product:ComputeEngine eller language:Python3 ). Du kan tilføje begge typer keywords til et hvilket som helst søgeordsfelt.

Hvis du iscenesætter et søgeord, der ikke er i overensstemmelse med formateringskravene, vil du se en advarsel med den korrekt formaterede version af dit søgeord i outputtet af det værktøj, du har brugt (normalt DevSite-kommandolinjeværktøjet eller DevSite Content Publisher).

HTML 

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

Markdown 

keywords: spacetime, timetravel, product:Delorean