Sử dụng lại nội dung trên các trang

Tài liệu hướng dẫn này có thông tin về cách chia sẻ nội dung giữa các bài viết trên DevSite.

Để sử dụng lại nội dung trên nhiều trang, bạn có thể sử dụng các biến và nội dung được đưa vào. Đây là phiên bản DevSite của việc sử dụng đoạn mã trong nhiều bài viết trong Composer.

Lưu ý: Bạn không thể xuất bản chéo nội dung được chia sẻ với Trung tâm trợ giúp trên support.google.com. Bạn có thể liên kết đến các trang từ bất kỳ miền nào trong phần điều hướng, nhưng bạn không thể lấy nguồn duy nhất cho một bài viết hoặc phần bằng các miền không phải DevSite.

Trường hợp sử dụng các chỉ thị include và biến

  • Sử dụng biến khi bạn muốn sử dụng lại một chuỗi văn bản ngắn, có một nguồn. Ví dụ: tên sản phẩm và tên tính năng.

  • Sử dụng include khi bạn muốn sử dụng lại văn bản hoặc HTML được định dạng từ một nguồn duy nhất. Ví dụ: bảng so sánh tính năng hoặc ghi chú quan trọng.

Tạo biến

  1. Mở google3/third_party/devsite/workspace/en/_globalvars.html.
    1. Ở trên cùng bên phải, hãy nhấp vào Chỉnh sửa trong Cider.
  2. Thêm một định nghĩa biến mới.

    {% setvar YOUR_VARIABLE_NAME %}TEXT_TO_DISPLAY{% endsetvar %}
    • Thay thế YOUR_VARIABLE_NAME bằng biến mà bạn muốn sử dụng.
    • Thay thế TEXT_TO_DISPLAY bằng văn bản sẽ hiển thị cho người dùng.
  3. Lưu các thay đổi và gửi một CL đến workspace-content-configs để xem xét và phê duyệt.

  4. Sau khi gửi CL, bạn có thể xuất bản nội dung bằng tên biến mới!

Thêm biến vào nội dung của bạn

Để thêm một biến vào trang, hãy sử dụng biến Jinja. Cấu trúc {{ ... }} đơn giản này sẽ chèn nội dung của biến được chỉ định vào vị trí của thẻ trên trang.

Ví dụ:


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

Được kết xuất

Lưu ý: Bạn có thể mua Google Workspace qua một đại lý.

Phiên bản Chi phí
Business Plus 50 đô la / tháng
Business Standard 20 đô la / tháng
Business Starter Không mất thêm phí

Tạo tệp include

Lưu ý quan trọng: Tệp include phải luôn ở định dạng HTML. Lý do là vì định dạng HTML có thể hoạt động trong cả ngữ cảnh khối mã HTML và Markdown, nhưng nội dung Markdown chỉ hoạt động trong ngữ cảnh khối mã Markdown.

Xem video hướng dẫn

Để tạo một tệp include, hãy làm theo các bước sau:

  1. Mở Cider.

  2. Sử dụng Code Search (Tìm kiếm mã) hoặc Files Explorer (Trình khám phá tệp) để tìm thư mục third_party/devsite/workspace/en/_shared/includes/.

  3. Nhấp chuột phải vào thư mục includes rồi nhấp vào New File (Tệp mới) (ảnh chụp màn hình).

    • Nếu chỉ muốn đưa nội dung vào tập hợp nội dung, bạn có thể tạo một thư mục con cho tập hợp nội dung trong thư mục /includes rồi thêm tệp nội dung vào đó. Ví dụ: …/workspace/en/shared/includes/cloud-search/_my-niche-snippet.html
  4. Đặt tên cho tệp và thêm nội dung của bạn. Thực hiện theo các hướng dẫn sau:

    • Bắt đầu tên tệp bằng dấu gạch dưới. Ví dụ: _my-new-include.html. Điều này ngăn tệp include trở thành trang riêng bên ngoài.
    • Đặt tên mô tả cho tệp. Điều này giúp mọi người dễ dàng tìm thấy và sử dụng tệp include.
    • Tất cả các tệp bao gồm phải là tệp HTML. Phần mở rộng của tệp phải là .html và tệp không được chứa bất kỳ phần tử nào được viết bằng Markdown. Điều này đảm bảo rằng nội dung sẽ hiển thị chính xác cho dù nội dung đó có trong tệp Markdown, tệp HTML hay phần tử HTML trong tệp Markdown.
    • Tạo nội dung đa dạng. Mục tiêu của một nội dung được đưa vào là để nội dung đó phù hợp với nhiều trang, vì vậy, nội dung đó phải có khả năng tái sử dụng cao nhất có thể. * Nội dung lý tưởng cần đưa vào: Các bước và ghi chú hoặc mẹo liên quan có chứa mọi thông tin chi tiết về việc triển khai, chẳng hạn như giới hạn, cảnh báo hoặc cách thức hoạt động. * Tránh: Tiêu đề hoặc thông tin tổng quan (chúng tôi muốn tự định dạng và viết những nội dung này cho các trường hợp sử dụng doanh nghiệp).

Ví dụ: Sau đây là một ví dụ về tệp include cho các bước về cách sao chép số dự án của một dự án trên đám mây của Google Cloud:

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

Để biết thêm thông tin, hãy xem tài liệu về việc Xuất bản trên DevSite đối với Bao gồm tệp.

Thêm một phần nội dung được đưa vào

Để thêm một nội dung được đưa vào trang, hãy sử dụng thẻ include. Thẻ include sẽ chèn nội dung của tệp được chỉ định vào vị trí của thẻ trên trang của bạn.

Dưới đây là ví dụ về thẻ include cho tệp ví dụ trong phần trước:

Ví dụ:


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

Được kết xuất

  1. Trong bảng điều khiển Cloud, hãy chuyển đến phần Trình đơn sau đó IAM và Quản trị sau đó Cài đặt.

    Chuyển đến phần IAM và Cài đặt quản trị

  2. Sao chép giá trị trong trường Số dự án.

Tệp đoạn mã đã di chuyển

Đoạn mã trong Composer đã được di chuyển vào thư mục third_party/devsite/workspace/en/_shared/snippets. Nếu nội dung của bạn sử dụng đoạn mã trong Composer trước khi được di chuyển sang DevSite, thì bạn sẽ thấy các thẻ include trong nội dung của mình tương tự như ví dụ sau:

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

Đừng thêm tệp include mới vào thư mục _shared/snippets.

Xuất bản trên nhiều nền tảng

Trong DevSite, mỗi trang thuộc về một bộ nội dung. Devsite không hỗ trợ tính năng xuất bản chéo được dùng trong Composer, trong đó một trang có thể được xuất bản trong nhiều trung tâm trợ giúp. Thay vào đó, bạn có thể liên kết đến các trang trong các bộ nội dung khác từ bên trong mục lục (TOC).

Thêm một trang từ một nhóm nội dung khác vào bảng điều hướng

Để liên kết đến một trang trong một bộ nội dung khác trong thanh điều hướng, hãy làm theo các bước sau:

  1. Mở tệp _book.yaml cho bộ nội dung của bạn. Tệp _book.yaml là nơi bạn quản lý thanh điều hướng của trang web.
  2. Thêm tiêu đề trang và đường dẫn gốc vào trang mà bạn muốn liên kết đến.

Trong ví dụ sau, tệp _book.yaml cho Cloud Search liên kết đến một bài viết trong bộ nội dung Business Continuity.

    - 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
      

Khi người dùng nhấp vào đường liên kết xác minh Triển khai quy trình xác minh 2 bước trong phần điều hướng của Cloud Search, họ sẽ được đưa đến trang trong tài liệu về Business Continuity.

Để tìm hiểu thêm về cách cập nhật bảng điều hướng của trang web, hãy xem bài viết Cập nhật bảng điều hướng.