Metagegevens van de pagina
Een DevSite-pagina is een enkele inhoudseenheid op een site. Een pagina kan een titel, een hoofdtekst, headerelementen en metadata-attributen hebben die de functies van de site bepalen. Wanneer een gebruiker de URL van een pagina bezoekt, geeft de site een volledige webpagina weer op basis van de eigenschappen van de inhoudspagina, waarbij dynamische elementen worden toegevoegd, zoals de koptekst, voettekst en zijbalk. Standaardgedrag is geoptimaliseerd voor pagina's met technische documentatie, maar een pagina kan ook worden geconfigureerd voor ander gebruik, zoals marketing- en landingspagina's.
Structuur van een pagina
Een DevSite-pagina is een webpagina waarvan het algemene uiterlijk en de functies worden beheerd door de site. Er wordt een pagina op Google Developers weergegeven met verschillende gemeenschappelijke ruimtes. (Niet alle sites ondersteunen alle functies.) Beweeg uw muis over het diagram voor labels.
site header
Het sitelogo, de aanmeldingswidget, het zoekvak en de navigatie bovenaan. Gemeenschappelijk op de hele site.
project bar
De project- of producttitel en projectspecifieke widgets (zoals de link 'Feedback'). Dit gebied wordt gedefinieerd door projectmetadata .
sidebar
Boekbrede hiërarchische navigatie. Dit gebied wordt gedefinieerd door metagegevens van het boek .
body
De paginatitel en de inhoud van de pagina.
page footer ("last updated")
Paginaspecifieke widgets (zoals de melding 'Laatst bijgewerkt'). Kan ook een CC-licentiekennisgeving bevatten, wat een kenmerk van de projectmetagegevens is.
site footer
De voettekstlinks van de site, de taalkeuzewidget. Gemeenschappelijk op de hele site.
HTML-bronbestanden
<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>
Het devsite attribuut van het <html> -element vertelt DevSite dat dit moet worden weergegeven als een DevSite-pagina en niet letterlijk als een HTML-item. Als uw pagina wordt weergegeven zonder opmaak of kop- of voettekst, controleer dan of <html devsite> bovenaan uw bestand verschijnt.
De <html> , <head> en <body> elementen zijn vereist en moeten openings- en sluitingstags hebben.
Een typische pagina moet ook een <title> -element hebben, binnen de <head> . Zie Paginatitel .
Specifieke <meta> -tags beheren paginafuncties. Deze worden in deze referentie beschreven. Een typische pagina heeft een metatag "project_path" , die verwijst naar een metadatabestand _project.yaml , en een metatag "book_path" , die verwijst naar een metadatabestand _book.yaml . Zie Projecten en boeken . <meta> -tags die door DevSite worden herkend, verschijnen meestal niet op de laatste pagina.
Andere elementen in de <head> en alle elementen in de <body> worden op de laatste pagina weergegeven.
Markdown-bronbestanden
Project: /path/to/_project.yaml
Book: /path/to/_book.yaml
# Page title
Body content, specified in Markdown, goes here.
Een typische pagina moet een titel hebben (bijvoorbeeld # Page title ). Zie Paginatitel .
Specifieke metatags beheren paginafuncties. Deze worden in deze referentie beschreven. Een typische pagina heeft een Project: -metatag, die verwijst naar een _project.yaml -metagegevensbestand, en een Book: -metatag, die verwijst naar een _book.yaml -metagegevensbestand. Zie Projecten en boeken. Metatags die door DevSite worden herkend, verschijnen meestal niet op de laatste pagina.
Projecten en boeken
Een project wordt beschreven door een projectmetagegevensbestand met de naam _project.yaml . Een boek wordt beschreven door een boekmetagegevensbestand met de naam _book.yaml . Deze bestanden worden samen met pagina- en itembestanden op de site gepubliceerd en kunnen in meerdere talen worden vertaald. Zie Projectmetagegevens en Boekmetagegevens voor informatie over de structuur en kenmerken van deze bestanden.
Om een pagina aan een project te koppelen, geeft u het attribuut project_path op. De waarde ervan is het inhoudspad naar het bestand _project.yaml .
HTML
<meta name="project_path" value="/path/to/_project.yaml" />
Afwaardering
Project: /path/to/_project.yaml
Als een pagina geen project_path attribuut heeft, wordt deze weergegeven zonder het projectbalkgebied en de bijbehorende functies. De pagina wordt niet beschouwd als onderdeel van een project.
Om een pagina aan een boek te koppelen, geeft u het kenmerk book_path op. De waarde ervan is het inhoudspad naar het bestand _book.yaml .
HTML
<meta name="book_path" value="/path/to/_book.yaml" />
Afwaardering
Book: /path/to/_book.yaml
Paginatitel
<head>
<title>Page title</title>
...
</head>
Of gebruik een <h1> -element met de page-title klasse in de <body> van de pagina.
HTML
<h1 class="page-title">Page title</h1>
Afwaardering
# Page title
Homepagina's van projecten hebben geen titels nodig,
HTML
<meta name="no_page_title" value="true" />
Afwaardering
no_page_title: true
In speciale gevallen waarin de automatische <h1> niet gewenst is voor een speciale lay-out, maar een pagina toch een venstertitel nodig heeft, kunt u de titel behouden maar de kop verbergen met het attribuut "hide_page_heading" :
HTML
<title>Page title</title>
<meta name="hide_page_heading" value="true" />
Afwaardering
hide_page_heading: true
# Page title
Kopbeschrijving
Veel DevSite-sites hebben een beschrijving in de header. Dit wordt ingesteld in het metadatabestand _project.yaml en wordt automatisch weergegeven op de landingspagina's van DevSite. Met andere woorden, pagina's die zijn gemaakt met behulp van _index.yaml -sjabloon, geven automatisch een beschrijving weer in de header, die is ingesteld in het bestand _project.yaml .
Deze beschrijving kan voor de pagina worden overschreven door een description in te stellen in de hoofdmap van het bestand _index.yaml , of onderdrukt door hide_description: true in te stellen in het header van het landing_page object.
Indeling over de volle breedte
Als er meer controle over de lay-out nodig is, kunt u DevSite vertellen de controle over de lay-out op te geven voor het gebied onder de sitekoptekst en projectbalk en boven de voettekst van de site. Om dit te doen, stelt u het metadatakenmerk "full_width" in op "true" .
HTML
<meta name="full_width" value="true" />
Afwaardering
full_width: true
Datum voor het laatst bijgewerkt
Standaard bevat het gebied van de paginavoettekst , behalve op pagina's full-width , automatisch een melding 'laatst bijgewerkt'. In de meeste gevallen geeft dit gebruikers een duidelijk signaal over de recentheid van de inhoud op de pagina.
In enkele gevallen kan deze informatie verwarrend zijn of door het productteam als vertrouwelijk worden beschouwd. Om de laatst bijgewerkte melding op een pagina uit te schakelen, stelt u het hide_last_updated attribuut in op 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" />
Afwaardering
Project: /time-travel/_project.yaml
Book: /time-travel/_book.yaml
hide_last_updated: true
U kunt de automatisch berekende "laatst bijgewerkte" datum overschrijven door de metatag refresh_date in te stellen op een datum in ISO 8601 notatie:
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" />
Afwaardering
Project: /time-travel/_project.yaml
Book: /time-travel/_book.yaml
refresh_date: 2017-03-27
Paginabeschrijving
De beschrijving van een pagina is een tekstuele samenvatting van de inhoud van de pagina. Om een beschrijving voor een pagina in te stellen, geeft u een <meta name="description" content="DESCRIPTION" /> element op. Merk op dat de beschrijvingstekst in een attribuut met de naam content staat, en niet value ; dit komt overeen met het webstandaardkenmerk.
HTML
<meta name="description" content="It was the best of times, it was the blurst of times..." />
Afwaardering
description: It was the best of times, it was the blurst of times...
Het instellen van de paginabeschrijving zorgt ervoor dat de <meta> -tag op de laatste pagina wordt opgenomen
Afbeeldingspad
Het image_path is het pad naar de afbeelding die deze pagina vertegenwoordigt in sociale media en DevSite-functies zoals recommendations en dynamic content . Indien ingesteld, wordt deze afbeelding gebruikt als de OpenGraph-afbeelding van de pagina, waarbij de social media instellingen van het project en de merkinstellingen tenant site's worden overschreven.
HTML
<meta name="image_path" value="/site-assets/developers_64dp.png" />
Afwaardering
image_path: /site-assets/developers_64dp.png
Trefwoorden
Het keywords is een door komma's gescheiden lijst met tekenreeksen die de pagina beschrijven en worden gebruikt in zoek- en ontdekkingsfuncties zoals zoeken op sites en Dynamic Content .
Het keywords ondersteunt platte trefwoorden zonder dimensionale associatie (bijvoorbeeld gettingstarted ) en gestructureerde trefwoorden die dimensionale naamruimten gebruiken om de relatie weer te geven tussen documenten en entiteiten uit de echte wereld, zoals programmeertalen, producten en gebeurtenissen (bijvoorbeeld product:ComputeEngine of language:Python3 ). U kunt beide typen keywords aan elk trefwoordveld toevoegen.
Als u een trefwoord instelt dat niet voldoet aan de opmaakvereisten, ziet u een waarschuwing met de correct opgemaakte versie van uw trefwoord in de uitvoer van het hulpprogramma dat u hebt gebruikt (meestal het opdrachtregelprogramma DevSite of de DevSite Content Publisher).
HTML
<meta name="keywords" value="spacetime,timetravel,product:Delorean" />
Afwaardering
keywords: spacetime, timetravel, product:Delorean