Metapodaci stranice

Stranica DevSite jedna je jedinica sadržaja na web-mjestu. Stranica može imati naslov, tijelo, elemente zaglavlja i atribute metapodataka koji kontroliraju značajke stranice. Kada korisnik posjeti URL stranice, web mjesto prikazuje kompletnu web stranicu na temelju svojstava stranice sa sadržajem, dodajući dinamičke elemente kao što su zaglavlje, podnožje i bočna traka. Zadana ponašanja optimizirana su za stranice tehničke dokumentacije, ali se stranica može konfigurirati i za druge svrhe, kao što su marketing i odredišne ​​stranice.

Struktura stranice

zaglavlje stranice
traka projekta
bočna traka
tijelo
zadnji put ažuriran

Stranica DevSite je web stranica čijim općim izgledom i značajkama upravlja stranica. Prikazana je stranica na Google Developersu s nekoliko uobičajenih područja. (Ne podržavaju sve stranice sve značajke.) Zadržite pokazivač miša iznad dijagrama za oznake.

site header

Logotip stranice, widget za prijavu, okvir za pretraživanje i gornja navigacija. Uobičajeno na cijelom mjestu.

project bar

Naziv projekta ili proizvoda i widgeti specifični za projekt (kao što je poveznica "Povratne informacije"). Ovo područje definirano je metapodacima projekta .

sidebar

Hijerarhijska navigacija po cijeloj knjizi. Ovo područje definirano je metapodacima knjige .

body

Naslov stranice i sadržaj stranice.

page footer ("last updated")

Widgeti za pojedine stranice (kao što je obavijest "Zadnje ažuriranje"). Može također sadržavati obavijest o CC licenci, koja je atribut metapodataka projekta.

site footer

Veze na podnožje stranice, widget za odabir jezika. Uobičajeno na cijelom mjestu.

HTML izvorne datoteke 

<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 atribut elementa <html> govori DevSiteu da ovo treba biti prikazano kao DevSite stranica, a ne doslovno kao HTML sredstvo. Ako se vaša stranica prikazuje bez oblikovanja ili bez zaglavlja ili podnožja, provjerite pojavljuje li se <html devsite> pri vrhu vaše datoteke.

Elementi <html> , <head> i <body> su obavezni i moraju imati otvarajuće i zatvarajuće oznake.

Tipična stranica također mora imati element <title> unutar <head> . Pogledajte naslov stranice .

Specifične <meta> oznake kontroliraju značajke stranice. Oni su opisani u ovoj referenci. Tipična stranica ima meta oznaku "project_path" , koja se odnosi na datoteku metapodataka _project.yaml , i metaoznaku "book_path" , koja se odnosi na datoteku metapodataka _book.yaml . Pogledajte Projekti i knjige . <meta> oznake koje prepoznaje DevSite obično se ne pojavljuju na završnoj stranici.

Ostali elementi u <head> i svi elementi u <body> prikazuju se na posljednjoj stranici.

Markdown izvorne datoteke 


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

# Page title

Body content, specified in Markdown, goes here.

Tipična stranica mora imati naslov (npr. # Page title ). Pogledajte naslov stranice .

Specifične meta oznake kontroliraju značajke stranice. Oni su opisani u ovoj referenci. Tipična stranica ima meta oznaku Project: koja se odnosi na datoteku metapodataka _project.yaml , i metaoznaku Book: koja se odnosi na datoteku metapodataka _book.yaml . Pogledajte Projekti i knjige. Meta oznake koje prepoznaje DevSite obično se ne pojavljuju na završnoj stranici.

Projekti i knjige

Projekt je opisan datotekom metapodataka projekta pod nazivom _project.yaml . Knjiga je opisana datotekom metapodataka knjige pod nazivom _book.yaml . Te se datoteke objavljuju na web-mjestu zajedno s datotekama stranice i imovine i mogu se prevesti na više jezika. Pogledajte metapodatke projekta i metapodatke knjige za informacije o strukturi i atributima ovih datoteka.

Da biste pridružili stranicu projektu, navedite atribut project_path . Njegova vrijednost je put sadržaja do datoteke _project.yaml .

HTML 

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

Smanjenje 

Project: /path/to/_project.yaml

Ako stranica nema atribut project_path , bit će prikazana bez regije trake projekta i njezinih značajki. Stranica se neće smatrati dijelom projekta.

Da biste pridružili stranicu knjizi, navedite atribut book_path . Njegova vrijednost je put sadržaja do datoteke _book.yaml .

HTML 

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

Smanjenje 

Book: /path/to/_book.yaml

Naslov stranice 

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

Ili upotrijebite element <h1> s klasom page-title u <body> stranice.

HTML 

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

Smanjenje 

# Page title

Početna stranica projekta ne treba naslove,

HTML 

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

Smanjenje 

no_page_title: true

U posebnim slučajevima kada automatski <h1> nije poželjan za poseban izgled, ali stranica i dalje treba naslov prozora, možete zadržati naslov, ali sakriti naslov s atributom "hide_page_heading" :

HTML 

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

Smanjenje 

hide_page_heading: true
# Page title

Opis zaglavlja

Mnoge DevSite stranice imaju opis u zaglavlju. Ovo je postavljeno u datoteci metapodataka _project.yaml i automatski se prikazuje na odredišnim stranicama DevSite. Drugim riječima, stranice koje su stvorene korištenjem _index.yaml šablona automatski će prikazati opis u zaglavlju, koje je postavljeno u datoteci _project.yaml .

Ovaj se opis može nadjačati za stranicu postavljanjem description u korijenu datoteke _index.yaml ili potisnuti postavljanjem hide_description: true unutar objekta header objekta landing_page .

Raspored pune širine

Ako je potrebna veća kontrola nad izgledom, možete reći DevSiteu da prepusti kontrolu nad izgledom za područje ispod zaglavlja stranice i projektne trake te iznad podnožja stranice. Da biste to učinili, postavite atribut metapodataka "full_width" na "true" .

HTML 

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

Smanjenje 

full_width: true

Datum posljednjeg ažuriranja

Prema zadanim postavkama, osim na stranicama full-width , područje podnožja stranice uključuje automatsku obavijest o "zadnjem ažuriranju". U većini slučajeva to korisnicima daje jasan signal o svježini sadržaja na stranici.

U nekoliko slučajeva ove informacije mogu biti zbunjujuće ili ih proizvodni tim može smatrati povjerljivima. Da biste onemogućili obavijest o posljednjem ažuriranju na stranici, postavite 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" />

Smanjenje 

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

Možete nadjačati automatski izračunati datum "zadnjeg ažuriranja" postavljanjem meta oznake refresh_date na datum u 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" />

Smanjenje 

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

Opis stranice

Opis stranice je tekstualni sažetak sadržaja stranice. Da biste postavili opis stranice, navedite element <meta name="description" content="DESCRIPTION" /> . Primijetite da tekst opisa ide u atribut pod nazivom content , a ne value ; ovo odgovara atributu web standarda.

HTML 

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

Smanjenje 

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

Postavljanje opisa stranice uzrokuje da se oznaka <meta> uključi na posljednju stranicu

Put slike

image_path je put do slike koja predstavlja ovu stranicu u društvenim medijima i značajkama DevSitea kao što su recommendations i dynamic content . Kada je postavljena, ova će se slika koristiti kao OpenGraph slika stranice, nadjačavajući postavke social media projekta i postavke brendiranja tenant site's .

HTML 

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

Smanjenje 

image_path: /site-assets/developers_64dp.png

Ključne riječi

Polje keywords popis je nizova odvojenih zarezima koji opisuju stranicu i koriste se u značajkama pretraživanja i otkrivanja kao što su pretraživanje web mjesta i Dynamic Content .

Polje keywords podržava ravne ključne riječi bez dimenzionalne povezanosti (na primjer, gettingstarted ) i strukturirane ključne riječi koje koriste dimenzionalne prostore imena za predstavljanje odnosa između dokumenata i entiteta iz stvarnog svijeta poput programskih jezika, proizvoda i događaja (na primjer, product:ComputeEngine ili language:Python3 ). Možete dodati obje vrste keywords u bilo koje polje ključnih riječi.

Ako postavite ključnu riječ koja nije u skladu sa zahtjevima za oblikovanje, vidjet ćete upozorenje s ispravno formatiranom verzijom vaše ključne riječi u izlazu alata koji ste koristili (obično DevSite alat naredbenog retka ili DevSite Content Publisher).

HTML 

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

Smanjenje 

keywords: spacetime, timetravel, product:Delorean