שימוש חוזר בתוכן בדפים שונים

במדריך הזה מוסבר איך לשתף תוכן בין מאמרים ב-DevSite.

כדי לעשות שימוש חוזר בתוכן בכמה דפים, אפשר להשתמש במשתנים וב-includes, שהם הגרסה של DevSite לשימוש בקטעי קוד בכמה מאמרים ב-Composer.

הערה: אי אפשר לפרסם תוכן משותף בכמה מרכזי עזרה בכתובת support.google.com. אפשר לקשר לדפים מכל דומיין בניווט, אבל אי אפשר להשתמש בדומיינים שאינם של DevSite כמקור יחיד למאמר או לקטע.

מתי כדאי להשתמש בהכללות ובמשתנים

• משתמשים במשתנה כשרוצים לעשות שימוש חוזר במחרוזת קצרה של טקסט ממקור יחיד. לדוגמה, שמות של מוצרים ושמות של תכונות.

• משתמשים ב-include כשרוצים לעשות שימוש חוזר בטקסט מעוצב או ב-HTML ממקור יחיד. לדוגמה, טבלת השוואה בין תכונות או הערה חשובה.

יצירת משתנה

1. פותחים את google3/third_party/devsite/workspace/en/_globalvars.html.
   1. בפינה השמאלית העליונה, לוחצים על עריכה ב-Cider.

2. מוסיפים הגדרה חדשה למשתנה.

   • כדאי לנסות להוסיף את המשתנה החדש לאחת מכותרות הקטגוריות הקיימות בקובץ. אם צריך, אנחנו יכולים להוסיף עוד.
   • שומרים על סדר אלפביתי בכל קטגוריה, לפי שם המשתנה.

   • מוודאים ששם המשתנה החדש לא נמצא כבר באחד מקובצי המשתנים הבאים:

     • google3/googledata/devsite/_common/en/_shared/_product_names.html

   • google3/googledata/devsite/_common/en/_shared/workspace/_product_names.html

   • google3/googledata/devsite/_common/en/_shared/cloud/_product_names.html

   {% setvar YOUR_VARIABLE_NAME %}TEXT_TO_DISPLAY{% endsetvar %}

   • מחליפים את YOUR_VARIABLE_NAME במשתנה שבו רוצים להשתמש.
   • מחליפים את TEXT_TO_DISPLAY בטקסט שיוצג למשתמש.

3. שומרים את השינויים ושולחים בקשת שינוי לכתובת workspace-content-configs לבדיקה ולאישור.

4. אחרי ששולחים את רשימת השינויים, אפשר לפרסם תוכן באמצעות שם המשתנה החדש.

הוספת משתנה לתוכן

כדי להוסיף משתנה לדף, משתמשים במשתנה 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>

יצירת קובץ 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 או ברכיב HTML בתוך קובץ Markdown.
   • יוצרים תוכן מגוון. המטרה של הכללה היא שהיא תתאים לכמה דפים, ולכן התוכן צריך להיות ניתן לשימוש חוזר ככל האפשר. * תוכן מומלץ לכלול: שלבים והערות או טיפים קשורים שכוללים פרטים על הטמעה, כמו מגבלות, אזהרות או הסברים על אופן הפעולה. * לא: כותרות או סקירות (אנחנו רוצים לעצב ולכתוב אותן בעצמנו, לתרחישי שימוש עסקיים).

דוגמה: קובץ הכללה לדוגמה עם שלבים להעתקת מספר ה פרויקט בענן של Google Cloud:

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

מידע נוסף זמין במאמר בנושא הכללת קבצים במסמכי התיעוד של DevSite Publishing.

הוספת תוכן שרוצים לכלול

כדי להוסיף include לדף, משתמשים בתג include. התג include מוסיף את התוכן של הקובץ שצוין במיקום של התג בדף.

דוגמה לתג include לקובץ לדוגמה מהקטע הקודם:

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

קבצים של קטעי קוד שהועברו

קטעי קוד מ-Composer הועברו לתיקייה third_party/devsite/workspace/en/_shared/snippets. אם השתמשתם בקטעי קוד ב-Composer לפני שהתוכן הועבר אל DevSite, תראו בתכנים שלכם תגי include שדומים לדוגמה הבאה:

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

אל תוסיפו קבצים חדשים של include לתיקייה _shared/snippets.

פרסום צולב

ב-DevSite, כל דף שייך לקבוצת תוכן אחת. ב-Devsite אין תמיכה בפרסום צולב כמו ב-Composer, שבו אפשר לפרסם דף אחד בכמה מרכזי עזרה. במקום זאת, אפשר לקשר לדפים בערכות תוכן אחרות מתוך תוכן העניינים.

הוספת דף מסט תוכן אחר לתפריט הניווט

כדי לקשר לדף מתוך קבוצת תוכן אחרת בניווט, מבצעים את השלבים הבאים:

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
      

כשמשתמש לוחץ על הקישור 'פריסת אימות דו-שלבי' בסרגל הניווט של Cloud Search, הוא מועבר לדף במסמכי התיעוד בנושא המשכיות עסקית.

מידע נוסף על עדכון הניווט באתר