يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات
Apigee X. المعلومات
استخدِم نوع محتوى "الصفحة الأساسية" على Drupal لإضافة مستندات حول واجهة برمجة التطبيقات، مثل الأدلّة الإرشادية والمستندات المرجعية لواجهة برمجة التطبيقات، إلى بوابة "خدمات المطوِّرين"، وتضمين محتوى مثل الفيديوهات أو التسجيلات الرقمية للشاشة أو عمليات تنزيل الرموز.
تم إعداد صفحة "المستندات" مع بعض الإدخالات الأولية المنظّمة في فئات مختلفة، مثل "بدء الاستخدام" و"البرامج التعليمية". تعتبر الصفحة نقطة بداية يمكنك تعديلها. بهذه الطريقة، يمكنك إضافة إدخالات المحتوى الخاصة بك وتنظيم هذه الإدخالات بالطريقة التي تريدها.
إضافة الصفحة الرئيسية "للمستندات"
تتوفّر صفحة "المستندات" الرئيسية تلقائيًا على الرابط <siteURL>/documentation في بوابة المطوّرين لديك. تحتوي الصفحة الرئيسية التلقائية لبوابة المطوّرين على رابط يؤدي إلى هذه الصفحة في المربّع أعلى الصفحة الرئيسية:
يمكنك أيضًا إضافة رابط "المستندات" إلى هذه الصفحة في القائمة الرئيسية لقائمة بوابة المطوّرين.
يُرجى العلم أنّ الصفحة الرئيسية "للمستندات" غير متوفّرة تلقائيًا، لذا عليك إنشاء صفحة جديدة على بوابة المطوّرين على عنوان URL الصحيح.
لإضافة الصفحة الرئيسية "المستندات" إلى بوابة المطوِّر:
- سجّل الدخول إلى المنصة كمستخدم لديه امتيازات المشرف أو امتيازات إنشاء المحتوى.
- اختَر المحتوى > إضافة محتوى > الصفحة الأساسية في قائمة إدارة Drupal.
- أدخِل عنوان المستند، مثل الصفحة الرئيسية للمستندات، ومحتوى الصفحة الأولى.
- انقر على تعديل الملخّص لإضافة ملخّص.
- النقر على عنصر إعدادات القائمة أسفل قسم النص الأساسي
- انقر على تقديم رابط قائمة وأضِف عنوان الرابط ثم انقر على
<Main menu> في العنصر الرئيسي.
يؤدي هذا الإجراء إلى إضافة رابط إلى القائمة الرئيسية للصفحة الرئيسية للمستندات. - انقر على عنصر إعدادات مسار عنوان URL أسفل قسم "النص".
- ألغِ اختيار إنشاء عنوان URL بديل تلقائي واضبط الاسم المستعار لعنوان URL على
المستندات.
يكون عنوان URL للصفحة تلقائيًا هو <siteURL>/content/pageName. من خلال ضبط الاسم المستعار لعنوان URL، يتم ضبط عنوان URL صريح للصفحة، في هذه الحالة على <siteURL>/documentation. - احفظ الصفحة.
من المفترض أن يظهر الآن رابط يؤدي إلى الصفحة في شريط القوائم، ومن المفترض أن يعمل الرابط في المربّع على الصفحة الرئيسية بشكل صحيح.
بصفتك مشرفًا، ستظهر لك أيضًا أزرار إدارة المحتوى، مثل "عرض" و"تعديل". ولن تظهر لغير المشرفين.
إضافة صفحة فرعية إلى مستنداتك
أثناء إضافة صفحات فرعية إلى مستنداتك:
- سجّل الدخول إلى المنصة كمستخدم لديه امتيازات المشرف أو امتيازات إنشاء المحتوى.
- اختَر المحتوى > إضافة محتوى > الصفحة الأساسية في قائمة إدارة Drupal.
- أدخِل عنوان الصفحة والمحتوى.
- انقر على تعديل الملخّص لإضافة ملخّص.
- النقر على عنصر إعدادات القائمة أسفل قسم النص الأساسي
- انقر على تقديم رابط لقائمة الطعام، ثم أضِف عنصر قائمة الصفحة الرئيسية
إلى المستندات.
يؤدي هذا الإجراء إلى إضافة صفحة حالية كفرع من القائمة الرئيسية للصفحة الرئيسية في المستندات. - من المفترض أن يظهر لك الآن رابط إلى الصفحة في قائمة الصفحة الرئيسية للوثائق.
تعديل صفحة مستندات
لتعديل صفحة:
- سجّل الدخول إلى المنصة كمستخدم لديه امتيازات المشرف أو امتيازات إنشاء المحتوى.
- انتقِل إلى الصفحة في بوابة المطوّرين.
يمكنك أيضًا النقر على المحتوى في قائمة إدارة Drupal لعرض جميع صفحاتك واختيار صفحة منها. - اختر علامة التبويب تعديل في الصفحة.
- افتح محرّرًا مرئيًا من خلال اختيار HTML الكامل أو HTML المفلتر في القائمة المنسدلة تنسيق النص
أسفل قسم النص الأساسي.
من المفترض أن يظهر محتوى الصفحة في المحرِّر. - عدِّل الصفحة حسب الضرورة.
- انقر على حفظ.
عرض أي صفحة مستندات
لعرض محتوى مستند:
- سجّل الدخول إلى المنصة كمستخدم لديه امتيازات المشرف أو امتيازات إنشاء المحتوى.
- اختَر المحتوى في قائمة إدارة Drupal.
- اختَر المستند الذي تريد عرضه.
إعادة ترتيب الصفحات
يمكنك تغيير مستوى التسلسل والتداخل للصفحات في قائمة الصفحة الرئيسية للمستندات.
لإعادة ترتيب الصفحات في قائمة "المستندات" الرئيسية:
- سجّل الدخول إلى المنصة كمستخدم لديه امتيازات المشرف أو امتيازات إنشاء المحتوى.
- في قائمة إدارة Drupal، اختَر التركيبة > القوائم > القائمة الرئيسية.
- يكون لكل عنصر في القائمة رمز على يمين اسمه. في حال عدم ظهور الرموز، انقر على إخفاء ترجيحات الصفوف.
- لنقل عنصر، انقر على الرمز واسحبه لنقله إلى مكان جديد.
يؤدي سحب عنصر يحتوي على عناصر ثانوية إلى نقل الأطفال أيضًا.
- انقر على حفظ الضبط.
تعديل صفحات التذييل
يحتوي تذييل البوابة على ثلاثة رموز اجتماعية خاصة بـ Twitter وFacebook وLinkedIn، بالإضافة إلى روابط تتضمّن عناوين URL التالية:
- سياسة خصوصية عنوان URL التالي: <siteURL>/privacy-policy
- البنود والاستخدام في عنوان URL <siteURL>/terms-use
- التواصل مع الصفحات بعنوان URL <siteURL>/contact-us
عليك تعديل هذه الصفحات لإضافة المحتوى الخاص بك.
إذا لم تكن هذه الصفحات متوفّرة، يمكنك إنشاؤها:
- سجّل الدخول إلى المنصة كمستخدم لديه امتيازات المشرف أو امتيازات إنشاء المحتوى.
- اختَر المحتوى > إضافة محتوى > الصفحة الأساسية في قائمة إدارة Drupal.
- أدخِل عنوان المستند، مثلاً سياسة الخصوصية ومحتوى الصفحة.
- انقر على تعديل الملخّص لإضافة ملخّص.
- انقر على عنصر إعدادات مسار عنوان URL أسفل قسم "النص".
- اختَر إنشاء عنوان URL بديل تلقائي واضبط العنوان البديل لعنوان URL على سياسة الخصوصية.
يكون عنوان URL للصفحة تلقائيًا هو <siteURL>/content/pageName. من خلال ضبط العنوان البديل لعنوان URL، يتم ضبط عنوان URL فاضح للصفحة في هذه الحالة على <siteURL>/privacy-policy. - احفظ الصفحة.
- كرر هذه العملية لـ "البنود والاستخدام" وصفحة الاتصال.
لتعديل محتوى صفحة التذييل، مثل سياسة الخصوصية أو بنود الاستخدام أو صفحة "التواصل معنا" في بوابة المطوّرين:
- سجّل الدخول إلى المنصة كمستخدم لديه امتيازات المشرف أو امتيازات إنشاء المحتوى.
- انتقل إلى الصفحة من خلال النقر على الرابط الخاص بها في التذييل. على سبيل المثال، انقر على الرابط سياسة الخصوصية.
- انقر على علامة التبويب تعديل في الصفحة لفتح المحرِّر.
- غيِّر محتوى صفحة "سياسة الخصوصية" بالشكل المناسب.
- انقر على حفظ.
- كرر هذه العملية لـ "البنود والاستخدام" وصفحة الاتصال.
لتعديل رموز وسائل التواصل الاجتماعي، مثل رموز Twitter وFacebook وLinkedIn في بوابة المطوّرين الخاصة بك:
- سجّل الدخول إلى المنصة كمستخدم لديه امتيازات المشرف أو امتيازات إنشاء المحتوى.
- اختر التركيبة > القوالب في قائمة إدارة Drupal.
- انتقِل للأسفل في صفحة "الحظر" إلى أن يظهر لك حظر التذييل التلقائي على مستوى الموقع الإلكتروني.
- اختَر الرابط configure الرابط الخاص بقالب التذييل التلقائي على مستوى الموقع الإلكتروني.
- في منطقة المحتوى المخصص، انقر بزر الماوس الأيمن على أحد رموز الشبكات الاجتماعية واختَر تعديل الرابط من القائمة المنبثقة. أو احذف الرمز من منطقة المحتوى المخصّص لإزالته.
- اختَر حفظ المجموعة لحفظ التغييرات.
إضافة JavaScript إلى صفحة بوابة
يمكنك إضافة JavaScript إلى أي صفحة بوابة. أسهل طريقة لإضافة JavaScript هي تعديل الصفحة، وبعد ذلك:
- اختَر HTML كامل باعتباره تنسيق النص.
- حدّد الزر المصدر لتعديل رمز مصدر HTML للصفحة.
- أضِف JavaScript إلى الصفحة. على سبيل المثال، لكي يظهر مربّع تنبيه في نافذة منبثقة عند تحميل الصفحة،
أضِف الرمز التالي:
<script language="JavaScript">
alert('Welcome to my page!');
</script>
بعض الاعتبارات المتعلقة باستخدام JavaScript:
- إذا كنت تريد الإشارة إلى ملف JavaScript، لا تستخدِم الرمز المصدر لعقدة معيّنة، لأنّ ذلك يؤدي إلى إنشاء رابط ثابت. وبدلاً من ذلك، استخدِم رمز PHP حتى تتمكّن من إنشاء رابط ديناميكي. بهذه الطريقة، إذا تغيّر موقع ملف JavaScript، لن تحتاج إلى تعديل جميع صفحات البوابة التي تشير إليه.
- إذا أردت تضمين ملف JavaScript، أضِفه إلى مظهر البوابة. أو إذا كان جزءًا من وحدة Drupal، يمكنك إضافتها إلى الوحدة.
- يمكنك أيضًا استخدام دالة Drupal drupal_add_js لإضافة JavaScript في Drupal. لمزيد من المعلومات، يُرجى الاطّلاع على https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_add_js/7.
البحث عن روابط معطّلة
من الممارسات الجيدة مراجعة المحتوى بحثًا عن روابط معطّلة. يتم تلقائيًا إعداد بوابة المطوّرين للتحقّق من أنواع مختلفة من الصفحات بحثًا عن الروابط المعطّلة. على سبيل المثال، يتم التحقق من الروابط في الصفحات الأساسية والمقالات وإدخالات المدونات ومواضيع المنتديات.
لإضافة أنواع الصفحات أو إزالتها من عملية التحقق من الرابط:
- في قائمة إدارة Drupal، اختَر الوحدات وتأكَّد من تفعيل وحدة أداة التحقّق من الروابط.
- في قائمة إدارة Drupal، اختَر الضبط > إنشاء المحتوى > أداة التحقق من الروابط.
- اضبط أنواع المحتوى الذي تريد فحصه بحثًا عن الروابط المعطّلة.
تهيئة البحث
توفر بوابة المطوّرين محرك بحث مدمج يتم تنفيذه من خلال Apache Solr، والذي يستخدم مكتبة بحث Apache Lucene. هذا هو محرّك البحث الخاص بالموقع الإلكتروني نفسه، والذي يصل إليه المستخدم من خلال مربّع البحث في أعلى يسار جميع صفحات البوابة.
ويمكن لمحركات البحث الخارجية، مثل Google، أيضًا فهرسة البوابة. تتيح لك بوابة المطوّرين التحكم في ما إذا كان بإمكان محركات البحث الخارجية فهرسة البوابة أم لا.
تكوين Apache Solr
يمكنك إعداد Apache Solr للتحكّم في أنواع المحتوى الذي تريد فهرسته، وفرض فهرس، وتنفيذ مهام ضبط إضافية.
لضبط Apache Solr:
- سجّل الدخول إلى المنصة كمستخدم لديه امتيازات المشرف أو امتيازات إنشاء المحتوى.
- في قائمة إدارة Drupal، اختَر الضبط > البحث والبيانات الوصفية > بحث Apache Solr.
- استخدم هذه الصفحة لإعداد Apache Solr.
إيقاف فهرسة Google
وتُعدّ فهرسة المحتوى وإتاحته لمحرّكات البحث ممارسة جيدة أيضًا. تتم فهرسة المحتوى الخاص بك من خلال أداة فهرسة Google تلقائيًا. ومع ذلك، يمكنك إيقاف فهرسة Google. ننصحك بإجراء ذلك إذا لم تكن بوابة مطوّري البرامج جاهزة للاستخدام العام، وبالتالي لا تريد أن يكون المحتوى الخاص بك متاحًا للبحث بشكل علني.
لإيقاف فهرسة Google:
- سجّل الدخول إلى المنصة كمستخدم لديه امتيازات المشرف أو امتيازات إنشاء المحتوى.
- اختر الوحدات في قائمة إدارة Drupal.
- فعِّل وحدة العلامات الوصفية.
- انقر على حفظ الضبط.
- في قائمة إدارة Drupal، اختَر الضبط > البحث والبيانات الوصفية > العلامة الوصفية.
- اختَر عملية إلغاء للنوع العام.
- انقر على قسم الإعدادات المتقدّمة لفتحه.
- ضَع علامة في مربّع الاختيار "منع محركات البحث من فهرسة هذه الصفحة".
- انقر على حفظ.
لاحِظ أنّ هناك خيارات أخرى ذات صلة بمحرّكات البحث في القسم "إعدادات متقدّمة" من الصفحة الشاملة. على سبيل المثال، يمكنك وضع علامة في مربّع اختيار لمنع محرّكات البحث من تتبّع الروابط على صفحة ما. ضع علامة في مربّع واحد أو أكثر من مربّعات الاختيار هذه حسب الحاجة.
توثيق طريقة تسجيل التطبيقات
ومن المهم أن تتضمّن مستنداتك تعليمات حول كيفية تسجيل المطوّرين لتطبيقاتهم من خلال بوابة المطوّرين الخاصة بك. يمكنك الاستعانة بالإرشادات التالية كنقطة بداية، فهي تتناول كيفية تسجيل التطبيقات من خلال بوابة المطوّرين التلقائية.
لضبط كيفية تسجيل المطوّرين للتطبيقات على البوابة، يُرجى الاطّلاع على ضبط تسجيل التطبيقات لمزيد من المعلومات. وإذا عدَّلت عملية تسجيل التطبيق، عليك تعديل المثال على التعليمات الواردة أدناه وفقًا لذلك.
لتسجيل تطبيق من خلال بوابة المطوّرين التلقائية:
- اختَر تطبيقاتي أسفل اسم المستخدم في قائمة تسجيل الدخول.
- انقر على رمز التطبيق الجديد إضافة (+).
- أدخِل القيم المناسبة في صفحة "إضافة تطبيق":
اسم التطبيق يجب إدخال اسم تطبيق فريد لتطبيقك. عنوان URL لمعاودة الاتصال إذا لزم الأمر، أدخِل عنوان URL لمعاودة الاتصال الذي من المفترض أن يظهر إليه مكالمة OAuth.
وتكون هذه القيمة مطلوبة تلقائيًا حتى إذا كانت واجهات برمجة التطبيقات لا تستخدم OAuth. إذا كانت واجهات برمجة التطبيقات لديك لا تستخدم OAuth، أدخِل قيمة وهمية، مثل my.site.com.
المنتج اختَر منتجًا واحدًا أو أكثر من منتجات واجهة برمجة التطبيقات. - انقر على إنشاء التطبيق لتسجيل التطبيق وإنشاء مفتاح واجهة برمجة التطبيقات للتطبيق.