Ezt az oldalt a Cloud Translation API fordította le.

Oldal metaadatai

A DevSite oldal a webhely egyetlen tartalmi egysége. Az oldalnak címe, törzse, fejlécelemei és metaadat-attribútumai lehetnek, amelyek szabályozzák a webhely funkcióit. Amikor a felhasználó felkeresi egy oldal URL-jét, a webhely a tartalmi oldal tulajdonságai alapján egy teljes weboldalt jelenít meg, dinamikus elemeket, például fejlécet, láblécet és oldalsávot hozzáadva. Az alapértelmezett viselkedések a műszaki dokumentáció oldalaira vannak optimalizálva, de az oldal más célokra is konfigurálható, például marketing és céloldalak számára.

Egy oldal szerkezete

A DevSite oldal olyan weboldal, amelynek általános megjelenését és jellemzőit a webhely kezeli. Megjelenik a Google Developers egyik oldala, ahol számos közös terület található. (Nem minden webhely támogatja az összes funkciót.) Vigye az egeret a diagram fölé a címkék megjelenítéséhez.

site header

A webhely logója, a bejelentkezési modul, a keresőmező és a felső navigáció. Az egész webhelyen gyakori.

project bar

A projekt vagy termék címe és projektspecifikus widgetek (például a „Visszajelzés” hivatkozás). Ezt a területet a projekt metaadatai határozzák meg.

sidebar

Könyvszintű hierarchikus navigáció. Ezt a területet a könyv metaadatai határozzák meg.

body

Az oldal címe és az oldal tartalma.

page footer ("last updated")

Oldalspecifikus widgetek (például az „Utolsó frissítés” értesítés). Tartalmazhat egy CC licenc értesítést is, amely a projekt metaadat attribútuma.

site footer

A webhely láblécének hivatkozásai, a nyelvválasztó widget. Az egész webhelyen gyakori.

HTML forrásfájlok

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

A <html> elem devsite attribútuma azt mondja a DevSite-nak, hogy ezt DevSite oldalként kell megjeleníteni, nem pedig szó szerint HTML-elemként. Ha az oldal formázás vagy fejléc vagy lábléc nélkül jelenik meg, ellenőrizze, hogy a <html devsite> megjelenik-e a fájl tetején.

A <html> , <head> és <body> elemek kötelezőek, és rendelkezniük kell nyitó és záró címkékkel.

Egy tipikus oldalon egy <title> elemnek is kell lennie a <head> belsejében. Lásd az oldal címét .

Speciális <meta> címkék szabályozzák az oldal jellemzőit. Ezek leírása ebben a hivatkozásban található. Egy tipikus oldalon van egy "project_path" metacímke, amely egy _project.yaml metaadatfájlra utal, és egy "book_path" metacímke, amely egy _book.yaml metaadatfájlra utal. Lásd Projektek és könyvek . A DevSite által felismert <meta> címkék általában nem jelennek meg az utolsó oldalon.

A <head> többi eleme és a <body> minden eleme az utolsó oldalon jelenik meg.

Markdown forrásfájlok


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

# Page title

Body content, specified in Markdown, goes here.

Egy tipikus oldalnak címmel kell rendelkeznie (pl. # Page title ). Lásd az oldal címét .

Konkrét metacímkék szabályozzák az oldal jellemzőit. Ezek leírása ebben a hivatkozásban található. Egy tipikus oldalon található egy Project: metacímke, amely egy _project.yaml metaadatfájlra utal, és egy Book: metacímke, amely egy _book.yaml metaadatfájlra utal. Lásd Projektek és könyvek. A DevSite által felismert metacímkék általában nem jelennek meg az utolsó oldalon.

Projektek és könyvek

A projektet egy _project.yaml nevű projekt metaadatfájl írja le. Egy könyvet egy _book.yaml nevű könyv metaadatfájl írja le. Ezeket a fájlokat az oldal- és tartalomfájlokkal együtt közzéteszik a webhelyen, és több nyelvre is lefordíthatók. A fájlok szerkezetével és attribútumaival kapcsolatos információkért lásd: Projekt metaadatok és Könyv metaadatok .

Egy oldal projekthez való társításához adja meg a project_path attribútumot. Értéke a _project.yaml fájl tartalmi elérési útja.

HTML

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

Árleszállítás

Project: /path/to/_project.yaml

Ha egy oldal nem rendelkezik project_path attribútummal, akkor a projektsáv régiója és szolgáltatásai nélkül jelenik meg. Az oldal nem tekinthető projekt részének.

Egy oldal könyvhöz való társításához adja meg a book_path attribútumot. Értéke a _book.yaml fájl tartalomútvonala.

HTML

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

Árleszállítás

Book: /path/to/_book.yaml

Oldal címe

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

Vagy használjon egy <h1> elemet a page-title osztállyal az oldal <body> részében.

HTML

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

Árleszállítás

# Page title

A projekt honlapjainak nincs szükségük címekre,

HTML

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

Árleszállítás

no_page_title: true

Speciális esetekben, amikor az automatikus <h1> nem kívánatos egy speciális elrendezéshez, de az oldalnak továbbra is szüksége van egy ablakcímre, a címet megtarthatja, de a címsort elrejtheti a "hide_page_heading" attribútummal:

HTML

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

Árleszállítás

hide_page_heading: true
# Page title

Fejléc leírása

Sok DevSite webhely fejlécében található leírás. Ez a _project.yaml metaadatfájlban van beállítva, és automatikusan megjelenik a DevSite céloldalain. Más szóval, _index.yaml sablonnal létrehozott oldalak automatikusan leírást jelenítenek meg a fejlécben, amely a _project.yaml fájlban van beállítva.

Ez a leírás felülbírálható az oldalra vonatkozóan, ha egy description ad meg az _index.yaml fájl gyökerében, vagy letiltható hide_description: true beállításával a landing_page objektum header .

Teljes szélességű elrendezés

Ha nagyobb szabályozásra van szükség az elrendezés felett, megmondhatja a DevSite-ot, hogy adja fel az elrendezés irányítását a webhely fejléce és projektsávja alatt, valamint a webhely lábléce felett. Ehhez állítsa a "full_width" metaadat attribútumot "true" értékre.

HTML

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

Árleszállítás

full_width: true

Utolsó frissítés dátuma

Alapértelmezés szerint full-width oldalak kivételével az oldal lábléc régiója automatikus „utoljára frissített” értesítést tartalmaz. A legtöbb esetben ez egyértelmű jelzést ad a felhasználóknak az oldalon található tartalom frissességéről.

Néhány esetben ez az információ zavaró lehet, vagy a termékcsapat bizalmasnak tekintheti. Az oldal utoljára frissített értesítésének letiltásához állítsa a hide_last_updated attribútumot true értékre:

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" />

Árleszállítás

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

Az automatikusan kiszámított „utolsó frissítés” dátumot felülírhatja, ha a refresh_date metacímkét ISO 8601 formátumú dátumra állítja:

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" />

Árleszállítás

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

Az oldal leírása

Az oldal leírása az oldal tartalmának szöveges összefoglalása. Egy oldal leírásának beállításához adjon meg egy <meta name="description" content="DESCRIPTION" /> elemet. Figyeljük meg, hogy a leírás szövege a content nevű attribútumban szerepel, nem value ; ez megfelel a web standard attribútumának.

HTML

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

Árleszállítás

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

Az oldalleírás beállítása azt eredményezi, hogy a <meta> címke szerepelni fog az utolsó oldalon

Képútvonal

Az image_path a kép elérési útja, amely ezt az oldalt képviseli a közösségi médiában és a DevSite szolgáltatásaiban, például recommendations és dynamic content . Ha be van állítva, ez a kép az oldal OpenGraph képeként lesz használva, felülírva a projekt social media beállításait és a tenant site's márkabeállításait.

HTML

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

Árleszállítás

image_path: /site-assets/developers_64dp.png

Kulcsszavak

A keywords az oldalt leíró karakterláncok vesszővel tagolt listája, és a keresési és felfedezési funkciókban, például a webhelyen történő keresésben és Dynamic Content használatos.

A keywords mező támogatja a dimenziós asszociáció nélküli lapos kulcsszavakat (például gettingstarted ) és a strukturált kulcsszavakat, amelyek dimenziós névtereket használnak a dokumentumok és a valós világ entitásai, például programozási nyelvek, termékek és események közötti kapcsolat megjelenítésére (például product:ComputeEngine vagy language:Python3 ). Mindkét keywords hozzáadhatja bármelyik kulcsszómezőhöz.

Ha olyan kulcsszót állít be, amely nem felel meg a formázási követelményeknek, a használt eszköz (általában a DevSite parancssori eszköz vagy a DevSite Content Publisher) kimenetében a kulcsszó helyesen formázott verziójával együtt figyelmeztetést fog látni.

HTML

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

Árleszállítás

keywords: spacetime, timetravel, product:Delorean