在不同网页之间重复使用内容

本指南介绍了如何在 DevSite 的文章之间共享内容。

如需在多个页面中重复使用内容，您可以使用变量和包含项，这相当于在 Composer 中在多篇文章中使用代码段的 DevSite 版本。

注意：无法与 support.google.com 上的帮助中心交叉发布共享内容。您可以在导航中链接到任何网域中的网页，但不能使用非 DevSite 网域作为文章或部分的唯一来源。

何时使用包含和变量

  • 如果您想重复使用简短的单源文本字符串，请使用变量。例如，产品名称和功能名称。

  • 如果您想重复使用单源格式化文本或 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。

版本 费用
商务 Plus 版 50 美元 / 月
商务标准版 20 美元 / 月
商务新手版 无额外费用

创建 include 文件

重要提示：包含的文件必须始终采用 HTML 格式。这是因为 HTML 格式可以在 HTML 和 Markdown 代码块上下文中正常运行，但 Markdown 包含项仅在 Markdown 代码块上下文中正常运行。

观看视频教程

如需创建包含文件，请按照以下步骤操作：

  1. 打开 Cider。

  2. 使用代码搜索或文件资源管理器找到 third_party/devsite/workspace/en/_shared/includes/ 文件夹。

  3. 右键点击 includes 文件夹，然后点击 New File（屏幕截图）。

    • 如果您的包含项仅与您的内容集相关，您可以在 /includes 文件夹中为您的内容集创建一个子文件夹，并将包含项文件添加到该子文件夹中。例如 …/workspace/en/shared/includes/cloud-search/_my-niche-snippet.html。

  4. 为文件命名并添加内容。请遵循以下准则：

    • 以英文下划线开头。例如 _my-new-include.html。这样可防止包含文件在外部成为自己的页面。
    • 使用描述性文件名。这样，所有人都可以更轻松地找到并使用相应 include。
    • 所有包含项都必须是 HTML 文件。文件扩展名必须为 .html，并且文件不应包含任何以 Markdown 格式编写的元素。这样可确保无论内容是包含在 Markdown 文件、HTML 文件中，还是包含在 Markdown 文件中的 HTML 元素中，都能正确呈现。
    • 让内容用途广泛。包含的目标是使其适合多个页面，因此内容应尽可能可重用。 理想的包含内容：包含任何实现细节（例如限制、注意事项或工作方式）的步骤和相关注释或提示。* 避免：标题或概览（我们希望自行设置这些内容的格式并撰写，以用于业务使用情形）。

示例：以下是一个包含相关步骤的 include 文件，用于说明如何复制 Google Cloud 项目的项目编号：

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

如需了解详情，请参阅 DevSite 发布文档中的包含文件。

向内容中添加 include

如需向网页添加包含项，请使用 include 标记。include 标记会将指定文件的内容插入到网页上相应标记所在的位置。

以下是上一部分中示例文件的 include 标记示例：

示例


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

已渲染

  1. 在 Google Cloud 控制台中，依次前往“菜单”图标 然后 IAM 和管理 然后 设置。

    前往“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 中使用的交叉发布，即一个页面可以发布到多个帮助中心。不过，您可以在目录 (TOC) 中添加指向其他内容集内网页的链接。

将其他内容集中的页面添加到导航栏

如需在导航中链接到其他内容集中的页面，请按以下步骤操作：

  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 导航中的“部署两步验证”链接时，系统会将用户引导至业务连续性文档中的相应页面。

如需详细了解如何更新网站的导航，请参阅更新导航。