Ta stran je bila prevedena z vmesnikom Cloud Translation API.

Metapodatki strani

Stran DevSite je ena enota vsebine na spletnem mestu. Stran ima lahko naslov, telo, elemente glave in atribute metapodatkov, ki nadzirajo funkcije spletnega mesta. Ko uporabnik obišče URL strani, spletno mesto upodobi celotno spletno stran na podlagi lastnosti strani z vsebino in doda dinamične elemente, kot so glava, noga in stranska vrstica. Privzeto vedenje je optimizirano za strani tehnične dokumentacije, vendar je stran mogoče konfigurirati tudi za druge namene, kot so trženje in ciljne strani.

Struktura strani

glava spletnega mesta

projektna vrstica

telo

nazadnje posodobljeno

Stran DevSite je spletna stran, katere splošni videz in funkcije upravlja spletno mesto. Stran na Google Developers je prikazana z več skupnimi področji. (Vsa spletna mesta ne podpirajo vseh funkcij.) Za oznake premaknite miško nad diagram.

site header

Logotip spletnega mesta, pripomoček za vpis, iskalno polje in navigacija na vrhu. Skupno na celotnem spletnem mestu.

project bar

Naslov projekta ali izdelka in gradniki, specifični za projekt (kot je povezava »Povratne informacije«). To področje je opredeljeno z metapodatki projekta .

sidebar

Hierarhična navigacija po vsej knjigi. To področje je opredeljeno z metapodatki knjige .

body

Naslov strani in vsebina strani.

page footer ("last updated")

Pripomočki za posamezne strani (kot je obvestilo »Nazadnje posodobljeno«). Lahko vsebuje tudi obvestilo o licenci CC, ki je atribut metapodatkov projekta.

site footer

Povezave v nogi spletnega mesta, pripomoček za izbiro jezika. Skupno na celotnem spletnem mestu.

Izvorne datoteke 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>

Atribut devsite elementa <html> pove DevSite, da mora biti to upodobljeno kot stran DevSite in ne dobesedno kot sredstvo HTML. Če je vaša stran prikazana brez oblikovanja ali glave ali noge, preverite, ali se <html devsite> pojavi na vrhu vaše datoteke.

Elementi <html> , <head> in <body> so obvezni in morajo imeti odpiralne in zapiralne oznake.

Tipična stran mora imeti tudi element <title> znotraj <head> . Glej naslov strani .

Posebne <meta> oznake nadzorujejo funkcije strani. Ti so opisani v tem sklicu. Običajna stran ima metaoznako "project_path" , ki se nanaša na datoteko z metapodatki _project.yaml , in metaoznako "book_path" , ki se nanaša na datoteko z metapodatki _book.yaml . Glejte Projekti in knjige . Oznake <meta> , ki jih prepozna DevSite, se običajno ne prikažejo na končni strani.

Drugi elementi v <head> in vsi elementi v <body> so upodobljeni na zadnji strani.

Markdown izvorne datoteke


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

# Page title

Body content, specified in Markdown, goes here.

Tipična stran mora imeti naslov (npr. # Page title ). Glej naslov strani .

Posebne meta oznake nadzorujejo funkcije strani. Ti so opisani v tem sklicu. Običajna stran ima metaoznako Project: ki se nanaša na datoteko z metapodatki _project.yaml , in metaoznako Book: ki se nanaša na datoteko z metapodatki _book.yaml . Glejte Projekti in knjige. Meta oznake, ki jih prepozna DevSite, se običajno ne prikažejo na končni strani.

Projekti in knjige

Projekt je opisan z datoteko z metapodatki projekta z imenom _project.yaml . Knjigo opisuje datoteka z metapodatki knjige z imenom _book.yaml . Te datoteke so objavljene na spletnem mestu skupaj z datotekami strani in sredstev ter jih je mogoče prevesti v več jezikov. Za informacije o strukturi in atributih teh datotek glejte metapodatke projekta in metapodatke knjige .

Če želite stran povezati s projektom, zagotovite atribut project_path . Njegova vrednost je pot vsebine do datoteke _project.yaml .

HTML

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

Markdown

Project: /path/to/_project.yaml

Če stran nima atributa project_path , bo upodobljena brez območja projektne vrstice in njenih funkcij. Stran ne bo obravnavana kot del projekta.

Če želite stran povezati s knjigo, zagotovite atribut book_path . Njegova vrednost je pot vsebine do datoteke _book.yaml .

HTML

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

Markdown

Book: /path/to/_book.yaml

Naslov strani

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

Ali pa uporabite element <h1> z razredom page-title v <body> strani.

HTML

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

Markdown

# Page title

Domače strani projekta ne potrebujejo naslovov,

HTML

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

Markdown

no_page_title: true

V posebnih primerih, ko samodejni <h1> ni zaželen za posebno postavitev, vendar stran še vedno potrebuje naslov okna, lahko obdržite naslov, vendar skrijete naslov z atributom "hide_page_heading" :

HTML

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

Markdown

hide_page_heading: true
# Page title

Opis glave

Veliko spletnih mest DevSite ima opis v glavi. To je nastavljeno v datoteki z metapodatki _project.yaml in je samodejno prikazano na ciljnih straneh DevSite. Z drugimi besedami, strani, ustvarjene s predlogami _index.yaml , bodo samodejno upodobile opis v glavi, ki je nastavljena v datoteki _project.yaml .

Ta opis lahko za stran preglasite tako, da nastavite description v korenu datoteke _index.yaml , ali pa ga zatrete z nastavitvijo hide_description: true znotraj predmeta header objekta landing_page .

Postavitev v polni širini

Če je potreben večji nadzor nad postavitvijo, lahko DevSiteu naročite, naj prepusti nadzor nad postavitvijo za območje pod glavo mesta in projektno vrstico ter nad nogo mesta. Če želite to narediti, nastavite atribut metapodatkov "full_width" na "true" .

HTML

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

Markdown

full_width: true

Datum zadnje posodobitve

Privzeto, razen na straneh full-width , območje noge strani vključuje samodejno obvestilo »zadnje posodobljeno«. V večini primerov to daje uporabnikom neposreden signal o svežosti vsebine na strani.

V nekaj primerih so lahko te informacije zmedene ali pa jih ekipa izdelka morda obravnava kot zaupne. Če želite onemogočiti zadnje posodobljeno obvestilo na strani, nastavite atribut hide_last_updated na 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

Samodejno izračunani datum »zadnje posodobitve« lahko preglasite tako, da metaoznako refresh_date nastavite na datum v formatu 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

Opis strani

Opis strani je besedilni povzetek vsebine strani. Če želite nastaviti opis za stran, zagotovite element <meta name="description" content="DESCRIPTION" /> . Upoštevajte, da je opisno besedilo vključeno v atribut z imenom content , ne value ; to se ujema z atributom spletnega standarda.

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

Nastavitev opisa strani povzroči vključitev oznake <meta> na končno stran

Pot slike

image_path je pot do slike, ki predstavlja to stran v družabnih medijih in funkcijah DevSite, kot so recommendations in dynamic content . Ko je nastavljena, bo ta slika uporabljena kot slika OpenGraph strani, pri čemer bo preglasila nastavitve social media projekta in nastavitve blagovne znamke tenant site's .

HTML

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

Markdown

image_path: /site-assets/developers_64dp.png

Ključne besede

Polje keywords je z vejicami ločen seznam nizov, ki opisujejo stran in se uporabljajo v funkcijah iskanja in odkrivanja, kot sta iskanje po spletnem mestu in Dynamic Content .

Polje keywords podpira ravne ključne besede brez dimenzionalne povezave (na primer gettingstarted ) in strukturirane ključne besede, ki uporabljajo dimenzionalne imenske prostore za predstavitev razmerja med dokumenti in entitetami iz resničnega sveta, kot so programski jeziki, izdelki in dogodki (na primer product:ComputeEngine ali language:Python3 ). V poljubno polje s ključnimi besedami lahko dodate obe vrsti keywords .

Če uprizorite ključno besedo, ki ni v skladu z zahtevami glede oblikovanja, boste v izhodu orodja, ki ste ga uporabili (običajno orodje ukazne vrstice DevSite ali DevSite Content Publisher), videli opozorilo s pravilno oblikovano različico vaše ključne besede.

HTML

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

Markdown

keywords: spacetime, timetravel, product:Delorean