فراداده صفحه

صفحه DevSite یک واحد محتوایی در یک سایت است. یک صفحه می تواند دارای عنوان، بدنه، عناصر هدر و ویژگی های ابرداده باشد که ویژگی های سایت را کنترل می کند. هنگامی که کاربر از URL یک صفحه بازدید می کند، سایت یک صفحه وب کامل را بر اساس ویژگی های صفحه محتوا ارائه می دهد و عناصر پویا مانند هدر، پاورقی و نوار کناری را اضافه می کند. رفتارهای پیش‌فرض برای صفحات مستندات فنی بهینه‌سازی شده‌اند، اما یک صفحه را می‌توان برای کاربردهای دیگر مانند بازاریابی و صفحات فرود نیز پیکربندی کرد.

ساختار یک صفحه

هدر سایت
نوار پروژه
نوار کناری
بدن
آخرین به روز رسانی

صفحه DevSite یک صفحه وب است که ظاهر کلی و ویژگی های آن توسط سایت مدیریت می شود. صفحه ای در Google Developers با چندین قسمت مشترک نمایش داده می شود. (همه سایت ها از همه ویژگی ها پشتیبانی نمی کنند.) ماوس خود را روی نمودار برای برچسب ها نگه دارید.

site header

لوگوی سایت، ویجت ورود به سیستم، کادر جستجو و ناوبری بالا. در کل سایت رایج است.

project bar

عنوان پروژه یا محصول، و ویجت های خاص پروژه (مانند پیوند "بازخورد"). این منطقه توسط ابرداده پروژه تعریف می شود.

sidebar

ناوبری سلسله مراتبی در سراسر کتاب. این ناحیه با فراداده کتاب تعریف می شود.

body

عنوان صفحه و محتوای صفحه.

page footer ("last updated")

ویجت های خاص صفحه (مانند اطلاعیه "آخرین به روز رسانی"). همچنین ممکن است حاوی یک اعلان مجوز CC باشد که یک ویژگی فراداده پروژه است.

site footer

پیوندهای پاورقی سایت، ویجت انتخاب زبان. در کل سایت رایج است.

فایل های منبع 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>

ویژگی devsite عنصر <html> به DevSite می گوید که باید به عنوان یک صفحه DevSite ارائه شود و نه به صورت کلمه به عنوان یک دارایی HTML. اگر صفحه شما بدون قالب بندی یا سرصفحه یا پاورقی نمایش داده می شود، بررسی کنید که <html devsite> در بالای فایل شما ظاهر شود.

عناصر <html> ، <head> و <body> مورد نیاز هستند و باید دارای تگ‌های باز و بسته شوند.

یک صفحه معمولی همچنین باید یک عنصر <title> در داخل <head> داشته باشد. عنوان صفحه را ببینید.

تگ های خاص <meta> ویژگی های صفحه را کنترل می کنند. این موارد در این مرجع شرح داده شده است. یک صفحه معمولی دارای یک متا تگ "project_path" است که به یک فایل فراداده _project.yaml اشاره دارد و یک متا تگ "book_path" که به یک فایل فراداده _book.yaml اشاره دارد. پروژه ها و کتاب ها را ببینید. تگ های <meta> که توسط DevSite شناسایی می شوند معمولاً در صفحه آخر ظاهر نمی شوند.

سایر عناصر در <head> و تمام عناصر موجود در <body> در صفحه پایانی ارائه می شوند.

فایل های منبع Markdown 


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

# Page title

Body content, specified in Markdown, goes here.

یک صفحه معمولی باید یک عنوان داشته باشد (به عنوان مثال، # Page title ). عنوان صفحه را ببینید.

متا تگ های خاص ویژگی های صفحه را کنترل می کنند. این موارد در این مرجع شرح داده شده است. یک صفحه معمولی دارای یک تگ Project: متا است که به یک فایل فراداده _project.yaml اشاره دارد و یک متا تگ Book: که به یک فایل فراداده _book.yaml اشاره دارد. پروژه ها و کتاب ها را ببینید. متا تگ های شناسایی شده توسط DevSite معمولا در صفحه نهایی ظاهر نمی شوند.

پروژه ها و کتاب ها

یک پروژه توسط یک فایل فراداده پروژه به نام _project.yaml توصیف می شود. یک کتاب توسط یک فایل فراداده کتاب به نام _book.yaml توصیف می‌شود. این فایل ها به همراه فایل های صفحه و دارایی در سایت منتشر می شوند و به چندین زبان قابل ترجمه هستند. برای اطلاعات در مورد ساختار و ویژگی‌های این فایل‌ها، به ابرداده پروژه و فراداده کتاب مراجعه کنید.

برای مرتبط کردن یک صفحه با یک پروژه، ویژگی project_path را ارائه کنید. مقدار آن مسیر محتوا به فایل _project.yaml است.

HTML 

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

مارک داون 

Project: /path/to/_project.yaml

اگر صفحه ای دارای ویژگی project_path نباشد، بدون منطقه نوار پروژه و ویژگی های آن رندر می شود. این صفحه بخشی از پروژه در نظر گرفته نخواهد شد.

برای مرتبط کردن یک صفحه با یک کتاب، ویژگی book_path را ارائه کنید. مقدار آن مسیر محتوا به فایل _book.yaml است.

HTML 

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

مارک داون 

Book: /path/to/_book.yaml

عنوان صفحه 

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

یا از عنصر <h1> با کلاس page-title در <body> صفحه استفاده کنید.

HTML 

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

مارک داون 

# Page title

صفحات اصلی پروژه نیازی به عنوان ندارند،

HTML 

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

مارک داون 

no_page_title: true

در موارد خاصی که <h1> خودکار برای یک طرح بندی خاص مورد نظر نیست اما یک صفحه همچنان به عنوان پنجره نیاز دارد، می توانید عنوان را نگه دارید اما عنوان را با ویژگی "hide_page_heading" پنهان کنید:

HTML 

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

مارک داون 

hide_page_heading: true
# Page title

شرح سربرگ

بسیاری از سایت های DevSite دارای توضیحات در هدر هستند. این در فایل ابرداده _project.yaml تنظیم شده است و به طور خودکار در صفحات فرود DevSite نمایش داده می شود. به عبارت دیگر، صفحاتی که با استفاده از الگوی _index.yaml ایجاد می‌شوند، به طور خودکار توضیحاتی را در هدر ارائه می‌کنند که در فایل _project.yaml تنظیم شده است.

این توضیحات را می توان با تنظیم یک description در ریشه فایل _index.yaml برای صفحه لغو کرد، یا با تنظیم hide_description: true در شی header شی landing_page حذف شد.

طرح با عرض کامل

اگر به کنترل بیشتری روی طرح‌بندی نیاز است، می‌توانید به DevSite بگویید که از کنترل طرح‌بندی منطقه زیر سربرگ سایت و نوار پروژه و بالای فوتر سایت صرفنظر کند. برای انجام این کار، ویژگی فراداده "full_width" را روی "true" تنظیم کنید.

HTML 

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

مارک داون 

full_width: true

آخرین تاریخ به روز رسانی

به‌طور پیش‌فرض، به جز در صفحات full-width ، منطقه پاورقی صفحه شامل یک اعلامیه خودکار «آخرین به‌روزرسانی» است. در بیشتر موارد، این به کاربران یک سیگنال مستقیم در مورد تازگی محتوای صفحه می دهد.

در چند مورد، این اطلاعات ممکن است گیج کننده باشد یا ممکن است توسط تیم محصول محرمانه تلقی شود. برای غیرفعال کردن آخرین اخطار به‌روزرسانی شده در یک صفحه، ویژگی hide_last_updated را روی 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" />

مارک داون 

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

می‌توانید با تنظیم متا تگ refresh_date روی تاریخ در قالب 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" />

مارک داون 

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

توضیحات صفحه

توضیحات یک صفحه خلاصه متنی از محتوای صفحه است. برای تنظیم توضیحات برای یک صفحه، یک عنصر <meta name="description" content="DESCRIPTION" /> ارائه دهید. توجه داشته باشید که متن توضیحات در صفتی به نام content قرار می گیرد نه value . این با ویژگی استاندارد وب مطابقت دارد.

HTML 

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

مارک داون 

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

تنظیم توضیحات صفحه باعث می شود که تگ <meta> در صفحه نهایی قرار گیرد

مسیر تصویر

image_path مسیری به تصویر است که این صفحه را در رسانه های اجتماعی و ویژگی های DevSite مانند recommendations و dynamic content نشان می دهد. هنگامی که تنظیم شود، این تصویر به عنوان تصویر OpenGraph صفحه استفاده می‌شود، که تنظیمات social media پروژه و تنظیمات نام تجاری tenant site's لغو می‌کند.

HTML 

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

مارک داون 

image_path: /site-assets/developers_64dp.png

کلمات کلیدی

فیلد keywords فهرستی از رشته‌هایی است که با کاما محدود شده‌اند که صفحه را توصیف می‌کنند و در ویژگی‌های جستجو و کشف مانند جستجوی سایت و Dynamic Content استفاده می‌شوند.

فیلد keywords از کلمات کلیدی مسطح بدون ارتباط ابعادی (به عنوان مثال، gettingstarted ) و کلمات کلیدی ساختاری پشتیبانی می کند که از فضای نام ابعادی برای نشان دادن رابطه بین اسناد و موجودیت های دنیای واقعی مانند زبان های برنامه نویسی، محصولات و رویدادها استفاده می کنند (به عنوان مثال، product:ComputeEngine یا language:Python3 ). می توانید هر دو نوع keywords به هر فیلد کلیدواژه اضافه کنید.

اگر یک کلمه کلیدی را مرحله بندی کنید که با الزامات قالب بندی مطابقت ندارد، در خروجی ابزاری که استفاده کرده اید (معمولاً ابزار خط فرمان DevSite یا DevSite Content Publisher) اخطاری را با نسخه فرمت صحیح کلمه کلیدی خود خواهید دید.

HTML 

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

مارک داون 

keywords: spacetime, timetravel, product:Delorean