在不同頁面重複使用內容

本指南說明如何在 DevSite 的文章之間共用內容。

如要在多個網頁中重複使用內容，可以使用變數和包含項目，這相當於在 Composer 的多篇文章中使用程式碼片段的 DevSite 版本。

注意：無法與 support.google.com 上的說明中心交叉發布共用內容。您可以在導覽中連結任何網域的網頁，但無法使用非 DevSite 網域的單一來源文章或章節。

使用 include 和變數的時機

  • 如要重複使用簡短的單一來源字串，請使用變數。例如產品名稱和功能名稱。

  • 如要重複使用單一來源的格式化文字或 HTML，請使用 include。例如功能比較表或重要附註。

請建立變數

  1. 開啟 google3/third_party/devsite/workspace/en/_globalvars.html。
    1. 按一下右上方的「在 Cider 中編輯」。

  2. 新增變數定義。

    {% setvar YOUR_VARIABLE_NAME %}TEXT_TO_DISPLAY{% endsetvar %}
    • 將 YOUR_VARIABLE_NAME 替換為要使用的變數。
    • 將 TEXT_TO_DISPLAY 替換為應向使用者顯示的文字。

  3. 儲存變更，並將 CL 送交 workspace-content-configs 審查及核准。

  4. 提交 CL 後，您就可以使用新的變數名稱發布內容！

在內容中新增變數

如要在網頁中新增變數，請使用 Jinja 變數。 這個簡單的 {{ ... }} 建構會將指定變數的內容插入網頁上代碼的位置。

範例


**Note:** You can buy {{ workspace_name }} from a reseller.

<table>
  <tr>
    <th>Edition</th>
    <th>Cost</th>
  </tr>
  <tr>
    <td>{{ business_plus_sku_name }}</td>
    <td>$50 / month</td>
  </tr>
  <tr>
    <td>{{ business_standard_sku_name }}</td>
    <td>$20 / month</td>
  </tr>
  <tr>
    <td>{{ business_starter_sku_name }}</td>
    <td>No additional cost</td>
  </tr>
</table>

最終顯示的內容

注意：你可以透過經銷商購買 Google Workspace。

版本 費用
Business Plus 每月 $50 美元
Business Standard 每月 $20 美元
Business Starter 無須支付額外費用

建立 include 檔案

重要事項：內含檔案一律須為 HTML 格式。這是因為 HTML 格式可在 HTML 和 Markdown 程式碼區塊環境中運作，但 Markdown 僅適用於 Markdown 程式碼區塊環境。

觀看教學影片

如要建立 include 檔案，請按照下列步驟操作：

  1. 開啟 Cider。

  2. 使用程式碼搜尋或檔案總管，找出 third_party/devsite/workspace/en/_shared/includes/ 資料夾。

  3. 在「includes」資料夾上按一下滑鼠右鍵，然後點選「New File」(螢幕截圖)。

    • 如果 include 只與內容集相關，可以在 /includes 資料夾中為內容集建立子資料夾，並在其中新增 include 檔案。例如：…/workspace/en/shared/includes/cloud-search/_my-niche-snippet.html

  4. 為檔案命名並新增內容。請按照下列指南進行：

    • 檔案名稱開頭須為底線。例如：_my-new-include.html。這樣一來，外部就不會將內含檔案視為獨立頁面。
    • 檔案名稱應具描述性。這樣一來，所有人都能輕鬆找到及使用 include。
    • 所有內含項目都必須是 HTML 檔案。副檔名必須為 .html，且檔案不得包含以 Markdown 撰寫的任何元素。這樣一來，無論內容是包含在 Markdown 檔案、HTML 檔案，還是 Markdown 檔案中的 HTML 元素，都能正確算繪。
    • 製作多樣化的內容。納入項目的目標是讓項目適合多個頁面，因此內容應盡可能重複使用。* 理想的內容：步驟和相關附註或提示，包含限制、注意事項或運作方式等實作詳細資料。 * 避免：標題或總覽 (我們希望自行撰寫這些內容並設定格式，以供業務用途)。

範例：以下是包含檔案的範例，說明如何複製 Google Cloud 專案的專案編號：

third_party/devsite/workspace/en/_shared/includes/_copy-cloud-project-number-steps.html

詳情請參閱「納入檔案」的 DevSite 發布說明文件。

在內容中新增 include

如要在網頁中加入 include，請使用 include 標記。include 標記會在網頁上標記所在的位置，插入指定檔案的內容。

以下是上節範例檔案的 include 標記範例：

範例


{% include "_shared/includes/_copy-cloud-project-number-steps.html" %}

最終顯示的內容

  1. 在 Google Cloud 控制台中，依序前往「選單」圖示 接下來「IAM 與管理」 接下來「設定」。

    前往「IAM & Admin Settings」(IAM 與管理員設定)

  2. 在「專案編號」欄位中，複製該值。

已遷移的程式碼片段檔案

Composer 中的「程式碼片段」已遷移至「third_party/devsite/workspace/en/_shared/snippets」資料夾。如果內容在遷移至 DevSite 前使用過 Composer 中的程式碼片段，您會在內容中看到類似下列範例的 include 標記：

{% include "_shared/snippets/_snippet-9393389.html" %}

請勿在 _shared/snippets 資料夾中新增 include 檔案。

跨發布

在 DevSite 中，每個頁面都屬於一個內容集。Devsite 不支援 Composer 中使用的跨發布功能，也就是將一個頁面發布到多個說明中心。不過，您可以從目錄連結至其他內容集中的網頁。

在導覽面板中新增其他內容集的頁面

如要從導覽中的其他內容集連結至某個頁面，請按照下列步驟操作：

  1. 開啟內容集的 _book.yaml 檔案。您可以在 _book.yaml 檔案中管理網站的導覽功能。
  2. 在要連結的頁面中新增頁面標題和根路徑。

在下列範例中，Cloud Search 的 _book.yaml 檔案會連結至「業務持續性」內容集中的文章。

    - name: "Guides"
      contents:
      - heading: "Getting started"
      - title: "What is Google Cloud Search?"
        path: /cloud-search/what-is-google-cloud-search 
      - title: "Deploy 2-Step Verification"
        path: /business-continuity/security-and-monitoring/deploy-2-step-verification

使用者點選 Cloud Search 導覽中的「部署兩步驟驗證」連結時，系統會將他們帶往「業務持續性」文件中的頁面。

如要進一步瞭解如何更新網站的導覽列，請參閱「更新導覽列」。