نوشتن راهنمای برنامه

هدف

به برنامهٔ خود راهنمای خودش را بدهید. این سایت راهنما پلتفرم را توضیح می‌دهد: یک نما چگونه کار می‌کند و یک فرم چگونه ذخیره می‌شود. اما نمی‌تواند برنامهٔ شما را توضیح دهد، مثلاً اینکه باشگاه شما یک رزرو را چگونه ثبت می‌کند. راهنمای برنامه یک سند کوتاه مارک‌داون است که در راه‌حل می‌نویسید. همراه برنامه وارد می‌شود، در منوی راهنمای برنامه فهرست می‌شود و یک دکمه روی یک صفحه می‌تواند آن را باز کند.

پیش‌نیازها

• با نقش سازنده وارد شده‌اید و یک راه‌حل و یک محیط برگزیده‌اید.
• برنامه‌ای که راهنما برای آن است در محیط هست. می‌تواند برنامهٔ مدل‌محور باشد یا برنامهٔ 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)	پیوند به راهنمایی دیگر
	تصویری از وب

جدول، نقل‌قول و بلوک کد هم کار می‌کنند.

HTML به صورت متن نشان داده می‌شود. یک راهنما هرگز اسکریپت اجرا نمی‌کند، و پیوند فقط وقتی باز می‌شود که با http، https، mailto یا guide: آغاز شود.

زبان‌های دیگر

انگلیسی الزامی است. هر زبان دیگری که پلتفرم دارد زبانه‌ای کنار آن دارد و همه اختیاری‌اند. زبانی که چیزی در آن نوشته نشده پس از نامش یک نقطه دارد. خوانندگان آن زبان راهنمای انگلیسی را می‌بینند، با یادداشتی که می‌گوید ترجمه نشده است. می‌توانید به یک ترجمه عنوان خودش را بدهید یا عنوان را خالی بگذارید تا عنوان انگلیسی به کار رود.

باز کردن راهنما از یک صفحه یا یک فرمان

• صفحهٔ ترسیم‌شدهٔ Studio. به یک دکمه این رویداد کلیک را بدهید:

  openGuide("psl_guide_bookings");

  راهنما در پانلی کنار صفحه باز می‌شود تا خواننده هم آن را دنبال کند و هم کارش را ادامه دهد.

• فرم یا نما. یک فرمان بیفزایید. در با فشردن، باز کردن یک راهنما را برگزینید و راهنما را انتخاب کنید.

• راهنمایی دیگر. به آن پیوند دهید: [how to cancel](guide:psl_guide_cancel).

اگر صفحه‌ای نام راهنمایی را بیاورد که وجود ندارد، چیزی باز نمی‌شود. فهرست مشکلات صفحه و پیام فرمان، هر دو نام راهنمایی را که جست‌وجو شد می‌گویند.

همراه راه‌حل جابه‌جا می‌شود

راهنما یکی از اجزای راه‌حل است، همانند یک جدول یا یک اسکریپت. صدور راه‌حل، راهنما را با همهٔ زبان‌هایش صادر می‌کند. وارد کردن آن راهنما را در منوی راهنمای محیط مقصد قرار می‌دهد، و حذف نصب راه‌حل آن را برمی‌دارد.

نتیجهٔ مورد انتظار

در Shell، باز کردن برنامه راهنمای نوار بالا را به یک منو تبدیل می‌کند. راهنماهای برنامه نخست می‌آیند و پس از آن‌ها راهنمای خود پلتفرم. برگزیدن یک راهنما آن را کنار صفحه باز می‌کند.