นำเนื้อหาไปใช้ซ้ำในหน้าต่างๆ

คู่มือนี้มีข้อมูลเกี่ยวกับวิธีแชร์เนื้อหาระหว่างบทความใน DevSite

หากต้องการนำเนื้อหาไปใช้ซ้ำในหลายหน้า คุณสามารถใช้ตัวแปรและการรวม ซึ่งเป็น DevSite เวอร์ชันที่ใช้ข้อมูลโค้ดในบทความหลายบทความใน Composer

หมายเหตุ: คุณจะเผยแพร่เนื้อหาที่แชร์ร่วมกับศูนย์ช่วยเหลือใน support.google.com แบบข้ามแพลตฟอร์มไม่ได้ คุณลิงก์ไปยังหน้าเว็บจากโดเมนใดก็ได้ใน การนำทาง แต่จะใช้แหล่งที่มาเดียวสำหรับบทความหรือส่วนที่มี โดเมนที่ไม่ใช่ DevSite ไม่ได้

กรณีที่ควรใช้การรวมและตัวแปร

  • ใช้ตัวแปรเมื่อต้องการนำสตริงข้อความสั้นๆ ที่มาจากแหล่งข้อมูลเดียวมาใช้ซ้ำ เช่น ชื่อผลิตภัณฑ์และชื่อฟีเจอร์

  • ใช้ include เมื่อต้องการนำข้อความที่จัดรูปแบบหรือ HTML ที่มาจากแหล่งข้อมูลเดียวกลับมาใช้ซ้ำ เช่น ตารางเปรียบเทียบฟีเจอร์หรือหมายเหตุสำคัญ

สร้างตัวแปร

  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 ไม่มีค่าใช้จ่ายเพิ่มเติม

สร้างไฟล์รวม

สำคัญ: ไฟล์ที่รวมต้องอยู่ในรูปแบบ 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 ซึ่งจะป้องกันไม่ให้ไฟล์ที่รวมกลายเป็นหน้าเว็บของตัวเองภายนอก
    • ตั้งชื่อไฟล์ให้สื่อความหมาย ซึ่งจะช่วยให้ทุกคนค้นหาและใช้การรวมได้ง่ายขึ้น
    • ไฟล์ที่รวมทั้งหมดต้องเป็นไฟล์ HTML โดยนามสกุลไฟล์ต้องเป็น .html และไฟล์ไม่ควรมีองค์ประกอบที่เขียนด้วยมาร์กดาวน์ วิธีนี้จะช่วยให้มั่นใจได้ว่าเนื้อหาจะแสดงอย่างถูกต้องไม่ว่าจะรวมอยู่ในไฟล์ Markdown, ไฟล์ HTML หรือองค์ประกอบ HTML ภายในไฟล์ Markdown
    • สร้างเนื้อหาที่หลากหลาย เป้าหมายของการรวมคือการให้เนื้อหาพอดีกับหลายหน้า ดังนั้นเนื้อหาควรนำกลับมาใช้ซ้ำได้มากที่สุด * เนื้อหาที่ควรมี: ขั้นตอนและหมายเหตุหรือเคล็ดลับที่เกี่ยวข้อง ซึ่งมีรายละเอียดการติดตั้งใช้งาน เช่น ขีดจำกัด ข้อควรระวัง หรือวิธีการทำงาน * หลีกเลี่ยง: หัวข้อหรือภาพรวม (เราต้องการจัดรูปแบบและเขียน สิ่งเหล่านี้ด้วยตนเองสำหรับกรณีการใช้งานทางธุรกิจ)

ตัวอย่าง: ตัวอย่างต่อไปนี้คือไฟล์ที่รวมขั้นตอนการคัดลอกหมายเลขโปรเจ็กต์ของโปรเจ็กต์ Google Cloud

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

ดูข้อมูลเพิ่มเติมได้ที่เอกสารประกอบการเผยแพร่ใน DevSite สำหรับInclude files

เพิ่มการรวมในเนื้อหา

หากต้องการเพิ่มการรวมลงในหน้าเว็บ ให้ใช้include แท็ก แท็ก include จะแทรกเนื้อหาของไฟล์ที่ระบุไว้ในตำแหน่งของแท็ก ในหน้าเว็บ

ตัวอย่างแท็กรวมสำหรับไฟล์ตัวอย่างจากส่วนก่อนหน้ามีดังนี้

ตัวอย่าง


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

แสดงผล

  1. ใน Google Cloud Console ให้ไปที่เมนู จากนั้น IAM และผู้ดูแลระบบ จากนั้น การตั้งค่า

    ไปที่การตั้งค่า IAM และผู้ดูแลระบบ

  2. คัดลอกค่าในช่องหมายเลขโปรเจ็กต์

ไฟล์ข้อมูลโค้ดที่ย้ายข้อมูล

ระบบได้ย้ายข้อมูลข้อมูลโค้ดจาก Composer ไปยังโฟลเดอร์ third_party/devsite/workspace/en/_shared/snippets แล้ว หากเนื้อหาของคุณใช้ข้อมูลโค้ดใน Composer ก่อนที่จะย้ายข้อมูลไปยัง DevSite คุณจะเห็นแท็กรวมในเนื้อหาที่คล้ายกับตัวอย่างต่อไปนี้

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

อย่าเพิ่มไฟล์รวมใหม่ลงในโฟลเดอร์ _shared/snippets

การเผยแพร่ข้ามแพลตฟอร์ม

ใน DevSite แต่ละหน้าจะเป็นของชุดเนื้อหา 1 ชุด Devsite ไม่รองรับการเผยแพร่ข้ามที่ใช้ใน Composer ซึ่งหน้าเว็บหนึ่งอาจเผยแพร่ในศูนย์ช่วยเหลือหลายแห่งได้ แต่คุณสามารถลิงก์ไปยังหน้าต่างๆ ในชุดเนื้อหาอื่นๆ จากภายใน สารบัญ (TOC) ได้

เพิ่มหน้าจากชุดเนื้อหาอื่นลงในการนำทาง

หากต้องการลิงก์ไปยังหน้าจากชุดเนื้อหาอื่นในการนำทาง ให้ทำตาม ขั้นตอนต่อไปนี้

  1. เปิดไฟล์ _book.yaml สำหรับชุดเนื้อหา _book.yamlเป็นไฟล์ที่คุณใช้จัดการการนำทางของเว็บไซต์
  2. เพิ่มชื่อหน้าและเส้นทางรูทไปยังหน้าที่คุณต้องการลิงก์

ในตัวอย่างต่อไปนี้ _book.yaml ไฟล์สำหรับ Cloud Search จะลิงก์ไปยังบทความจากชุดเนื้อหาความต่อเนื่องทางธุรกิจ

    - 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
      

เมื่อผู้ใช้คลิกลิงก์ "ติดตั้งใช้งานการยืนยันแบบ 2 ขั้นตอน" ในการนำทางของ Cloud Search ระบบจะนำผู้ใช้ไปยังหน้าในเอกสารประกอบเรื่องความต่อเนื่องทางธุรกิจ

ดูข้อมูลเพิ่มเติมเกี่ยวกับการอัปเดตการนำทางของเว็บไซต์ได้ที่อัปเดต การนำทาง