إنتقل إلى المحتوى الرئيسي

كتابة دليل للتطبيق

الهدف​

امنح تطبيقك مساعدته الخاصة. يشرح موقع المساعدة هذا المنصة: كيف تعمل طريقة العرض وكيف يُحفظ النموذج. لكنه لا يستطيع شرح تطبيقك، مثل الطريقة التي يسجّل بها ناديك حجزًا. دليل التطبيق مستند قصير بلغة ماركداون تكتبه داخل الحل. يُستورد مع التطبيق، ويُدرج في قائمة المساعدة الخاصة بالتطبيق، ويمكن لزر في شاشة أن يفتحه.

المتطلبات المسبقة​

  • أنت مسجّل الدخول بصفتك صانع تطبيقات، وقد اخترت حلًا وبيئة.
  • التطبيق الذي يُكتب له الدليل موجود في البيئة. قد يكون تطبيقًا قائمًا على النموذج أو تطبيق Studio.

الخطوات​

  1. افتح الحل واختر أدلة التطبيق.
  2. اختر جديد. يفتح المصمم ومعه مثال قصير.
  3. اكتب العنوان، مثل تسجيل حجز. يُملأ الاسم تلقائيًا أثناء الكتابة. تفتح الشاشات والأوامر الدليل بهذا الاسم، لذا لا يمكن تغييره بعد الحفظ.
  4. في التطبيق، اختر التطبيق الذي يجب أن تُدرج قائمة المساعدة فيه هذا الدليل. اتركه فارغًا لدليل لا يُفتح إلا باسمه.
  5. يحدد الترتيب مكان الدليل في تلك القائمة. الأرقام الأصغر تأتي أولًا.
  6. اكتب الدليل في المحرر. المعاينة بجانبه هي بالضبط ما سيراه القارئ.
  7. اختر حفظ.

الكتابة بلغة ماركداون​

تكتبيرى القارئ
## Sectionعنوانًا
**bold**، *italic*غامق، مائل
1. Stepقائمة مرقّمة
- Itemقائمة نقطية
`code`code
[text](https://example.com)رابطًا يُفتح في علامة تبويب جديدة
[text](guide:psl_guide_bookings)رابطًا إلى دليل آخر
![picture](https://example.com/court.png)صورة من الويب

الجداول والاقتباسات وكتل الشيفرة تعمل أيضًا.

تُعرض HTML كنص. لا يمكن للدليل أبدًا تشغيل نص برمجي، ولا يُفتح الرابط إلا إذا بدأ بـ http أو https أو mailto أو guide:.

اللغات الأخرى​

الإنجليزية مطلوبة. لكل لغة أخرى تدعمها المنصة علامة تبويب بجانبها، وكلها اختيارية. اللغة التي لم يُكتب فيها شيء تظهر بعد اسمها نقطة. يرى قرّاء تلك اللغة الدليل الإنجليزي مع ملاحظة تقول إنه لم يُترجم. يمكنك منح الترجمة عنوانها الخاص، أو ترك العنوان فارغًا لاستخدام العنوان الإنجليزي.

فتح دليل من شاشة أو من أمر​

  • شاشة Studio مرسومة. أعطِ زرًا معالج النقر هذا:

    openGuide("psl_guide_bookings");

    يُفتح الدليل في لوحة بجانب الشاشة، فيتّبعه القارئ ويواصل عمله.

  • نموذج أو طريقة عرض. أضف أمرًا. في عند الضغط، اختر فتح دليل ثم اختر الدليل.

  • دليل آخر. اربط به: [how to cancel](guide:psl_guide_cancel).

إذا ذكرت شاشة دليلًا غير موجود، فلن يُفتح شيء. وتذكر قائمة مشكلات الشاشة ورسالة الأمر كلتاهما اسم الدليل الذي بُحث عنه.

ينتقل مع الحل​

الدليل مكوّن من مكونات الحل، مثل الجدول أو النص البرمجي. يصدّر تصدير الحل الدليل بكل لغاته. ويضع استيراده الدليل في قائمة المساعدة في البيئة الهدف، وتزيله إزالة تثبيت الحل.

النتيجة المتوقعة​

في Shell، يحوّل فتح التطبيق زر المساعدة في الشريط العلوي إلى قائمة. تأتي أدلة التطبيق أولًا، تليها مساعدة المنصة نفسها. يفتح اختيار دليل ذلك الدليل بجانب الصفحة.