הוספה ועריכה של תוכן

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X. מידע

כדאי להשתמש בסוג התוכן "Basic Page" (דף בסיסי) ב-Drupal כדי להוסיף לפורטל השירותים למפתחים תיעוד על ה-API, כמו מדריכי הפעלה ומסמכי API, ולכלול תוכן כמו סרטונים, הקלטות מסך או הורדות קוד.

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

הוספת דף הבית של המסמכים

כברירת מחדל, דף הבית של התיעוד נמצא בכתובת <siteURL>/document בפורטל המפתחים. דף הבית שמוגדר כברירת מחדל בפורטל למפתחים מכיל קישור לדף הזה בתיבה שבראש דף הבית:

אפשר להוסיף לדף הזה גם קישור לתיעוד דרך התפריט הראשי בתפריט של הפורטל למפתחים.

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

כדי להוסיף את דף הבית של מסמכי התיעוד לפורטל המפתחים:

1. אתם יכולים להתחבר לפורטל שלכם כמשתמשים עם הרשאות אדמין או יצירת תוכן.
2. בתפריט הניהול של Drupal, בוחרים באפשרות תוכן > הוספת תוכן > דף בסיסי.
3. מזינים את כותרת המסמך, כמו דף הבית של התיעוד, ואת תוכן הדף הראשון.
4. לוחצים על עריכת סיכום כדי להוסיף סיכום.
5. לוחצים על הפריט הגדרות התפריט מתחת לקטע גוף ההודעה.
6. בוחרים באפשרות הוספת קישור לתפריט, מוסיפים את שם הקישור ובוחרים באפשרות <תפריט ראשי> בפריט ההורה.
   הפעולה הזו גורמת להוספה של קישור לתפריט הראשי בדף הבית של מסמכי התיעוד.
7. לוחצים על הפריט הגדרות נתיב כתובת URL מתחת לקטע 'גוף'.
8. מבטלים את הבחירה באפשרות יצירת כינוי אוטומטי של כתובת URL ומגדירים את כתובת ה-URL החלופית בתור מסמכי תיעוד.
   כברירת מחדל, כתובת ה-URL של דף היא <siteURL>/content/pageName. על ידי הגדרת הכינוי של כתובת האתר, אתה מגדיר כתובת אתר מפורשת של הדף. במקרה הזה, כתובת האתר תהיה <siteURL>/document.
9. שומרים את הדף.
   עכשיו אמור להופיע קישור לדף בסרגל התפריטים, והקישור בתיבה שבדף הבית אמור לפעול.
   אדמינים יופיעו גם לחצנים לניהול תוכן כמו 'הצגה' ו'עריכה'. משתמשים שאינם אדמינים לא יראו אותם.

הוספת דף צאצא למסמכיך

כשמוסיפים דפי צאצא לתיעוד:

1. אתם יכולים להתחבר לפורטל שלכם כמשתמשים עם הרשאות אדמין או יצירת תוכן.
2. בתפריט הניהול של Drupal, בוחרים באפשרות תוכן > הוספת תוכן > דף בסיסי.
3. מזינים את כותרת הדף ואת התוכן.
4. לוחצים על עריכת סיכום כדי להוסיף סיכום.
5. לוחצים על הפריט הגדרות התפריט מתחת לקטע גוף ההודעה.
6. לוחצים על הוספת קישור לתפריט ומוסיפים את האפשרות לתפריט של דף הבית של התיעוד.
   
   
   
   הפעולה הזו מוסיפה דף נוכחי כצאצא של התפריט הראשי של דף הבית של מסמכי התיעוד.
7. עכשיו אמור להופיע קישור לדף בתפריט דף הבית של התיעוד.
   
   

עריכת דף מסמכים

כדי לערוך דף:

1. אתם יכולים להתחבר לפורטל שלכם כמשתמשים עם הרשאות אדמין או יצירת תוכן.
2. עוברים אל הדף בפורטל המפתחים.
   אפשר גם ללחוץ על תוכן בתפריט הניהול של Drupal כדי להציג רשימה של כל הדפים ולבחור דף.
3. לוחצים על הכרטיסייה עריכה בדף.
   
   
   
4. כדי לפתוח עורך חזותי, בוחרים באפשרות 'HTML מלא' או 'HTML מסונן' בתפריט הנפתח 'פורמט טקסט' מתחת לקטע 'גוף'.
   תוכן הדף אמור להופיע בכלי העריכה.
5. עורכים את הדף לפי הצורך.

   

6. לוחצים על 'שמירה'.

הצגת דף מסמכים

כדי להציג את התוכן של מסמך:

1. אתם יכולים להתחבר לפורטל שלכם כמשתמשים עם הרשאות אדמין או יצירת תוכן.
2. בוחרים באפשרות תוכן בתפריט הניהול של Drupal.
3. בוחרים את המסמך שרוצים לצפות בו.

סידור מחדש של סדר הדפים

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

כדי לשנות את הסדר של הדפים בתפריט דף הבית של התיעוד:

1. אתם יכולים להתחבר לפורטל שלכם כמשתמשים עם הרשאות אדמין או יצירת תוכן.
2. בתפריט הניהול של Drupal, בוחרים באפשרות מבנה > תפריטים > תפריט ראשי.
3. לכל פריט בתפריט מופיע סמל מימין לשמו. אם הסמלים לא מופיעים, לוחצים על הסתרת משקלי שורה.
4. כדי להעביר פריט, לוחצים על הסמל וגוררים אותו למיקום חדש.
   גרירה של פריט עם פריטי צאצא גם מעבירה את הצאצאים.
   
   
   
5. לוחצים על שמירת ההגדרה.

עריכת דפים של כותרות תחתונות

הכותרת התחתונה של הפורטל כוללת שלושה סמלים של רשתות חברתיות עבור Twitter , Facebook ו-LinkedIn וקישורים לכתובות ה-URL הבאות:

• מדיניות הפרטיות שמופיעה בכתובת ה-URL <siteURL>/privacy-policy
• תנאים ושימוש בכתובת ה-URL <siteURL>/terms-use
• דפים ליצירת קשר בכתובת ה-URL <siteURL>/contact-us

כדי להוסיף תוכן משלך, צריך לערוך את הדפים האלה.

אם הדפים האלה לא קיימים, יוצרים אותם:

1. אתם יכולים להתחבר לפורטל שלכם כמשתמשים עם הרשאות אדמין או יצירת תוכן.
2. בתפריט הניהול של Drupal, בוחרים באפשרות תוכן > הוספת תוכן > דף בסיסי.
3. מזינים את שם המסמך, למשל מדיניות הפרטיות, ותוכן הדף.
4. לוחצים על עריכת סיכום כדי להוסיף סיכום.
5. לוחצים על הפריט הגדרות נתיב כתובת URL מתחת לקטע 'גוף'.
6. בוחרים באפשרות יצירת כתובת URL חלופית אוטומטית ומגדירים את כתובת ה-URL החלופית כמדיניות פרטיות.
   כברירת מחדל, כתובת ה-URL של דף היא <siteURL>/content/pageName. על ידי הגדרת כתובת ה-URL החלופית, תוגדר כתובת ה-URL המפורשת של הדף. במקרה הזה, כתובת ה-URL היא <siteURL>/privacy-policy.
7. שומרים את הדף.
8. חוזרים על התהליך הזה עבור הדפים 'תנאים ושימוש' ו'יצירת קשר'.

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

1. אתם יכולים להתחבר לפורטל שלכם כמשתמשים עם הרשאות אדמין או יצירת תוכן.
2. מנווטים לדף על ידי לחיצה על הקישור שלו בכותרת התחתונה. לדוגמה, לוחצים על הקישור Privacy Policy.
3. לוחצים על הכרטיסייה עריכה בדף כדי לפתוח את העורך.
4. משנים את התוכן בדף מדיניות הפרטיות לפי הצורך.
5. לוחצים על שמירה.
6. חוזרים על התהליך הזה עבור הדפים 'תנאים ושימוש' ו'יצירת קשר'.

כדי לערוך את הסמלים של הרשתות החברתיות, כמו הסמלים של Twitter, Facebook ו-LinkedIn, בפורטל המפתחים שלך:

1. אתם יכולים להתחבר לפורטל שלכם כמשתמשים עם הרשאות אדמין או יצירת תוכן.
2. בתפריט הניהול של Drupal, בוחרים באפשרות מבנה > בלוקים.
3. גוללים למטה בדף 'חסימות' עד שמופיע הבלוק כותרת תחתונה של ברירת המחדל בכל האתר.
4. בוחרים את הקישור configure (הגדרה) שתואם לבלוק של Custom Footer (כותרת תחתונה כברירת מחדל בכל האתר).
5. באזור Custom Content, לחץ לחיצה ימנית על סמל של רשת חברתית ובחר Edit Link מהתפריט הקופץ. לחלופין, מוחקים את הסמל מהאזור 'תוכן מותאם אישית' כדי להסיר אותו.
   
6. בוחרים באפשרות שמירת החסימה כדי לשמור את השינויים.

הוספת JavaScript לדף פורטל

ניתן להוסיף JavaScript לכל דף פורטל. הדרך הקלה ביותר להוסיף JavaScript היא לערוך את הדף, ולאחר מכן:

1. בוחרים באפשרות HTML מלא בתור פורמט טקסט.
   
2. לוחצים על הלחצן מקור כדי לערוך את קוד מקור ה-HTML של הדף.
3. מוסיפים את JavaScript לדף. לדוגמה, כדי לפתוח תיבת התראה כשהדף נטען, מוסיפים את הקוד הבא:
   
   <script language="JavaScript">
alert('Welcome to my page!');
</script>

הנה כמה שיקולים לגבי שימוש ב-JavaScript:

• אם מתכוונים להפנות לקובץ JavaScript, אין לעשות זאת בקוד המקור של הצומת, מפני שהפעולה הזו יוצרת קישור סטטי. במקום זאת, השתמשו בקוד PHP כדי ליצור קישור דינמי. כך אם המיקום של קובץ ה-JavaScript ישתנה, לא יהיה צורך לעדכן את כל דפי הפורטל שמפנים אליו.
• אם אתם רוצים לכלול קובץ JavaScript, הוסיפו אותו לעיצוב הפורטל. לחלופין, אם הוא חלק ממודול של Drupal, מוסיפים אותו למודול.
• אפשר גם להשתמש בפונקציה drupal_add_js של Drupal כדי להוסיף JavaScript ב-Drupal. מידע נוסף זמין בכתובת https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_add_js/7.

בדיקה של קישורים מנותקים

מומלץ לבדוק שאין בתוכן קישורים מנותקים. כברירת מחדל, הפורטל למפתחים מוגדר לבדיקה של קישורים מנותקים בסוגים שונים של דפים. לדוגמה, הקישורים נבדקים בדפים בסיסיים, במאמרים, ברשומות בלוגים ובנושאים בפורומים.

כדי להוסיף סוגי דפים לבדיקת הקישור או להסיר אותם ממנה:

1. בתפריט הניהול של Drupal, בוחרים באפשרות Modules ומוודאים שהמודול Link Checker מופעל.
2. בתפריט הניהול של Drupal, בוחרים באפשרות הגדרה > כתיבת תוכן > בודק הקישורים.
3. הגדרת סוגי התוכן שרוצים לסרוק כדי לאתר קישורים מנותקים.

הגדרת החיפוש

בפורטל למפתחים יש מנוע חיפוש מובנה שהוטמע על ידי Apache Solr, ומשתמש בספריית החיפוש של Apache Lucene. זהו מנוע החיפוש של האתר עצמו, שאליו המשתמש נכנס דרך תיבת החיפוש בפינה השמאלית העליונה של כל דפי הפורטל.

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

הגדרת Apache Solr

אפשר להגדיר ל-Apache Solr שליטה בסוגי התוכן להוספה לאינדקס, לאילוץ הוספה לאינדקס ולביצוע משימות הגדרה נוספות.

כדי להגדיר את Apache Solr:

1. אתם יכולים להתחבר לפורטל שלכם כמשתמשים עם הרשאות אדמין או יצירת תוכן.
2. בתפריט הניהול של Drupal, בוחרים באפשרות Configuration > Search and metadata > Apache Solr search.
3. בדף הזה מגדירים את Apache Solr.

השבתת ההוספה לאינדקס של Google

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

כדי להשבית את ההוספה לאינדקס של Google:

1. אתם יכולים להתחבר לפורטל שלכם כמשתמשים עם הרשאות אדמין או יצירת תוכן.
2. בוחרים באפשרות מודולים בתפריט הניהול של Drupal.
3. מפעילים את המודול Metatags.
4. לוחצים על שמירת הגדרות אישיות.
5. בתפריט הניהול של Drupal, בוחרים באפשרות Configuration > Search and metadata > Metatag (הגדרה > חיפוש ומטא-נתונים).
6. בוחרים בפעולה שינוי עבור סוג גלובלי.
7. לוחצים על הקטע מתקדם כדי לפתוח אותו.

   

8. סמן את תיבת הסימון מנע ממנועי החיפוש להוסיף דף זה לאינדקס.
9. לוחצים על שמירה.

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

מסמכים איך לרשום אפליקציות

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

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

כדי לרשום אפליקציה דרך פורטל המפתחים שמוגדר כברירת מחדל:

1. בתפריט ההתחברות, בוחרים באפשרות האפליקציות שלי מתחת לשם המשתמש.
2. לוחצים על סמל ההוספה (+) של אפליקציה חדשה.

   

3. מזינים את הערכים המתאימים בדף 'הוספת האפליקציה':

   שם האפליקציה	יש לציין שם אפליקציה ייחודי לאפליקציה.
   כתובת URL לקריאה חוזרת (callback)	במקרה הצורך, מציינים את כתובת ה-URL לקריאה חוזרת (callback) שאליה רוצים להחזיר את קריאת ה-OAuth. כברירת מחדל, הערך הזה נדרש גם אם ממשקי ה-API שלכם לא משתמשים ב-OAuth. אם ממשקי ה-API שלך לא משתמשים ב-OAuth, יש להזין ערך דמה כמו my.site.com.
   מוצר	בוחרים מוצר API אחד או יותר.

4. לוחצים על יצירת אפליקציה כדי לרשום את האפליקציה וליצור את מפתח ה-API לאפליקציה.